refactor: migrate to jsonc config (#239)

* chore: add our own text-size

* fix: test

* chore: cleanup feature gates

* chore: cleanup remaining feature gates

* refactor: migrate to json config

* fix: lint

* feat: add schema field

* migrate to jsonc config

* fix: run docs codegen

* Update configuration.rs

Co-authored-by: Julian Domke <68325451+juleswritescode@users.noreply.github.com>

* add unit tests

* fix: replace_secion

---------

Co-authored-by: Julian Domke <68325451+juleswritescode@users.noreply.github.com>

Author: psteinroe

Cargo.lock

@@ -45,7 +45,7 @@ impl AnalyserRules {
 /// A set of information useful to the analyser infrastructure
 #[derive(Debug, Default)]
 pub struct AnalyserOptions {
-    /// A data structured derived from the [`pglt.toml`] file
+    /// A data structured derived from the [`pglt.jsonc`] file
     pub rules: AnalyserRules,
 }
 

crates/pglt_analyse/src/options.rs

@@ -12,7 +12,11 @@ use std::fmt::Debug;
 use crate::{categories::RuleCategory, context::RuleContext, registry::RegistryVisitor};
 
 #[derive(Clone, Debug)]
-#[cfg_attr(feature = "serde", derive(serde::Serialize))]
+#[cfg_attr(
+    feature = "serde",
+    derive(serde::Serialize),
+    serde(rename_all = "camelCase")
+)]
 /// Static metadata containing information about a rule
 pub struct RuleMetadata {
     /// It marks if a rule is deprecated, and if so a reason has to be provided.

crates/pglt_analyse/src/rule.rs

@@ -79,15 +79,24 @@ Let's assume that the rule we implement support the following options:
 - `threshold`: an integer between 0 and 255;
 - `behaviorExceptions`: an array of strings.
 
-We would like to set the options in the `pglt.toml` configuration file:
-
-```toml
-[linter.rules.safety.myRule]
-level = "warn"
-options = {
-    behavior = "A"
-    threshold = 20
-    behaviorExceptions = ["one", "two"]
+We would like to set the options in the `pglt.jsonc` configuration file:
+
+```json
+{
+  "linter": {
+    "rules": {
+      "safety": {
+        "myRule": {
+          "level": "warn",
+          "options": {
+            "behavior": "A",
+            "threshold": 20,
+            "behaviorExceptions": ["one", "two"]
+          }
+        }
+      }
+    }
+  }
 }
 ```
 
@@ -132,16 +141,16 @@ We currently require implementing _serde_'s traits `Deserialize`/`Serialize`.
 
 Also, we use other `serde` macros to adjust the JSON configuration:
 
-- `rename_all = "snake_case"`: it renames all fields in camel-case, so they are in line with the naming style of the `pglt.toml`.
+- `rename_all = "camelCase"`: it renames all fields in camel-case, so they are in line with the naming style of the `pglt.jsonc`.
 - `deny_unknown_fields`: it raises an error if the configuration contains extraneous fields.
-- `default`: it uses the `Default` value when the field is missing from `pglt.toml`. This macro makes the field optional.
+- `default`: it uses the `Default` value when the field is missing from `pglt.jsonc`. This macro makes the field optional.
 
 You can simply use a derive macros:
 
 ```rust
 #[derive(Debug, Default, Clone, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(JsonSchema))]
-#[serde(rename_all = "snake_case", deny_unknown_fields, default)]
+#[serde(rename_all = "camelCase", deny_unknown_fields, default)]
 pub struct MyRuleOptions {
     #[serde(default, skip_serializing_if = "is_default")]
     main_behavior: Behavior,

crates/pglt_analyser/CONTRIBUTING.md

@@ -26,7 +26,7 @@ pub struct CliOptions {
     #[bpaf(long("verbose"), switch, fallback(false))]
     pub verbose: bool,
 
-    /// Set the file path to the configuration file, or the directory path to find `pglt.toml`.
+    /// Set the file path to the configuration file, or the directory path to find `pglt.jsonc`.
     /// If used, it disables the default configuration file resolution.
     #[bpaf(long("config-path"), argument("PATH"), optional)]
     pub config_path: Option<String>,

crates/pglt_cli/src/cli_options.rs

@@ -6,8 +6,9 @@ use pglt_workspace::configuration::create_config;
 
 pub(crate) fn init(mut session: CliSession) -> Result<(), CliDiagnostic> {
     let fs = &mut session.app.fs;
-    create_config(fs, PartialConfiguration::init())?;
-    let file_created = ConfigName::pglt_toml();
+    let config = &mut PartialConfiguration::init();
+    create_config(fs, config)?;
+    let file_created = ConfigName::pglt_jsonc();
     session.app.console.log(markup! {
 "
 Welcome to the Postgres Language Tools! Let's get you started...

crates/pglt_cli/src/commands/init.rs

@@ -58,7 +58,7 @@ pub enum PgltCommand {
         changed: bool,
 
         /// Use this to specify the base branch to compare against when you're using the --changed
-        /// flag and the `defaultBranch` is not set in your `pglt.toml`
+        /// flag and the `defaultBranch` is not set in your `pglt.jsonc`
         #[bpaf(long("since"), argument("REF"))]
         since: Option<String>,
 
@@ -91,7 +91,7 @@ pub enum PgltCommand {
         )]
         log_path: PathBuf,
         /// Allows to set a custom file path to the configuration file,
-        /// or a custom directory path to find `pglt.toml`
+        /// or a custom directory path to find `pglt.jsonc`
         #[bpaf(env("PGLT_LOG_PREFIX_NAME"), long("config-path"), argument("PATH"))]
         config_path: Option<PathBuf>,
     },
@@ -127,7 +127,7 @@ pub enum PgltCommand {
         )]
         log_path: PathBuf,
         /// Allows to set a custom file path to the configuration file,
-        /// or a custom directory path to find `pglt.toml`
+        /// or a custom directory path to find `pglt.jsonc`
         #[bpaf(env("PGLT_CONFIG_PATH"), long("config-path"), argument("PATH"))]
         config_path: Option<PathBuf>,
         /// Bogus argument to make the command work with vscode-languageclient
@@ -164,7 +164,7 @@ pub enum PgltCommand {
         #[bpaf(long("stop-on-disconnect"), hide_usage)]
         stop_on_disconnect: bool,
         /// Allows to set a custom file path to the configuration file,
-        /// or a custom directory path to find `pglt.toml`
+        /// or a custom directory path to find `pglt.jsonc`
         #[bpaf(env("PGLT_CONFIG_PATH"), long("config-path"), argument("PATH"))]
         config_path: Option<PathBuf>,
     },

crates/pglt_cli/src/commands/mod.rs

@@ -48,7 +48,7 @@ pub enum CliDiagnostic {
     IoError(IoDiagnostic),
     /// The daemon is not running
     ServerNotRunning(ServerNotRunning),
-    /// The end configuration (`pglt.toml` + other options) is incompatible with the command
+    /// The end configuration (`pglt.jsonc` + other options) is incompatible with the command
     IncompatibleEndConfiguration(IncompatibleEndConfiguration),
     /// No files processed during the file system traversal
     NoFilesWereProcessed(NoFilesWereProcessed),
@@ -410,7 +410,7 @@ impl CliDiagnostic {
         Self::ServerNotRunning(ServerNotRunning)
     }
 
-    /// Emitted when the end configuration (`pglt.toml` file + CLI arguments + LSP configuration)
+    /// Emitted when the end configuration (`pglt.jsonc` file + CLI arguments + LSP configuration)
     /// results in a combination of options that doesn't allow to run the command correctly.
     ///
     /// A reason needs to be provided

crates/pglt_cli/src/diagnostics.rs

@@ -25,7 +25,6 @@ rustc-hash               = { workspace = true }
 schemars                 = { workspace = true, features = ["indexmap1"], optional = true }
 serde                    = { workspace = true, features = ["derive"] }
 serde_json               = { workspace = true, features = ["raw_value"] }
-toml                     = { workspace = true }
 
 [lib]
 doctest = false

crates/pglt_configuration/Cargo.toml

@@ -6,7 +6,7 @@ use serde::{Deserialize, Serialize};
 #[derive(Clone, Debug, Deserialize, Eq, Partial, PartialEq, Serialize)]
 #[partial(derive(Bpaf, Clone, Eq, PartialEq, Merge))]
 #[partial(cfg_attr(feature = "schema", derive(schemars::JsonSchema)))]
-#[partial(serde(rename_all = "snake_case", default, deny_unknown_fields))]
+#[partial(serde(rename_all = "camelCase", default, deny_unknown_fields))]
 pub struct DatabaseConfiguration {
     /// The host of the database.
     #[partial(bpaf(long("host")))]