corn-config / corn Goto Github PK

Hi again @JakeStanger,

I couldn't find any mentions for a plan to adopt/not-to-adopt an advanced type system. Have you considered eventually to implement types? Seems like this could be a great feature and I bet you've already thought about this ;) This could be particularly useful for things like kubernetes-helm customizations, OpenAPI specs, bigger system-level configurations.

Would be great if you could share your plans or thoughts about a more advanced type system somewhere in the docs.

Thanks again for the cornlang, fantastic work!

The error code is a little messy at the moment, and the library makes heavy use of unwrap. Error code should be refactored and the parser/deserializer should not panic anywhere.

Having an official 'playground' web tool capable of converting Corn into the standard 3 outputs could be very useful, and helps advertise it a bit.

Ideally it should support syntax highlighting for all the languages involved. I'm not sure on the logistics of that or the best tools to use yet.

Write plugin for VSCode to syntax highlight

Syntax support for multi-line strings should be added.

Something like:

foo = """
multi
line
string
"""

Support for input interpolation inside strings has made it impossible in some cases to include a $ in a string that does not belong to an input.

Write plugin for IntelliJ for syntax highlighting

The #[serde(untagged)] attribute causes the TOML serializer to fail, but is required to produce valid JSON/YAML. TOML also does not support any kind of null value so serde fails to serialize None values. At the moment this means TOML is not supported.

These are quite common but not currently supported by Corn. Syntax for quoting keys in 'single quotes' should be added to allow this.

Example:

'foo.bar' = "baz" // does *not* expand to `foo = { bar  = "baz" }`

Currently object merging only takes the immediate children into account.

There may be utility in changing this, or adding additional syntax, to perform a 'deep merge', running the merge against every child object.

Issue originates from the below discussion, which compares the feature to Nix's 'attrset merge':

Discussed in https://github.com/orgs/corn-config/discussions/29

let {
  $preferences_user_enable = {
    Value = true
    Status = "user"
  }

  // telemetry
  $policies_disable_telemetry = {
    DisableTelemetry = true
    DisableFirefoxStudies = true
  }
  // #TODO 'raw data' need git version corn
  // theme
  $policies_theme = {
    Preferences = {
      'toolkit.legacyUserProfileCustomizations.stylesheets' = $preferences_user_enable
      'layout.css.backdrop-filter.enabled' = $preferences_user_enable
      'widget.non-native-theme.use-theme-accent' = $preferences_user_enable
    }
  }

  $policies_ech = {
    // ech need enable DNS over HTTPS
    DNSOverHTTPS = {
      Enabled =  true
      ProviderURL = "https://1.1.1.1/dns-query"
      Locked = false
      ExcludedDomains = [""]
    }
    Preferences = {
      'network.dns.echconfig.enabled' = $preferences_user_enable
      'network.dns.http3_echconfig.enabled' = $preferences_user_enable
    }
  }
} in
{
  policies = {
    // telemetry
    ..$policies_disable_telemetry
    // ech
    ..$policies_ech
    // theme
    ..$policies_theme
  }
}

{
  "policies": {
    "DisableTelemetry": true,
    "DisableFirefoxStudies": true,
    "DNSOverHTTPS": {
      "Enabled": true,
      "ProviderURL": "https://1.1.1.1/dns-query",
      "Locked": false,
      "ExcludedDomains": [
        ""
      ]
    },
    "Preferences": {
      "toolkit.legacyUserProfileCustomizations.stylesheets": {
        "Value": true,
        "Status": "user"
      },
      "layout.css.backdrop-filter.enabled": {
        "Value": true,
        "Status": "user"
      },
      "widget.non-native-theme.use-theme-accent": {
        "Value": true,
        "Status": "user"
      }
    }
  }
}

Currently cornfig::parse returns the a tree of parsed values which isn't super useful for library use. A serde::Deserializer implementation should be written to attempt to deserialize into structs.

It's possible to serialize the Corn output using serde then deserialize it again, but this comes with a lot of overhead and requires shipping another format library.

Lots of things need more than alphanumeric strings in keys. Hyphens would be especially useful. Full unicode should maybe be allowed if keys are quoted.

This is currently limiting Corn's use in ironbar.

There should be an LSP uh, thing, to provide full support to VSCode, Vim and all the rest.

Moving to workspace with readme in top level now means crates don't have readme info.