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 <[email protected]>

* add unit tests

* fix: replace_secion

---------

Co-authored-by: Julian Domke <[email protected]>

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")))]

crates/pglt_configuration/src/database.rs

@@ -24,9 +24,9 @@ pub enum ConfigurationDiagnostic {
 }
 
 impl ConfigurationDiagnostic {
-    pub fn new_deserialization_error(error: toml::de::Error) -> Self {
+    pub fn new_deserialization_error(error: serde_json::Error) -> Self {
         Self::DeserializationError(DeserializationError {
-            message: error.message().to_string(),
+            message: error.to_string(),
         })
     }
 

crates/pglt_configuration/src/diagnostics.rs

@@ -14,7 +14,7 @@ pub const DEFAULT_FILE_SIZE_LIMIT: NonZeroU64 =
 #[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 FilesConfiguration {
     /// The maximum allowed size for source code files in bytes. Files above
     /// this limit will be ignored for performance reasons. Defaults to 1 MiB

crates/pglt_configuration/src/files.rs

@@ -1,4 +1,4 @@
-//! This module contains the configuration of `pglt.toml`
+//! This module contains the configuration of `pglt.jsonc`
 //!
 //! The configuration is divided by "tool", and then it's possible to further customise it
 //! by language. The language might further options divided by tool.
@@ -43,8 +43,13 @@ pub const VERSION: &str = match option_env!("PGLT_VERSION") {
 #[derive(Clone, Debug, Default, Deserialize, Eq, Partial, PartialEq, Serialize)]
 #[partial(derive(Bpaf, Clone, Eq, PartialEq, Merge))]
 #[partial(cfg_attr(feature = "schema", derive(schemars::JsonSchema)))]
-#[partial(serde(deny_unknown_fields, rename_all = "snake_case"))]
+#[partial(serde(deny_unknown_fields, rename_all = "camelCase"))]
 pub struct Configuration {
+    /// A field for the [JSON schema](https://json-schema.org/) specification
+    #[partial(serde(rename = "$schema"))]
+    #[partial(bpaf(hide))]
+    pub schema: String,
+
     /// The configuration of the VCS integration
     #[partial(type, bpaf(external(partial_vcs_configuration), optional, hide_usage))]
     pub vcs: VcsConfiguration,
@@ -79,6 +84,10 @@ impl PartialConfiguration {
     /// Returns the initial configuration.
     pub fn init() -> Self {
         Self {
+            // TODO: Update this once we have a static url
+            schema: Some(format!(
+                "https://supabase-community.github.io/postgres_lsp/schemas/{VERSION}/schema.json"
+            )),
             files: Some(PartialFilesConfiguration {
                 ignore: Some(Default::default()),
                 ..Default::default()

crates/pglt_configuration/src/lib.rs

@@ -5,7 +5,7 @@ use serde::{Deserialize, Serialize};
 /// The configuration of the filesystem
 #[derive(Clone, Debug, Deserialize, Eq, Partial, PartialEq, Serialize, Default)]
 #[partial(derive(Bpaf, Clone, Eq, PartialEq, Merge))]
-#[partial(serde(rename_all = "snake_case", default, deny_unknown_fields))]
+#[partial(serde(rename_all = "camelCase", default, deny_unknown_fields))]
 #[partial(cfg_attr(feature = "schema", derive(schemars::JsonSchema)))]
 pub struct MigrationsConfiguration {
     /// The directory where the migration files are stored

crates/pglt_configuration/src/migrations.rs

@@ -11,7 +11,7 @@ const GIT_IGNORE_FILE_NAME: &str = ".gitignore";
 #[partial(derive(Bpaf, Clone, Deserializable, Eq, Merge, PartialEq))]
 #[partial(deserializable(with_validator))]
 #[partial(cfg_attr(feature = "schema", derive(schemars::JsonSchema)))]
-#[partial(serde(deny_unknown_fields))]
+#[partial(serde(deny_unknown_fields, rename_all = "camelCase"))]
 pub struct VcsConfiguration {
     /// Whether we should integrate itself with the VCS client
     #[partial(bpaf(long("vcs-enabled"), argument("true|false")))]
@@ -28,7 +28,7 @@ pub struct VcsConfiguration {
     pub use_ignore_file: bool,
 
     /// The folder where we should check for VCS files. By default, we will use the same
-    /// folder where `pglt.toml` was found.
+    /// folder where `pglt.jsonc` was found.
     ///
     /// If we can't find the configuration, it will attempt to use the current working directory.
     /// If no current working directory can't be found, we won't use the VCS integration, and a diagnostic
@@ -91,7 +91,7 @@ impl DeserializableValidator for PartialVcsConfiguration {
     Clone, Copy, Debug, Default, Deserialize, Deserializable, Eq, Merge, PartialEq, Serialize,
 )]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
-#[serde(rename_all = "snake_case")]
+#[serde(rename_all = "camelCase")]
 pub enum VcsClientKind {
     #[default]
     /// Integration with the git client as VCS

crates/pglt_configuration/src/vcs.rs

@@ -86,7 +86,7 @@ pub trait Visit {
 /// to the user.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
-#[serde(rename_all = "snake_case")]
+#[serde(rename_all = "camelCase")]
 pub enum LogCategory {
     /// The advice doesn't have any specific category, the message will be
     /// printed as plain markup.

crates/pglt_diagnostics/src/advice.rs

@@ -117,7 +117,7 @@ pub trait Diagnostic: Debug {
 #[derive(
     Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize, Default,
 )]
-#[serde(rename_all = "snake_case")]
+#[serde(rename_all = "camelCase")]
 /// The severity to associate to a diagnostic.
 pub enum Severity {
     /// Reports a hint.
@@ -164,7 +164,7 @@ impl Display for Severity {
 /// Internal enum used to automatically generate bit offsets for [DiagnosticTags]
 /// and help with the implementation of `serde` and `schemars` for tags.
 #[derive(Debug, Copy, Clone, Serialize, Deserialize)]
-#[serde(rename_all = "snake_case")]
+#[serde(rename_all = "camelCase")]
 #[bitflags]
 #[repr(u8)]
 pub(super) enum DiagnosticTag {

crates/pglt_diagnostics/src/diagnostic.rs

@@ -39,7 +39,7 @@ impl Eq for Location<'_> {}
 
 /// Represents the resource a diagnostic is associated with.
 #[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)]
-#[serde(rename_all = "snake_case")]
+#[serde(rename_all = "camelCase")]
 pub enum Resource<P> {
     /// The diagnostic is related to the content of the command line arguments.
     Argv,

crates/pglt_diagnostics/src/location.rs

@@ -15,7 +15,7 @@ use crate::{
 
 /// Serializable representation for a [Diagnostic](super::Diagnostic).
 #[derive(Clone, Debug, Serialize, Deserialize)]
-#[cfg_attr(not(target_arch = "wasm32"), serde(rename_all = "snake_case"))]
+#[cfg_attr(not(target_arch = "wasm32"), serde(rename_all = "camelCase"))]
 #[cfg_attr(test, derive(Eq, PartialEq))]
 pub struct Diagnostic {
     category: Option<&'static Category>,
@@ -137,7 +137,7 @@ impl<D: super::Diagnostic + ?Sized> std::fmt::Display for PrintDescription<'_, D
 }
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
-#[cfg_attr(not(target_arch = "wasm32"), serde(rename_all = "snake_case"))]
+#[cfg_attr(not(target_arch = "wasm32"), serde(rename_all = "camelCase"))]
 #[cfg_attr(test, derive(Eq, PartialEq))]
 struct Location {
     path: Option<Resource<String>>,
@@ -159,7 +159,7 @@ impl From<super::Location<'_>> for Location {
 
 /// Implementation of [Visitor] collecting serializable [Advice] into a vector.
 #[derive(Clone, Debug, Serialize, Deserialize)]
-#[serde(rename_all = "snake_case")]
+#[serde(rename_all = "camelCase")]
 #[cfg_attr(test, derive(Eq, PartialEq))]
 struct Advices {
     advices: Vec<Advice>,
@@ -245,7 +245,7 @@ impl super::Advices for Advices {
 /// See the [Visitor] trait for additional documentation on all the supported
 /// advice types.
 #[derive(Clone, Debug, Serialize, Deserialize)]
-#[serde(rename_all = "snake_case")]
+#[serde(rename_all = "camelCase")]
 #[cfg_attr(test, derive(Eq, PartialEq))]
 enum Advice {
     Log(LogCategory, MarkupBuf),

crates/pglt_diagnostics/src/serde.rs

@@ -18,14 +18,14 @@ mod os;
 pub struct ConfigName;
 
 impl ConfigName {
-    const PGLT_TOML: [&'static str; 1] = ["pglt.toml"];
+    const PGLT_JSONC: [&'static str; 1] = ["pglt.jsonc"];
 
-    pub const fn pglt_toml() -> &'static str {
-        Self::PGLT_TOML[0]
+    pub const fn pglt_jsonc() -> &'static str {
+        Self::PGLT_JSONC[0]
     }
 
     pub const fn file_names() -> [&'static str; 1] {
-        Self::PGLT_TOML
+        Self::PGLT_JSONC
     }
 }