@gspothq/cli 0.0.0-stage → 0.1.1

package/configurations/general/format/manifest.toml

@@ -0,0 +1,152 @@
+allowed_words = ["Prettier"]
+
+[configuration]
+always_selected = true
+title = "Format"
+description = "One [format] block every formatter reads, so indentation cannot disagree between Prettier, shfmt, Ruff, and markdownlint."
+
+[files]
+extensions = [".ts", ".tsx", ".mts", ".cts", ".js", ".mjs", ".cjs", ".jsx", ".json", ".jsonc", ".json5", ".md", ".mdx", ".css", ".scss", ".html", ".yml", ".yaml", ".vue", ".graphql"]
+prettier_plugins = true
+
+[[tool]]
+name = "prettier"
+crash_pattern = "\\[error\\] (?:No parser|Cannot find|Invalid)"
+version = "3.8.1"
+npm = "prettier"
+[[tool.replace]]
+file = ".prettierrc"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.json"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.yml"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.yaml"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.json5"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.js"
+shared = false
+
+[[tool.replace]]
+file = "prettier.config.js"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.ts"
+shared = false
+
+[[tool.replace]]
+file = "prettier.config.ts"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.mjs"
+shared = false
+
+[[tool.replace]]
+file = "prettier.config.mjs"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.mts"
+shared = false
+
+[[tool.replace]]
+file = "prettier.config.mts"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.cjs"
+shared = false
+
+[[tool.replace]]
+file = "prettier.config.cjs"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.cts"
+shared = false
+
+[[tool.replace]]
+file = "prettier.config.cts"
+shared = false
+
+[[tool.replace]]
+file = ".prettierrc.toml"
+shared = false
+
+[[tool.replace]]
+file = ".prettierignore"
+shared = false
+
+[[tool.replace]]
+file = "package.json"
+key = "prettier"
+shared = true
+
+[[tool.replace]]
+file = "package.yaml"
+key = "prettier"
+shared = true
+
+[[tool]]
+name = "editorconfig-checker"
+version = "3.4.0"
+env = { EC_VERSION = "v3.4.0" }
+npm = { name = "editorconfig-checker", version = "7.0.0" }
+mise = { name = "npm:editorconfig-checker", version = "7.0.0" }
+brew = "editorconfig-checker"
+github = { name = "editorconfig-checker/editorconfig-checker", version = "v3.4.0" }
+[[tool.replace]]
+file = ".editorconfig"
+shared = false
+
+[[tool_file]]
+target = ".editorconfig"
+tool = ["editorconfig-checker", "prettier"]
+
+[[tool_file]]
+target = ".gspot/config/prettier.json"
+tool = "prettier"
+pointer = { path = "prettier.config.mjs", when = { configuration = "javascript" } }
+
+[[tool_file]]
+target = ".prettierignore"
+tool = "prettier"
+
+[[check]]
+name = "prettier"
+example = "A selected JavaScript file containing `const value={enabled:true};` differs from the configured Prettier output. Run the formatter and retain its spacing and wrapping changes before rerunning."
+level = "recommended"
+stage = "commit"
+command = ["prettier", "--check", "--config", "{tool_file:prettier}", "--ignore-path", ".prettierignore", "--log-level", "warn", "{files}"]
+exit_codes = [1]
+fix = ["prettier", "--write", "--config", "{tool_file:prettier}", "--ignore-path", ".prettierignore", "--log-level", "warn", "{files}"]
+output = { format = "regex", pattern = "^\\[warn\\] (?<file>[^\\s].*[^\\s.])$", message = "This file is not formatted the way Prettier formats it." }
+summary = "Checks that every file Prettier formats is already formatted that way."
+why = "Formatting by hand differs by editor; one formatter keeps diffs about the change and not the spacing."
+help = "Run gspot check --fix to format every file, or prettier --write on one file."
+
+[[check]]
+name = "editorconfig-checker"
+example = "A file containing CRLF line endings when `.editorconfig` requires LF reports a line-ending finding. Save it with LF endings and rerun. Use the exact configured indentation and final-newline settings as well."
+level = "recommended"
+stage = "commit"
+command = ["editorconfig-checker", "-no-color", "-disable-indentation", "{files}"]
+tool = "editorconfig-checker"
+files = { paths = ["**"] }
+output = { format = "grouped", file_pattern = "^(?<file>.+):$", pattern = "^\\s+(?:(?<line>\\d+)(?:-\\d+)?: )?(?<message>\\S.*)$" }
+summary = "Checks line endings, final newlines and trailing whitespace in every file against .editorconfig."
+why = "These rules cover the files no formatter touches, so a stray tab or missing newline never lands in a diff. Indentation is the formatters' job and is not checked here."
+help = "Fix the line the checker names; most editors apply .editorconfig on save."

package/configurations/general/gspot/manifest.toml

@@ -0,0 +1,65 @@
+allowed_words = ["gspot"]
+[configuration]
+title = "gspot"
+always_selected = true
+description = "Checks gspot.toml and generated files, checks suppression reasons with gspot/suppressions, and requires Node.js as a system tool."
+
+[[tool]]
+name = "node"
+install_hint = "Install Node.js 24.2.0 or newer. On macOS, run brew install node@24. On Windows, run winget install OpenJS.NodeJS.LTS."
+min_version = "24.2.0"
+version_command = ["--version"]
+system = true
+brew = "node@24"
+winget = "OpenJS.NodeJS.LTS"
+
+[[check]]
+name = "settings-format"
+example = "A hand-edited gspot.toml with separated tables reports a layout finding. Run gspot check --fix --only gspot/settings-format to regroup its tables and retain their comments."
+level = "recommended"
+stage = "commit"
+files = { paths = ["gspot.toml"] }
+summary = "Keeps gspot.toml formatted."
+why = "One settings layout keeps related settings and their reasons together."
+help = "Run gspot check --fix --only gspot/settings-format."
+
+[[check]]
+name = "generated-files"
+example = "A file under `.gspot/config/` edited by hand differs from what gspot writes from gspot.toml and reports drift. Change the settings in gspot.toml and run gspot apply, or move the edited file aside so apply writes it again."
+level = "recommended"
+stage = "commit"
+runs = "once"
+summary = "Compares every generated file with what gspot writes from the settings: a changed, missing, or stray file, or one with merge conflict markers, is a finding."
+why = "A generated file that no longer matches the settings runs a tool with settings nobody chose."
+help = "Change the settings in gspot.toml, then run gspot apply. After a merge, run gspot apply and then gspot install."
+
+[[check]]
+name = "unused-entries"
+example = "An `[[ignore]]` entry for `bash/shellcheck` with `paths = [\"nowhere/**\"]` reports `unmatched-pattern` when that path matches no selected file. Remove the obsolete entry or correct its path to the actual exception, preserving its reason."
+level = "recommended"
+stage = "commit"
+runs = "once"
+summary = "Checks settings path patterns against tracked files."
+why = "An ignore or declaration that matches nothing misleads the next reader."
+help = "Remove the entry or correct its path."
+
+[[check]]
+name = "settings"
+example = "An unknown setting or a loosened limit without a reason reports its gspot.toml key path. Correct the declaration or record the required reason."
+level = "recommended"
+stage = "commit"
+runs = "once"
+files = { paths = ["gspot.toml"] }
+summary = "Checks the captured gspot.toml declarations for invalid settings and missing reasons."
+why = "A setting no check reads, or an unexplained loosening, can leave repository settings unenforced."
+help = "Fix the gspot.toml key the finding names, and give each loosened value a reason."
+
+[[check]]
+name = "suppressions"
+example = "An `eslint-disable-next-line` comment without a reason reports an unexplained suppression. Fix the underlying finding and remove the suppression, or append a specific `-- reason: ...` explanation of the required exception."
+level = "recommended"
+stage = "commit"
+runs = "once"
+summary = "Checks suppression reasons; Semgrep and Vale directives are refused outright."
+why = "A suppression with no reason hides a finding nobody reviewed."
+help = "Use the tool's suppression syntax to write a meaningful reason, or fix the finding and remove the suppression."

package/configurations/general/gspot/rules/GENERATED.md

@@ -0,0 +1,10 @@
+# Generated Code
+
+- Never edit a generated file by hand. Change the source or the generator and regenerate
+  through its generation command.
+- Mark generated paths in `.gitattributes` with `linguist-generated`; for example,
+  `output/** linguist-generated`. Where the format allows comments, add a header that names the
+  generation command. A folder named `generated/` does not make its files generated.
+- A generated file equals a fresh run of its command. A difference shows a defect in the change.
+- Do not commit build output (`dist/`, `coverage/`, compiled assets) unless the deployment reads
+  it from the repository, and then declare it.

package/configurations/general/licenses/manifest.toml

@@ -0,0 +1,33 @@
+[configuration]
+title = "Licenses"
+description = "Every installed dependency reports a license from the allowed list, or has an allowed-package record whose reason names its license."
+
+[files]
+filenames = ["package.json", "pyproject.toml"]
+
+[[tool]]
+name = "license-checker-rseidelsohn"
+version = "5.0.1"
+npm = "license-checker-rseidelsohn"
+version_exit_code = 1
+mise = "npm:license-checker-rseidelsohn"
+[[tool.replace]]
+file = ".license-checker.json"
+shared = false
+
+[[tool]]
+name = "pip-licenses"
+version = "5.5.5"
+pypi = "pip-licenses"
+mise = "pipx:pip-licenses"
+
+[[check]]
+name = "allowed"
+example = "An installed package whose reported license is outside licenses.allowed reports a finding for that exact package version. Replace it with an acceptable dependency, or write a [[licenses.allowed_package]] record with name, version, and a reason naming the license. A record for another version does not apply."
+level = "recommended"
+stage = "push"
+runs = "once"
+files = { filenames = ["package.json", "pyproject.toml"] }
+summary = "Compares the license every installed npm or Python package reports with the allowed list and the allowed-package records."
+why = "A license the project cannot accept arrives silently with a transitive dependency."
+help = "Replace the package, or write a [[licenses.allowed_package]] record by hand with its name, exact version, and a reason naming the license."

package/configurations/general/naming/defaults.json

@@ -0,0 +1,423 @@
+{
+    "groups": {
+        "containers": {
+            "terms": [
+                "core",
+                "common",
+                "generic",
+                "misc",
+                "stuff",
+                "thing",
+                "things",
+                "details",
+                "info",
+                "object",
+                "taxonomy",
+                "tmp",
+                "temp"
+            ]
+        },
+        "roles": {
+            "terms": [
+                "helper",
+                "helpers",
+                "util",
+                "utils",
+                "manager",
+                "handler",
+                "processor",
+                "wrapper",
+                "shim",
+                "shims",
+                "support"
+            ]
+        },
+        "marketing": {
+            "terms": [
+                "advanced",
+                "enhanced",
+                "improved",
+                "intelligent",
+                "smart",
+                "modern",
+                "robust",
+                "seamless",
+                "ultimate",
+                "comprehensive",
+                "optimized",
+                "reusable",
+                "custom",
+                "final",
+                "latest",
+                "old",
+                "new",
+                "legacy",
+                "plus",
+                "combined"
+            ]
+        },
+        "defensive": {
+            "terms": [
+                "ensure",
+                "maybe",
+                "likely",
+                "should",
+                "if needed",
+                "ifneeded",
+                "if available",
+                "ifavailable",
+                "if changed",
+                "ifchanged",
+                "if possible",
+                "ifpossible",
+                "or throw",
+                "orthrow",
+                "waitfor",
+                "with retries",
+                "transient",
+                "belt and suspenders",
+                "fallback",
+                "load bearing",
+                "load-bearing",
+                "loadbearing"
+            ]
+        },
+        "conjunctions": {
+            "terms": ["and", "or", "with", "when", "what", "whatever", "once", "plus"]
+        },
+        "tests": {
+            "terms": [
+                "test case",
+                "testcase",
+                "under test",
+                "undertest",
+                "edge case",
+                "edge cases",
+                "snapshot",
+                "snapshots",
+                "actual"
+            ]
+        },
+        "folders": {
+            "terms": ["common", "core", "helper", "helpers", "util", "utils", "support", "misc", "shared"]
+        }
+    },
+    "reserved": {
+        "config": [
+            "directories",
+            "packages",
+            "files",
+            "modules",
+            "variables",
+            "constants",
+            "parameters",
+            "properties",
+            "attributes",
+            "enum_cases"
+        ]
+    },
+    "languages": {
+        "typescript": {
+            "acronyms": "word",
+            "categories": {
+                "files": {
+                    "cases": ["kebab"]
+                },
+                "directories": {
+                    "cases": ["kebab"]
+                },
+                "types": {
+                    "cases": ["pascal"]
+                },
+                "classes": {
+                    "cases": ["pascal"]
+                },
+                "functions": {
+                    "cases": ["camel"]
+                },
+                "methods": {
+                    "cases": ["camel"]
+                },
+                "parameters": {
+                    "cases": ["camel"]
+                },
+                "variables": {
+                    "cases": ["camel", "upper-snake"]
+                },
+                "constants": {
+                    "cases": ["camel", "upper-snake"]
+                },
+                "properties": {
+                    "cases": ["camel", "upper-snake"]
+                },
+                "routes": {
+                    "cases": ["kebab"]
+                },
+                "path_parameters": {
+                    "cases": ["camel"]
+                },
+                "operation_ids": {
+                    "cases": ["camel"]
+                },
+                "enum_cases": {
+                    "cases": ["pascal", "camel"]
+                }
+            }
+        },
+        "javascript": {
+            "acronyms": "word",
+            "categories": {
+                "files": {
+                    "cases": ["kebab"]
+                },
+                "directories": {
+                    "cases": ["kebab"]
+                },
+                "types": {
+                    "cases": ["pascal"]
+                },
+                "classes": {
+                    "cases": ["pascal"]
+                },
+                "functions": {
+                    "cases": ["camel"]
+                },
+                "methods": {
+                    "cases": ["camel"]
+                },
+                "parameters": {
+                    "cases": ["camel"]
+                },
+                "variables": {
+                    "cases": ["camel", "upper-snake"]
+                },
+                "constants": {
+                    "cases": ["camel", "upper-snake"]
+                },
+                "properties": {
+                    "cases": ["camel", "upper-snake"]
+                },
+                "routes": {
+                    "cases": ["kebab"]
+                }
+            }
+        },
+        "python": {
+            "acronyms": "lower",
+            "categories": {
+                "files": {
+                    "cases": ["snake"]
+                },
+                "directories": {
+                    "cases": ["snake"]
+                },
+                "modules": {
+                    "cases": ["snake"]
+                },
+                "packages": {
+                    "cases": ["snake"]
+                },
+                "type_aliases": {
+                    "cases": ["pascal"]
+                },
+                "variables": {
+                    "cases": ["snake", "upper-snake"]
+                },
+                "constants": {
+                    "cases": ["upper-snake"]
+                },
+                "attributes": {
+                    "cases": ["snake", "upper-snake"]
+                },
+                "properties": {
+                    "cases": ["snake"]
+                }
+            }
+        },
+        "swift": {
+            "acronyms": "initialism",
+            "categories": {
+                "files": {
+                    "cases": ["pascal", "pascal-extension"]
+                },
+                "directories": {
+                    "cases": ["pascal"]
+                },
+                "functions": {
+                    "cases": ["camel"]
+                },
+                "methods": {
+                    "cases": ["camel"]
+                }
+            }
+        },
+        "bash": {
+            "acronyms": "lower",
+            "categories": {
+                "files": {
+                    "cases": ["kebab", "snake"]
+                },
+                "directories": {
+                    "cases": ["kebab", "snake"]
+                },
+                "functions": {
+                    "cases": ["snake"]
+                },
+                "variables": {
+                    "cases": ["snake", "upper-snake"]
+                },
+                "constants": {
+                    "cases": ["upper-snake"]
+                }
+            }
+        },
+        "sql": {
+            "acronyms": "lower",
+            "categories": {
+                "files": {
+                    "cases": ["timestamp-snake", "snake"]
+                },
+                "directories": {
+                    "cases": ["snake"]
+                },
+                "functions": {
+                    "cases": ["snake"]
+                },
+                "parameters": {
+                    "cases": ["snake"]
+                },
+                "schemas": {
+                    "cases": ["snake"]
+                },
+                "tables": {
+                    "cases": ["snake"]
+                },
+                "columns": {
+                    "cases": ["snake"]
+                },
+                "indexes": {
+                    "cases": ["snake"]
+                },
+                "triggers": {
+                    "cases": ["snake"]
+                },
+                "policies": {
+                    "cases": ["snake"]
+                }
+            }
+        }
+    },
+    "allowed_names": [
+        "setTimeout",
+        "clearTimeout",
+        "setInterval",
+        "clearInterval",
+        "setImmediate",
+        "queueMicrotask",
+        "structuredClone",
+        "URLSearchParams",
+        "console",
+        "document",
+        "window",
+        "navigator",
+        "localStorage",
+        "sessionStorage",
+        "CustomEvent",
+        "HTMLElement",
+        "XMLHttpRequest",
+        "toJSON",
+        "toString",
+        "valueOf",
+        "GET",
+        "POST",
+        "PUT",
+        "PATCH",
+        "DELETE",
+        "HEAD",
+        "OPTIONS",
+        "NODE_ENV",
+        "CI",
+        "HOME",
+        "PATH",
+        "PWD",
+        "TMPDIR",
+        "TERM",
+        "SHELL",
+        "USER",
+        "LANG",
+        "NO_COLOR",
+        "FORCE_COLOR",
+        "GITHUB_TOKEN",
+        "GITHUB_ACTIONS",
+        "GITHUB_SHA",
+        "GITHUB_REF"
+    ],
+    "allow_digits": false,
+    "allow_repeated_words": false,
+    "override": [
+        {
+            "paths": ["**"],
+            "categories": ["variables", "parameters"],
+            "reason": "Loop and lambda positions take single letters.",
+            "allowed_names": ["_", "i", "j", "k", "x", "y", "n"]
+        },
+        {
+            "paths": ["**"],
+            "categories": ["directories"],
+            "reason": "Tools name these directories.",
+            "allowed_names": ["node_modules", "__pycache__", "__tests__", "__mocks__"]
+        },
+        {
+            "paths": ["**"],
+            "languages": ["typescript", "javascript"],
+            "categories": ["parameters", "variables"],
+            "ignored_prefix": "^_+"
+        },
+        {
+            "paths": ["**/.githooks/**", "**/.gspot/hooks/**", "**/.husky/**", "**/hooks/**"],
+            "categories": ["files"],
+            "reason": "git names its hooks.",
+            "allowed_names": [
+                "pre-commit",
+                "pre-push",
+                "commit-msg",
+                "post-checkout",
+                "post-merge",
+                "pre-rebase",
+                "prepare-commit-msg"
+            ]
+        },
+        {
+            "paths": ["**/e2e/**"],
+            "categories": ["directories", "files"],
+            "allow_digits": true
+        },
+        {
+            "paths": ["**/migrations/**"],
+            "categories": ["files"],
+            "allow_digits": true
+        }
+    ],
+    "path_containers": [
+        {
+            "open": "[",
+            "close": "]",
+            "category": "path_parameters"
+        },
+        {
+            "open": "(",
+            "close": ")",
+            "category": "directories"
+        },
+        {
+            "open": "@",
+            "close": "",
+            "category": "directories"
+        },
+        {
+            "open": "_",
+            "close": "",
+            "category": "directories"
+        }
+    ]
+}