feat(docs): finish codegen

Author: psteinroe

Cargo.lock

@@ -48,7 +48,7 @@ pub struct CliOptions {
     #[bpaf(long("no-errors-on-unmatched"), switch)]
     pub no_errors_on_unmatched: bool,
 
-    /// Tell PGLSP to exit with an error code if some diagnostics emit warnings.
+    /// Tell PgLT to exit with an error code if some diagnostics emit warnings.
     #[bpaf(long("error-on-warnings"), switch)]
     pub error_on_warnings: bool,
 
@@ -86,7 +86,7 @@ pub struct CliOptions {
         fallback(Severity::default()),
         display_fallback
     )]
-    /// The level of diagnostics to show. In order, from the lowest to the most important: info, warn, error. Passing `--diagnostic-level=error` will cause PGLSP to print only diagnostics that contain only errors.
+    /// The level of diagnostics to show. In order, from the lowest to the most important: info, warn, error. Passing `--diagnostic-level=error` will cause PgLT to print only diagnostics that contain only errors.
     pub diagnostic_level: Severity,
 }
 

crates/pglt_cli/src/cli_options.rs

@@ -230,7 +230,7 @@ fn setup_tracing_subscriber(log_path: Option<PathBuf>, log_file_name_prefix: Opt
 }
 
 pub fn default_pglt_log_path() -> PathBuf {
-    match env::var_os("PGLSP_LOG_PATH") {
+    match env::var_os("PGLT_LOG_PATH") {
         Some(directory) => PathBuf::from(directory),
         None => pglt_fs::ensure_cache_dir().join("pglt-logs"),
     }

crates/pglt_cli/src/commands/daemon.rs

@@ -72,7 +72,7 @@ pub enum PgltCommand {
     Start {
         /// Allows to change the prefix applied to the file name of the logs.
         #[bpaf(
-            env("PGLSP_LOG_PREFIX_NAME"),
+            env("PGLT_LOG_PREFIX_NAME"),
             long("log-prefix-name"),
             argument("STRING"),
             hide_usage,
@@ -83,7 +83,7 @@ pub enum PgltCommand {
 
         /// Allows to change the folder where logs are stored.
         #[bpaf(
-            env("PGLSP_LOG_PATH"),
+            env("PGLT_LOG_PATH"),
             long("log-path"),
             argument("PATH"),
             hide_usage,
@@ -92,7 +92,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`
-        #[bpaf(env("PGLSP_LOG_PREFIX_NAME"), long("config-path"), argument("PATH"))]
+        #[bpaf(env("PGLT_LOG_PREFIX_NAME"), long("config-path"), argument("PATH"))]
         config_path: Option<PathBuf>,
     },
 
@@ -109,7 +109,7 @@ pub enum PgltCommand {
     LspProxy {
         /// Allows to change the prefix applied to the file name of the logs.
         #[bpaf(
-            env("PGLSP_LOG_PREFIX_NAME"),
+            env("PGLT_LOG_PREFIX_NAME"),
             long("log-prefix-name"),
             argument("STRING"),
             hide_usage,
@@ -119,7 +119,7 @@ pub enum PgltCommand {
         log_prefix_name: String,
         /// Allows to change the folder where logs are stored.
         #[bpaf(
-            env("PGLSP_LOG_PATH"),
+            env("PGLT_LOG_PATH"),
             long("log-path"),
             argument("PATH"),
             hide_usage,
@@ -128,7 +128,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`
-        #[bpaf(env("PGLSP_CONFIG_PATH"), long("config-path"), argument("PATH"))]
+        #[bpaf(env("PGLT_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 PgltCommand {
     RunServer {
         /// Allows to change the prefix applied to the file name of the logs.
         #[bpaf(
-            env("PGLSP_LOG_PREFIX_NAME"),
+            env("PGLT_LOG_PREFIX_NAME"),
             long("log-prefix-name"),
             argument("STRING"),
             hide_usage,
@@ -153,7 +153,7 @@ pub enum PgltCommand {
         log_prefix_name: String,
         /// Allows to change the folder where logs are stored.
         #[bpaf(
-            env("PGLSP_LOG_PATH"),
+            env("PGLT_LOG_PATH"),
             long("log-path"),
             argument("PATH"),
             hide_usage,
@@ -165,7 +165,7 @@ pub enum PgltCommand {
         stop_on_disconnect: bool,
         /// Allows to set a custom file path to the configuration file,
         /// or a custom directory path to find `pglt.toml`
-        #[bpaf(env("PGLSP_CONFIG_PATH"), long("config-path"), argument("PATH"))]
+        #[bpaf(env("PGLT_CONFIG_PATH"), long("config-path"), argument("PATH"))]
         config_path: Option<PathBuf>,
     },
     #[bpaf(command("__print_socket"), hide)]

crates/pglt_cli/src/commands/mod.rs

@@ -15,7 +15,7 @@ fn command_name() -> String {
         .unwrap_or_else(|| String::from("pglt"))
 }
 
-/// A diagnostic that is emitted when running PGLSP via CLI.
+/// A diagnostic that is emitted when running PgLT via CLI.
 ///
 /// When displaying the diagnostic,
 #[derive(Debug, Diagnostic)]

crates/pglt_cli/src/diagnostics.rs

@@ -32,7 +32,7 @@ pub use panic::setup_panic_handler;
 pub use reporter::{DiagnosticsPayload, Reporter, ReporterVisitor, TraversalSummary};
 pub use service::{open_transport, SocketTransport};
 
-pub(crate) const VERSION: &str = match option_env!("PGLSP_VERSION") {
+pub(crate) const VERSION: &str = match option_env!("PGLT_VERSION") {
     Some(version) => version,
     None => env!("CARGO_PKG_VERSION"),
 };

crates/pglt_cli/src/lib.rs

@@ -46,7 +46,7 @@ impl std::str::FromStr for RuleGroup {
 #[cfg_attr(feature = "schema", derive(JsonSchema))]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct Rules {
-    #[doc = r" It enables the lint rules recommended by PGLSP. `true` by default."]
+    #[doc = r" It enables the lint rules recommended by PgLT. `true` by default."]
     #[serde(skip_serializing_if = "Option::is_none")]
     pub recommended: Option<bool>,
     #[doc = r" It enables ALL rules. The rules that belong to `nursery` won't be enabled."]

crates/pglt_configuration/src/analyser/linter/rules.rs

@@ -34,7 +34,7 @@ use migrations::{
 use serde::{Deserialize, Serialize};
 use vcs::VcsClientKind;
 
-pub const VERSION: &str = match option_env!("PGLSP_VERSION") {
+pub const VERSION: &str = match option_env!("PGLT_VERSION") {
     Some(version) => version,
     None => "0.0.0",
 };

crates/pglt_configuration/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 {
-    PGLSP_VERSION.deref().is_none()
+    PGLT_VERSION.deref().is_none()
 }
 
 /// The internal version of PgLT. This is usually supplied during the CI build
-pub static PGLSP_VERSION: LazyLock<Option<&str>> = LazyLock::new(|| option_env!("PGLSP_VERSION"));
+pub static PGLT_VERSION: LazyLock<Option<&str>> = LazyLock::new(|| option_env!("PGLT_VERSION"));
 
 pub struct PgLTEnv {
     pub pglt_log_path: PgLTEnvVariable,
     pub pglt_log_prefix: PgLTEnvVariable,
     pub pglt_config_path: PgLTEnvVariable,
 }
 
-pub static PGLSP_ENV: OnceLock<PgLTEnv> = OnceLock::new();
+pub static PGLT_ENV: OnceLock<PgLTEnv> = OnceLock::new();
 
 impl PgLTEnv {
     fn new() -> Self {
         Self {
             pglt_log_path: PgLTEnvVariable::new(
-                "PGLSP_LOG_PATH",
+                "PGLT_LOG_PATH",
                 "The directory where the Daemon logs will be saved.",
             ),
             pglt_log_prefix: PgLTEnvVariable::new(
-                "PGLSP_LOG_PREFIX_NAME",
+                "PGLT_LOG_PREFIX_NAME",
                 "A prefix that's added to the name of the log. Default: `server.log.`",
             ),
             pglt_config_path: PgLTEnvVariable::new(
-                "PGLSP_CONFIG_PATH",
+                "PGLT_CONFIG_PATH",
                 "A path to the configuration file",
             ),
         }
@@ -71,7 +71,7 @@ impl PgLTEnvVariable {
 }
 
 pub fn pglt_env() -> &'static PgLTEnv {
-    PGLSP_ENV.get_or_init(PgLTEnv::new)
+    PGLT_ENV.get_or_init(PgLTEnv::new)
 }
 
 impl Display for PgLTEnv {

crates/pglt_flags/src/lib.rs

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