chore: rename conf and env vars (#245)

psteinroe · web-flow · commit 7cc3fc5c67c9 · 2025-03-18T15:20:02.000+01:00
diff --git a/crates/pgt_analyse/src/options.rs b/crates/pgt_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.jsonc`] file
+    /// A data structured derived from the [`postgrestools.jsonc`] file
     pub rules: AnalyserRules,
 }
 
diff --git a/crates/pgt_analyser/CONTRIBUTING.md b/crates/pgt_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.jsonc` configuration file:
+We would like to set the options in the `postgrestools.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.jsonc`.
+- `rename_all = "camelCase"`: it renames all fields in camel-case, so they are in line with the naming style of the `postgrestools.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.jsonc`. This macro makes the field optional.
+- `default`: it uses the `Default` value when the field is missing from `postgrestools.jsonc`. This macro makes the field optional.
 
 You can simply use a derive macros:
 
diff --git a/crates/pgt_cli/src/cli_options.rs b/crates/pgt_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.jsonc`.
+    /// Set the file path to the configuration file, or the directory path to find `postgrestools.jsonc`.
     /// If used, it disables the default configuration file resolution.
     #[bpaf(long("config-path"), argument("PATH"), optional)]
     pub config_path: Option<String>,
diff --git a/crates/pgt_cli/src/commands/daemon.rs b/crates/pgt_cli/src/commands/daemon.rs
@@ -233,7 +233,7 @@ fn setup_tracing_subscriber(log_path: Option<PathBuf>, log_file_name_prefix: Opt
 }
 
 pub fn default_pgt_log_path() -> PathBuf {
-    match env::var_os("PGLT_LOG_PATH") {
+    match env::var_os("PGT_LOG_PATH") {
         Some(directory) => PathBuf::from(directory),
         None => pgt_fs::ensure_cache_dir().join("pglt-logs"),
     }
diff --git a/crates/pgt_cli/src/commands/mod.rs b/crates/pgt_cli/src/commands/mod.rs
@@ -58,7 +58,7 @@ pub enum PgtCommand {
         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.jsonc`
+        /// flag and the `defaultBranch` is not set in your `postgrestools.jsonc`
         #[bpaf(long("since"), argument("REF"))]
         since: Option<String>,
 
@@ -72,7 +72,7 @@ pub enum PgtCommand {
     Start {
         /// Allows to change the prefix applied to the file name of the logs.
         #[bpaf(
-            env("PGLT_LOG_PREFIX_NAME"),
+            env("PGT_LOG_PREFIX_NAME"),
             long("log-prefix-name"),
             argument("STRING"),
             hide_usage,
@@ -83,16 +83,16 @@ pub enum PgtCommand {
 
         /// Allows to change the folder where logs are stored.
         #[bpaf(
-            env("PGLT_LOG_PATH"),
+            env("PGT_LOG_PATH"),
             long("log-path"),
             argument("PATH"),
             hide_usage,
             fallback(pgt_fs::ensure_cache_dir().join("pglt-logs")),
         )]
         log_path: PathBuf,
         /// Allows to set a custom file path to the configuration file,
-        /// or a custom directory path to find `pglt.jsonc`
-        #[bpaf(env("PGLT_LOG_PREFIX_NAME"), long("config-path"), argument("PATH"))]
+        /// or a custom directory path to find `postgrestools.jsonc`
+        #[bpaf(env("PGT_LOG_PREFIX_NAME"), long("config-path"), argument("PATH"))]
         config_path: Option<PathBuf>,
     },
 
@@ -109,7 +109,7 @@ pub enum PgtCommand {
     LspProxy {
         /// Allows to change the prefix applied to the file name of the logs.
         #[bpaf(
-            env("PGLT_LOG_PREFIX_NAME"),
+            env("PGT_LOG_PREFIX_NAME"),
             long("log-prefix-name"),
             argument("STRING"),
             hide_usage,
@@ -119,16 +119,16 @@ pub enum PgtCommand {
         log_prefix_name: String,
         /// Allows to change the folder where logs are stored.
         #[bpaf(
-            env("PGLT_LOG_PATH"),
+            env("PGT_LOG_PATH"),
             long("log-path"),
             argument("PATH"),
             hide_usage,
             fallback(pgt_fs::ensure_cache_dir().join("pglt-logs")),
         )]
         log_path: PathBuf,
         /// Allows to set a custom file path to the configuration file,
-        /// or a custom directory path to find `pglt.jsonc`
-        #[bpaf(env("PGLT_CONFIG_PATH"), long("config-path"), argument("PATH"))]
+        /// or a custom directory path to find `postgrestools.jsonc`
+        #[bpaf(env("PGT_CONFIG_PATH"), long("config-path"), argument("PATH"))]
         config_path: Option<PathBuf>,
         /// Bogus argument to make the command work with vscode-languageclient
         #[bpaf(long("stdio"), hide, hide_usage, switch)]
@@ -143,7 +143,7 @@ pub enum PgtCommand {
     RunServer {
         /// Allows to change the prefix applied to the file name of the logs.
         #[bpaf(
-            env("PGLT_LOG_PREFIX_NAME"),
+            env("PGT_LOG_PREFIX_NAME"),
             long("log-prefix-name"),
             argument("STRING"),
             hide_usage,
@@ -153,7 +153,7 @@ pub enum PgtCommand {
         log_prefix_name: String,
         /// Allows to change the folder where logs are stored.
         #[bpaf(
-            env("PGLT_LOG_PATH"),
+            env("PGT_LOG_PATH"),
             long("log-path"),
             argument("PATH"),
             hide_usage,
@@ -164,8 +164,8 @@ pub enum PgtCommand {
         #[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.jsonc`
-        #[bpaf(env("PGLT_CONFIG_PATH"), long("config-path"), argument("PATH"))]
+        /// or a custom directory path to find `postgrestools.jsonc`
+        #[bpaf(env("PGT_CONFIG_PATH"), long("config-path"), argument("PATH"))]
         config_path: Option<PathBuf>,
     },
     #[bpaf(command("__print_socket"), hide)]
diff --git a/crates/pgt_cli/src/diagnostics.rs b/crates/pgt_cli/src/diagnostics.rs
@@ -48,7 +48,7 @@ pub enum CliDiagnostic {
     IoError(IoDiagnostic),
     /// The daemon is not running
     ServerNotRunning(ServerNotRunning),
-    /// The end configuration (`pglt.jsonc` + other options) is incompatible with the command
+    /// The end configuration (`postgrestools.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.jsonc` file + CLI arguments + LSP configuration)
+    /// Emitted when the end configuration (`postgrestools.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
diff --git a/crates/pgt_cli/src/lib.rs b/crates/pgt_cli/src/lib.rs
@@ -32,7 +32,7 @@ pub use panic::setup_panic_handler;
 pub use reporter::{DiagnosticsPayload, Reporter, ReporterVisitor, TraversalSummary};
 pub use service::{SocketTransport, open_transport};
 
-pub(crate) const VERSION: &str = match option_env!("PGLT_VERSION") {
+pub(crate) const VERSION: &str = match option_env!("PGT_VERSION") {
     Some(version) => version,
     None => env!("CARGO_PKG_VERSION"),
 };
diff --git a/crates/pgt_configuration/src/lib.rs b/crates/pgt_configuration/src/lib.rs
@@ -1,4 +1,4 @@
-//! This module contains the configuration of `pglt.jsonc`
+//! This module contains the configuration of `postgrestools.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.
@@ -34,7 +34,7 @@ use migrations::{
 use serde::{Deserialize, Serialize};
 use vcs::VcsClientKind;
 
-pub const VERSION: &str = match option_env!("PGLT_VERSION") {
+pub const VERSION: &str = match option_env!("PGT_VERSION") {
     Some(version) => version,
     None => "0.0.0",
 };
diff --git a/crates/pgt_configuration/src/vcs.rs b/crates/pgt_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.jsonc` was found.
+    /// folder where `postgrestools.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
diff --git a/crates/pgt_flags/src/lib.rs b/crates/pgt_flags/src/lib.rs
@@ -8,33 +8,33 @@ use std::sync::{LazyLock, OnceLock};
 
 /// Returns `true` if this is an unstable build of PgLT
 pub fn is_unstable() -> bool {
-    PGLT_VERSION.deref().is_none()
+    PGT_VERSION.deref().is_none()
 }
 
 /// The internal version of PgLT. This is usually supplied during the CI build
-pub static PGLT_VERSION: LazyLock<Option<&str>> = LazyLock::new(|| option_env!("PGLT_VERSION"));
+pub static PGT_VERSION: LazyLock<Option<&str>> = LazyLock::new(|| option_env!("PGT_VERSION"));
 
 pub struct PgLTEnv {
     pub pgt_log_path: PgLTEnvVariable,
     pub pgt_log_prefix: PgLTEnvVariable,
     pub pgt_config_path: PgLTEnvVariable,
 }
 
-pub static PGLT_ENV: OnceLock<PgLTEnv> = OnceLock::new();
+pub static PGT_ENV: OnceLock<PgLTEnv> = OnceLock::new();
 
 impl PgLTEnv {
     fn new() -> Self {
         Self {
             pgt_log_path: PgLTEnvVariable::new(
-                "PGLT_LOG_PATH",
+                "PGT_LOG_PATH",
                 "The directory where the Daemon logs will be saved.",
             ),
             pgt_log_prefix: PgLTEnvVariable::new(
-                "PGLT_LOG_PREFIX_NAME",
+                "PGT_LOG_PREFIX_NAME",
                 "A prefix that's added to the name of the log. Default: `server.log.`",
             ),
             pgt_config_path: PgLTEnvVariable::new(
-                "PGLT_CONFIG_PATH",
+                "PGT_CONFIG_PATH",
                 "A path to the configuration file",
             ),
         }
@@ -71,7 +71,7 @@ impl PgLTEnvVariable {
 }
 
 pub fn pgt_env() -> &'static PgLTEnv {
-    PGLT_ENV.get_or_init(PgLTEnv::new)
+    PGT_ENV.get_or_init(PgLTEnv::new)
 }
 
 impl Display for PgLTEnv {
diff --git a/crates/pgt_fs/src/fs.rs b/crates/pgt_fs/src/fs.rs
@@ -18,14 +18,14 @@ mod os;
 pub struct ConfigName;
 
 impl ConfigName {
-    const PGLT_JSONC: [&'static str; 1] = ["pglt.jsonc"];
+    const PGT_JSONC: [&'static str; 1] = ["postgrestools.jsonc"];
 
     pub const fn pgt_jsonc() -> &'static str {
-        Self::PGLT_JSONC[0]
+        Self::PGT_JSONC[0]
     }
 
     pub const fn file_names() -> [&'static str; 1] {
-        Self::PGLT_JSONC
+        Self::PGT_JSONC
     }
 }
 
diff --git a/crates/pgt_fs/src/path.rs b/crates/pgt_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.jsonc`
+    /// A configuration file has the highest priority. It's usually `postgrestools.jsonc`
     ///
     /// Other third-party configuration files might be added in the future
     Config,
@@ -173,7 +173,7 @@ impl PgLTPath {
     }
 
     /// The priority of the file.
-    /// - `pglt.jsonc` has the highest priority
+    /// - `postgrestools.jsonc` has the highest priority
     /// - Other files are considered as files to handle
     fn priority(file_name: &OsStr) -> FileKinds {
         if file_name == ConfigName::pgt_jsonc() {
diff --git a/crates/pgt_lsp/src/session.rs b/crates/pgt_lsp/src/session.rs
@@ -400,7 +400,7 @@ impl Session {
             .map(|params| &params.client_capabilities)
     }
 
-    /// This function attempts to read the `pglt.jsonc` configuration file from
+    /// This function attempts to read the `postgrestools.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) {
diff --git a/crates/pgt_lsp/tests/server.rs b/crates/pgt_lsp/tests/server.rs
@@ -372,7 +372,7 @@ async fn test_database_connection() -> Result<()> {
         ..Default::default()
     });
     fs.insert(
-        url!("pglt.jsonc").to_file_path().unwrap(),
+        url!("postgrestools.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.jsonc").to_file_path().unwrap(),
+        url!("postgrestools.jsonc").to_file_path().unwrap(),
         serde_json::to_string_pretty(&conf).unwrap(),
     );
 
diff --git a/crates/pgt_workspace/src/configuration.rs b/crates/pgt_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.jsonc`
+    // We first search for `postgrestools.jsonc`
     if let Some(auto_search_result) = file_system.auto_search(
         &configuration_directory,
         ConfigName::file_names().as_slice(),
diff --git a/docs/checking_migrations.md b/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.jsonc` 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 `postgrestools.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.jsonc`, 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 `postgrestools.jsonc`, use `--since=REF` to specify the base branch to compare against.
 
diff --git a/docs/cli_reference.md b/docs/cli_reference.md
@@ -202,14 +202,14 @@ Starts the daemon server process.
 
 - **`    --log-prefix-name`**=_`STRING`_ &mdash;
   Allows to change the prefix applied to the file name of the logs.
-  Uses environment variable **`PGLT_LOG_PREFIX_NAME`**
+  Uses environment variable **`PGT_LOG_PREFIX_NAME`**
   [default: server.log]
 - **`    --log-path`**=_`PATH`_ &mdash;
   Allows to change the folder where logs are stored.
-  Uses environment variable **`PGLT_LOG_PATH`**
+  Uses environment variable **`PGT_LOG_PATH`**
 - **`    --config-path`**=_`PATH`_ &mdash;
   Allows to set a custom file path to the configuration file, or a custom directory path to find `postgrestools.jsonc`
-  Uses environment variable **`PGLT_LOG_PREFIX_NAME`**
+  Uses environment variable **`PGT_LOG_PREFIX_NAME`**
 - **`-h`**, **`--help`** &mdash;
   Prints help information
 
@@ -245,14 +245,14 @@ Acts as a server for the Language Server Protocol over stdin/stdout.
 
 - **`    --log-prefix-name`**=_`STRING`_ &mdash;
   Allows to change the prefix applied to the file name of the logs.
-  Uses environment variable **`PGLT_LOG_PREFIX_NAME`**
+  Uses environment variable **`PGT_LOG_PREFIX_NAME`**
   [default: server.log]
 - **`    --log-path`**=_`PATH`_ &mdash;
   Allows to change the folder where logs are stored.
-  Uses environment variable **`PGLT_LOG_PATH`**
+  Uses environment variable **`PGT_LOG_PATH`**
 - **`    --config-path`**=_`PATH`_ &mdash;
   Allows to set a custom file path to the configuration file, or a custom directory path to find `postgrestools.jsonc`
-  Uses environment variable **`PGLT_CONFIG_PATH`**
+  Uses environment variable **`PGT_CONFIG_PATH`**
 - **`-h`**, **`--help`** &mdash;
   Prints help information
 
diff --git a/docs/env_variables.md b/docs/env_variables.md
@@ -3,15 +3,15 @@
 [//]: # (BEGIN ENV_VARS)
 
 
-### `PGLT_LOG_PATH`
+### `PGT_LOG_PATH`
 
  The directory where the Daemon logs will be saved.
 
-### `PGLT_LOG_PREFIX_NAME`
+### `PGT_LOG_PREFIX_NAME`
 
  A prefix that's added to the name of the log. Default: `server.log.`
 
-### `PGLT_CONFIG_PATH`
+### `PGT_CONFIG_PATH`
 
  A path to the configuration file
 
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/schemas/0.0.0/schema.json b/docs/schemas/0.0.0/schema.json
diff --git a/docs/schemas/latest/schema.json b/docs/schemas/latest/schema.json
diff --git a/postgrestools.jsonc b/postgrestools.jsonc

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ impl AnalyserRules {`
`45`	`45`	`/// A set of information useful to the analyser infrastructure`
`46`	`46`	`#[derive(Debug, Default)]`
`47`	`47`	`pub struct AnalyserOptions {`
`48`		- /// A data structured derived from the [`pglt.jsonc`] file
	`48`	+ /// A data structured derived from the [`postgrestools.jsonc`] file
`49`	`49`	`pub rules: AnalyserRules,`
`50`	`50`	`}`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -233,7 +233,7 @@ fn setup_tracing_subscriber(log_path: Option<PathBuf>, log_file_name_prefix: Opt`
`233`	`233`	`}`
`234`	`234`
`235`	`235`	`pub fn default_pgt_log_path() -> PathBuf {`
`236`		`- match env::var_os("PGLT_LOG_PATH") {`
	`236`	`+ match env::var_os("PGT_LOG_PATH") {`
`237`	`237`	`Some(directory) => PathBuf::from(directory),`
`238`	`238`	`None => pgt_fs::ensure_cache_dir().join("pglt-logs"),`
`239`	`239`	`}`