migrate to jsonc config

Author: psteinroe

crates/pglt_analyse/src/options.rs

@@ -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.json`] file
+    /// A data structured derived from the [`pglt.jsonc`] file
     pub rules: AnalyserRules,
 }
 

crates/pglt_analyser/CONTRIBUTING.md

@@ -79,7 +79,7 @@ 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.json` configuration file:
+We would like to set the options in the `pglt.jsonc` configuration file:
 
 ```json
 {
@@ -141,9 +141,9 @@ We currently require implementing _serde_'s traits `Deserialize`/`Serialize`.
 
 Also, we use other `serde` macros to adjust the JSON configuration:
 
-- `rename_all = "camelCase"`: it renames all fields in camel-case, so they are in line with the naming style of the `pglt.json`.
+- `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.json`. 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:
 

crates/pglt_cli/src/cli_options.rs

@@ -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.json`.
+    /// 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/commands/init.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_json();
+    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/mod.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.json`
+        /// 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.json`
+        /// 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.json`
+        /// 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.json`
+        /// 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/diagnostics.rs

@@ -48,7 +48,7 @@ pub enum CliDiagnostic {
     IoError(IoDiagnostic),
     /// The daemon is not running
     ServerNotRunning(ServerNotRunning),
-    /// The end configuration (`pglt.json` + 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.json` 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_configuration/src/lib.rs

@@ -1,4 +1,4 @@
-//! This module contains the configuration of `pglt.json`
+//! 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.

crates/pglt_configuration/src/vcs.rs

@@ -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.json` 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

crates/pglt_fs/src/fs.rs

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

crates/pglt_fs/src/path.rs

@@ -21,7 +21,7 @@ use crate::ConfigName;
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 // NOTE: The order of the variants is important, the one on the top has the highest priority
 pub enum FileKind {
-    /// A configuration file has the highest priority. It's usually `pglt.json`
+    /// A configuration file has the highest priority. It's usually `pglt.jsonc`
     ///
     /// Other third-party configuration files might be added in the future
     Config,
@@ -173,10 +173,10 @@ impl PgLTPath {
     }
 
     /// The priority of the file.
-    /// - `pglt.json` has the highest priority
+    /// - `pglt.jsonc` has the highest priority
     /// - Other files are considered as files to handle
     fn priority(file_name: &OsStr) -> FileKinds {
-        if file_name == ConfigName::pglt_json() {
+        if file_name == ConfigName::pglt_jsonc() {
             FileKind::Config.into()
         } else {
             FileKind::Handleable.into()

crates/pglt_lsp/src/server.rs

@@ -76,7 +76,7 @@ impl LSPServer {
                             glob_pattern: GlobPattern::String(format!(
                                 "{}/{}",
                                 base_path.display(),
-                                ConfigName::pglt_json()
+                                ConfigName::pglt_jsonc()
                             )),
                             kind: Some(WatchKind::all()),
                         },],
@@ -151,7 +151,7 @@ impl LanguageServer for LSPServer {
 
         info!(
             "Attempting to load the configuration from '{}' file",
-            ConfigName::pglt_json()
+            ConfigName::pglt_jsonc()
         );
 
         futures::join!(self.session.load_workspace_settings());

crates/pglt_lsp/src/session.rs

@@ -400,7 +400,7 @@ impl Session {
             .map(|params| &params.client_capabilities)
     }
 
-    /// This function attempts to read the `pglt.json` configuration file from
+    /// This function attempts to read the `pglt.jsonc` configuration file from
     /// the root URI and update the workspace settings accordingly
     #[tracing::instrument(level = "trace", skip(self))]
     pub(crate) async fn load_workspace_settings(&self) {

crates/pglt_lsp/tests/server.rs

@@ -372,7 +372,7 @@ async fn test_database_connection() -> Result<()> {
         ..Default::default()
     });
     fs.insert(
-        url!("pglt.json").to_file_path().unwrap(),
+        url!("pglt.jsonc").to_file_path().unwrap(),
         serde_json::to_string_pretty(&conf).unwrap(),
     );
 
@@ -484,7 +484,7 @@ async fn test_completions() -> Result<()> {
         ..Default::default()
     });
     fs.insert(
-        url!("pglt.json").to_file_path().unwrap(),
+        url!("pglt.jsonc").to_file_path().unwrap(),
         serde_json::to_string_pretty(&conf).unwrap(),
     );
 

crates/pglt_workspace/src/configuration.rs

@@ -120,7 +120,7 @@ fn load_config(
         ConfigurationPathHint::None => file_system.working_directory().unwrap_or_default(),
     };
 
-    // We first search for `pglt.json`
+    // We first search for `pglt.jsonc`
     if let Some(auto_search_result) = file_system.auto_search(
         &configuration_directory,
         ConfigName::file_names().as_slice(),
@@ -153,7 +153,7 @@ pub fn create_config(
     fs: &mut DynRef<dyn FileSystem>,
     configuration: &mut PartialConfiguration,
 ) -> Result<(), WorkspaceError> {
-    let path = PathBuf::from(ConfigName::pglt_json());
+    let path = PathBuf::from(ConfigName::pglt_jsonc());
 
     if fs.path_exists(&path) {
         return Err(ConfigurationDiagnostic::new_already_exists().into());

crates/pglt_workspace/src/workspace/server.rs

@@ -108,7 +108,7 @@ impl WorkspaceServer {
     fn is_ignored(&self, path: &Path) -> bool {
         let file_name = path.file_name().and_then(|s| s.to_str());
         // Never ignore PgLT's config file regardless `include`/`ignore`
-        (file_name != Some(ConfigName::pglt_json())) &&
+        (file_name != Some(ConfigName::pglt_jsonc())) &&
             // Apply top-level `include`/`ignore
             (self.is_ignored_by_top_level_config(path) || self.is_ignored_by_migration_config(path))
     }

docs/checking_migrations.md

@@ -8,7 +8,7 @@ To run it, simply point at your migrations directory.
 pglt check supabase/migrations
 ```
 
-When you are setting it up in an existing project, you might want to ignore all migrations that are already applied. To do so, add `migrationsDir` and `after` to your `pglt.json` file
+When you are setting it up in an existing project, you might want to ignore all migrations that are already applied. To do so, add `migrationsDir` and `after` to your `pglt.jsonc` file
 
 
 ```json
@@ -28,5 +28,5 @@ pglt check supabase/migrations --migrations-dir="supabase/migrations" --after=17
 
 This will only check migrations after the specified timestamp.
 
-For pre-commit hooks and when working locally, use `--staged` to only lint files that have been staged. In CI environments, you most likely want to use `--changed` to only lint files that have been changed compared to your `vcs.default_branch` configuration. If `default_branch` is not set in your `pglt.json`, use `--since=REF` to specify the base branch to compare against.
+For pre-commit hooks and when working locally, use `--staged` to only lint files that have been staged. In CI environments, you most likely want to use `--changed` to only lint files that have been changed compared to your `vcs.default_branch` configuration. If `default_branch` is not set in your `pglt.jsonc`, use `--since=REF` to specify the base branch to compare against.
 

docs/cli_reference.md

@@ -62,7 +62,7 @@ Shows the version information and quit.
 - **`    --verbose`** — 
   Print additional diagnostics, and some diagnostics show more information. Also, print out what files were processed and which ones were modified.
 - **`    --config-path`**=_`PATH`_ — 
-  Set the file path to the configuration file, or the directory path to find `pglt.json`. If used, it disables the default configuration file resolution.
+  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.
 - **`    --max-diagnostics`**=_`<none|<NUMBER>>`_ &mdash; 
   Cap the amount of diagnostics displayed. When `none` is provided, the limit is lifted.
 
@@ -111,7 +111,7 @@ Runs everything to the requested files.
 - **`    --vcs-use-ignore-file`**=_`<true|false>`_ &mdash; 
   Whether we should use the VCS ignore file. When [true], we will ignore the files specified in the ignore file.
 - **`    --vcs-root`**=_`PATH`_ &mdash; 
-  The folder where we should check for VCS files. By default, we will use the same folder where `pglt.json` was found.
+  The folder where we should check for VCS files. By default, we will use the same 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 will be emitted
 - **`    --vcs-default-branch`**=_`BRANCH`_ &mdash; 
@@ -149,7 +149,7 @@ Runs everything to the requested files.
 - **`    --verbose`** &mdash; 
   Print additional diagnostics, and some diagnostics show more information. Also, print out what files were processed and which ones were modified.
 - **`    --config-path`**=_`PATH`_ &mdash; 
-  Set the file path to the configuration file, or the directory path to find `pglt.json`. If used, it disables the default configuration file resolution.
+  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.
 - **`    --max-diagnostics`**=_`<none|<NUMBER>>`_ &mdash; 
   Cap the amount of diagnostics displayed. When `none` is provided, the limit is lifted.
 
@@ -197,7 +197,7 @@ Runs everything to the requested files.
 - **`    --changed`** &mdash; 
   When set to true, only the files that have been changed compared to your `defaultBranch` configuration will be linted. This option should be used in CI environments.
 - **`    --since`**=_`REF`_ &mdash; 
-  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.json`
+  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.jsonc`
 - **`-h`**, **`--help`** &mdash; 
   Prints help information
 
@@ -220,7 +220,7 @@ Starts the daemon server process.
 
   Uses environment variable **`PGLT_LOG_PATH`**
 - **`    --config-path`**=_`PATH`_ &mdash; 
-  Allows to set a custom file path to the configuration file, or a custom directory path to find `pglt.json`
+  Allows to set a custom file path to the configuration file, or a custom directory path to find `pglt.jsonc`
 
   Uses environment variable **`PGLT_LOG_PREFIX_NAME`**
 - **`-h`**, **`--help`** &mdash; 
@@ -267,7 +267,7 @@ Acts as a server for the Language Server Protocol over stdin/stdout.
 
   Uses environment variable **`PGLT_LOG_PATH`**
 - **`    --config-path`**=_`PATH`_ &mdash; 
-  Allows to set a custom file path to the configuration file, or a custom directory path to find `pglt.json`
+  Allows to set a custom file path to the configuration file, or a custom directory path to find `pglt.jsonc`
 
   Uses environment variable **`PGLT_CONFIG_PATH`**
 - **`-h`**, **`--help`** &mdash; 

docs/index.md

@@ -29,13 +29,13 @@ Our current focus is on refining and enhancing these core features while buildin
 
 ## Configuration
 
-We recommend that you create a `pglt.json` configuration file for each project. This eliminates the need to repeat the CLI options each time you run a command, and ensures that we use the same configuration in your editor. Some options are also only available from a configuration file. If you are happy with the defaults, you don’t need to create a configuration file. To create the `pglt.json` file, run the `init` command in the root folder of your project:
+We recommend that you create a `pglt.jsonc` configuration file for each project. This eliminates the need to repeat the CLI options each time you run a command, and ensures that we use the same configuration in your editor. Some options are also only available from a configuration file. If you are happy with the defaults, you don’t need to create a configuration file. To create the `pglt.jsonc` file, run the `init` command in the root folder of your project:
 
 ```sh
 pglt init
 ```
 
-After running the `init` command, you’ll have a `pglt.json` file in your directory:
+After running the `init` command, you’ll have a `pglt.jsonc` file in your directory:
 
 [//]: # (BEGIN DEFAULT_CONFIGURATION)
 

docs/schemas/0.0.0/schema.json

@@ -401,7 +401,7 @@
           ]
         },
         "root": {
-          "description": "The folder where we should check for VCS files. By default, we will use the same folder where `pglt.json` was found.\n\nIf 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 will be emitted",
+          "description": "The folder where we should check for VCS files. By default, we will use the same folder where `pglt.jsonc` was found.\n\nIf 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 will be emitted",
           "type": [
             "string",
             "null"

docs/schemas/latest/schema.json

@@ -401,7 +401,7 @@
           ]
         },
         "root": {
-          "description": "The folder where we should check for VCS files. By default, we will use the same folder where `pglt.json` was found.\n\nIf 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 will be emitted",
+          "description": "The folder where we should check for VCS files. By default, we will use the same folder where `pglt.jsonc` was found.\n\nIf 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 will be emitted",
           "type": [
             "string",
             "null"

pglt.jsonc

@@ -0,0 +1,26 @@
+{
+	"$schema": "./docs/schemas/latest/schema.json",
+	"vcs": {
+		"enabled": false,
+		"clientKind": "git",
+		"useIgnoreFile": false
+	},
+	"files": {
+		"ignore": []
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	},
+	// YOU CAN COMMENT ME OUT :)
+	"db": {
+		"host": "127.0.0.1",
+		"port": 5432,
+		"username": "postgres",
+		"password": "postgres",
+		"database": "postgres",
+		"connTimeoutSecs": 10
+	}
+}