@fabriziosalmi/slopless 1.13.1 → 1.15.0

package/README.md

@@ -6,7 +6,7 @@ Slopless is a static analysis tool designed to identify and mitigate unstructure
 
 ## Architecture and Capabilities
 
-- **Rule Engine**: 150 rigorous rules spanning security, maintainability, accessibility, and documentation integrity. Every rule ships executable examples — a snippet it must flag and one it must leave alone — run on every commit.
+- **Rule Engine**: 152 rigorous rules spanning security, maintainability, accessibility, and documentation integrity. Every rule ships executable examples — a snippet it must flag and one it must leave alone — run on every commit.
 - **AST Inspection**: Deep structural validation to identify excessive cyclomatic complexity, parameter limits, and empty control flow blocks.
 - **Deep Semantic Validation**: Opt-in TypeScript TypeChecker (`--type-check`) for resolving inherited types, identifying floating promises, and validating structural intent beyond AST boundaries.
 - **Heuristic Auto-Fixes**: Autonomous modification of known anti-patterns (e.g., `var` to `let`) using `--fix`.
@@ -14,7 +14,7 @@ Slopless is a static analysis tool designed to identify and mitigate unstructure
 - **Lexical Scoping**: Every string, comment and regular expression literal is mapped before a rule reads a byte — with the TypeScript scanner where it can, and a declarative tokeniser for Python, Go, Rust, shell, Java, C, C++, C#, Kotlin, Swift and Ruby. Each rule declares what it looks at (`code`, `strings`, `comments`, `regex`, `all`). A rule about `eval()` stays quiet inside a comment; a rule about insecure URLs does not read the pattern that validates them; a Python docstring is documentation rather than a string value.
 - **Exceptions That Say Why**: A rule can skip test code that lives inside the file it tests (`#[cfg(test)] mod tests`), skip documentation comments in languages that mandate them, and be excused by name on one line with `// slopless-disable-next-line VBC-001 -- reason`. A project can claim its own vocabulary, so `blacklist` in a firewall is the domain rather than a finding — and the run reports how many findings that excused.
 - **Rule Precedence**: A specific rule declares the general ones it `supersedes`, so a single `// TODO: implement this` produces one finding, not four.
-- **LSP IDE Integration**: Ships with `vscode-slopless` for real-time Squiggly-Line diagnostics inside VS Code and Cursor.
+- **In the editor, and while writing**: [`packages/vscode-slopless`](packages/vscode-slopless) is a language server and a Slopless panel — diagnostics as you type, and a list of what the rules found across the workspace, ordered errors first. Build the `.vsix` and install it; it is not on the Marketplace. [`packages/mcp-slopless`](packages/mcp-slopless) is an MCP server, so a coding agent can check a buffer *before* it writes the file rather than after the commit. Both run the same engine and the same rules as the CLI.
 
 ## GitHub Action
 
@@ -123,32 +123,32 @@ count, written from the rules rather than from memory:
 <!-- coverage:start -->
 | language | rules |
 | --- | --- |
-| TypeScript (JSX) (`.tsx`) | 97 of 150 |
-| TypeScript (`.ts`) | 95 of 150 |
-| JavaScript (`.js`) | 94 of 150 |
-| Astro (`.astro`) | 83 of 150 |
-| Python (`.py`) | 32 of 150 |
-| JavaScript (JSX) (`.jsx`) | 31 of 150 |
-| Markdown (`.md`) | 26 of 150 |
-| CSS (`.css`) | 23 of 150 |
-| HTML (`.html`) | 21 of 150 |
-| Go (`.go`) | 19 of 150 |
-| Plain text (`.txt`) | 18 of 150 |
-| Shell (`.sh`) | 16 of 150 |
-| Java (`.java`) | 15 of 150 |
-| Rust (`.rs`) | 15 of 150 |
-| Sass (SCSS) (`.scss`) | 15 of 150 |
-| Ruby (`.rb`) | 14 of 150 |
-| C# (`.cs`) | 13 of 150 |
-| C (`.c`) | 12 of 150 |
-| C++ (`.cpp`) | 12 of 150 |
-| Kotlin (`.kt`) | 12 of 150 |
-| Swift (`.swift`) | 12 of 150 |
-| Less (`.less`) | 9 of 150 |
-| JSON (`.json`) | 5 of 150 |
-| PHP (`.php`) | 5 of 150 |
-| Dotenv (`.env`) | 4 of 150 |
-| YAML (`.yaml`) | 3 of 150 |
+| TypeScript (JSX) (`.tsx`) | 98 of 152 |
+| TypeScript (`.ts`) | 96 of 152 |
+| JavaScript (`.js`) | 95 of 152 |
+| Astro (`.astro`) | 84 of 152 |
+| JavaScript (JSX) (`.jsx`) | 32 of 152 |
+| Python (`.py`) | 32 of 152 |
+| Markdown (`.md`) | 26 of 152 |
+| CSS (`.css`) | 23 of 152 |
+| HTML (`.html`) | 21 of 152 |
+| Go (`.go`) | 19 of 152 |
+| Plain text (`.txt`) | 18 of 152 |
+| Shell (`.sh`) | 16 of 152 |
+| Java (`.java`) | 15 of 152 |
+| Rust (`.rs`) | 15 of 152 |
+| Sass (SCSS) (`.scss`) | 15 of 152 |
+| Ruby (`.rb`) | 14 of 152 |
+| C# (`.cs`) | 13 of 152 |
+| C (`.c`) | 12 of 152 |
+| C++ (`.cpp`) | 12 of 152 |
+| Kotlin (`.kt`) | 12 of 152 |
+| Swift (`.swift`) | 12 of 152 |
+| Less (`.less`) | 9 of 152 |
+| JSON (`.json`) | 5 of 152 |
+| PHP (`.php`) | 5 of 152 |
+| Dotenv (`.env`) | 4 of 152 |
+| YAML (`.yaml`) | 3 of 152 |
 <!-- coverage:end -->
 
 The parsing tiers use the TypeScript compiler, so the AST, semantic-naming and
@@ -169,7 +169,7 @@ None of them has an opinion about a section that says "coming soon".
 - **Documentation**: Detection of generated filler content, non-inclusive language, and broken external references.
 
 Full documentation at [fabriziosalmi.github.io/slopless](https://fabriziosalmi.github.io/slopless/):
-[all 150 rules](https://fabriziosalmi.github.io/slopless/rules/) ·
+[all 152 rules](https://fabriziosalmi.github.io/slopless/rules/) ·
 [configuration](https://fabriziosalmi.github.io/slopless/configuration) ·
 [writing a rule](https://fabriziosalmi.github.io/slopless/writing-a-rule) ·
 [the scanner bug story](https://fabriziosalmi.github.io/slopless/story)

package/dist/engine/api.d.ts

@@ -11,6 +11,74 @@ interface Violation {
     };
 }
 
+/**
+ * The rules a run would use: what is on disk, plus whatever the config adds,
+ * with severities overridden, rules turned off removed, and opt-in rules kept
+ * only when the config asked for them.
+ *
+ * Exported because anything that lists rules — an editor panel, an MCP tool —
+ * has to list the same ones the linter runs, and rebuilding that set somewhere
+ * else is how the two drift apart.
+ */
+declare function resolveRules(configPath?: string): {
+    id: string;
+    name: string;
+    category: string;
+    severity: "error" | "warning";
+    match: {
+        regex?: string | undefined;
+        flags?: string | undefined;
+        file_types?: string[] | undefined;
+        scan?: "regex" | "code" | "strings" | "comments" | "all" | undefined;
+        multiline?: boolean | undefined;
+        exclude_files?: string[] | undefined;
+        exclude_selectors?: string[] | undefined;
+        require_selectors?: string[] | undefined;
+        variants?: {
+            file_types: string[];
+            regex: string;
+            flags?: string | undefined;
+            scan?: "regex" | "code" | "strings" | "comments" | "all" | undefined;
+            multiline?: boolean | undefined;
+            message?: string | undefined;
+        }[] | undefined;
+        exclude_test_code?: boolean | undefined;
+        exclude_doc_comments?: boolean | undefined;
+        git_check?: "committed_env" | "private_key" | "binary_file" | "node_modules" | "commit_message_too_short" | "missing_gitignore" | "missing_license" | "missing_readme" | "spaces_in_filenames" | "too_many_staged_files" | "filename_too_long" | "large_file_size" | "committed_ide_settings" | "missing_contributing" | "missing_security" | "missing_changelog" | undefined;
+        ast_check?: {
+            type: "function-params-limit" | "function-length-limit" | "file-length-limit" | "empty-catch" | "nested-blocks-limit" | "empty-block" | "one-liner-limit" | "redundant-if-true" | "lying-function-names" | "empty-interface" | "async-without-await" | "empty-file";
+            threshold?: number | undefined;
+        } | undefined;
+        heuristic_check?: "link-checker" | "stale-copyright-year" | undefined;
+        semantic_check?: "boolean-naming" | "boolean-redundancy" | "collection-suffix" | "semantic-shadowing" | undefined;
+        type_check?: "floating-promise" | undefined;
+        threshold?: number | undefined;
+    };
+    message: string;
+    tags?: string[] | undefined;
+    fix?: {
+        regex_replace?: {
+            pattern: string;
+            replacement: string;
+        } | undefined;
+    } | undefined;
+    supersedes?: string[] | undefined;
+    opt_in?: boolean | undefined;
+    tests?: {
+        fire?: (string | {
+            code: string;
+            file?: string | undefined;
+            repeat?: number | undefined;
+        })[] | undefined;
+        quiet?: (string | {
+            code: string;
+            file?: string | undefined;
+            repeat?: number | undefined;
+        })[] | undefined;
+        external?: string | undefined;
+    } | undefined;
+    docs_url?: string | undefined;
+}[];
 declare function lintText(content: string, filePath: string, configPath?: string): Promise<Violation[]>;
 
-export { lintText };
+export { lintText, resolveRules };