@fabriziosalmi/slopless 1.4.1

package/dist/index.d.ts

@@ -0,0 +1,122 @@
+#!/usr/bin/env node
+import { z } from 'zod';
+
+declare const RuleSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    category: z.ZodString;
+    severity: z.ZodEnum<{
+        error: "error";
+        warning: "warning";
+    }>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    match: z.ZodObject<{
+        regex: z.ZodOptional<z.ZodString>;
+        flags: z.ZodOptional<z.ZodString>;
+        file_types: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        scan: z.ZodOptional<z.ZodEnum<{
+            code: "code";
+            strings: "strings";
+            comments: "comments";
+            all: "all";
+        }>>;
+        multiline: z.ZodOptional<z.ZodBoolean>;
+        exclude_files: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        exclude_selectors: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        git_check: z.ZodOptional<z.ZodEnum<{
+            committed_env: "committed_env";
+            binary_file: "binary_file";
+            node_modules: "node_modules";
+            commit_message_too_short: "commit_message_too_short";
+            missing_gitignore: "missing_gitignore";
+            missing_license: "missing_license";
+            missing_readme: "missing_readme";
+            spaces_in_filenames: "spaces_in_filenames";
+            too_many_staged_files: "too_many_staged_files";
+            filename_too_long: "filename_too_long";
+            large_file_size: "large_file_size";
+            committed_ide_settings: "committed_ide_settings";
+            missing_contributing: "missing_contributing";
+            missing_security: "missing_security";
+            missing_changelog: "missing_changelog";
+        }>>;
+        ast_check: z.ZodOptional<z.ZodObject<{
+            type: z.ZodEnum<{
+                "function-params-limit": "function-params-limit";
+                "function-length-limit": "function-length-limit";
+                "file-length-limit": "file-length-limit";
+                "empty-catch": "empty-catch";
+                "nested-blocks-limit": "nested-blocks-limit";
+                "empty-block": "empty-block";
+                "one-liner-limit": "one-liner-limit";
+                "redundant-if-true": "redundant-if-true";
+                "lying-function-names": "lying-function-names";
+                "empty-interface": "empty-interface";
+                "async-without-await": "async-without-await";
+                "empty-file": "empty-file";
+            }>;
+            threshold: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        heuristic_check: z.ZodOptional<z.ZodEnum<{
+            "link-checker": "link-checker";
+            "circular-dependency": "circular-dependency";
+            "stale-copyright-year": "stale-copyright-year";
+        }>>;
+        semantic_check: z.ZodOptional<z.ZodEnum<{
+            "boolean-naming": "boolean-naming";
+            "boolean-redundancy": "boolean-redundancy";
+            "collection-suffix": "collection-suffix";
+            "semantic-shadowing": "semantic-shadowing";
+        }>>;
+        type_check: z.ZodOptional<z.ZodEnum<{
+            "floating-promise": "floating-promise";
+        }>>;
+        threshold: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+    fix: z.ZodOptional<z.ZodObject<{
+        regex_replace: z.ZodOptional<z.ZodObject<{
+            pattern: z.ZodString;
+            replacement: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    supersedes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    opt_in: z.ZodOptional<z.ZodBoolean>;
+    tests: z.ZodOptional<z.ZodObject<{
+        fire: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            file: z.ZodOptional<z.ZodString>;
+            code: z.ZodString;
+            repeat: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>]>>>;
+        quiet: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            file: z.ZodOptional<z.ZodString>;
+            code: z.ZodString;
+            repeat: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>]>>>;
+        external: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    message: z.ZodString;
+    docs_url: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type Rule = z.infer<typeof RuleSchema>;
+
+/**
+ * `ignore` only accepts paths relative to the working directory and throws on
+ * anything else, so an absolute path on the command line crashed the whole run.
+ * Paths outside the project cannot be matched by a .sloplessignore rule at all,
+ * so they pass through untouched.
+ */
+declare function applyIgnoreRules(files: string[], configIgnore?: string[]): string[];
+/**
+ * Narrows the rule set before anything runs.
+ *
+ * Across ten instrumented repositories the tool reported 4754 findings, of which
+ * 9 were security and 101 were errors of any kind. Everything a person installs
+ * this for was buried under style. Selecting up front is cheaper than reading
+ * past it, and cheaper than running the rules at all.
+ */
+declare function selectRules(rules: Rule[], options: {
+    only?: string;
+    minSeverity?: string;
+}): Rule[];
+
+export { applyIgnoreRules, selectRules };