@fabriziosalmi/slopless 1.17.0 → 1.17.2

package/dist/engine/api.d.ts

@@ -13,6 +13,29 @@ interface Violation {
     };
 }
 
+interface SloplessConfig {
+    rules?: Record<string, 'error' | 'warning' | 'off'>;
+    ignore?: string[];
+    customRulesPaths?: string[];
+    typeCheck?: boolean;
+    /**
+     * Words that are this project's domain rather than slop. `blacklist` in a
+     * firewall, `master` on an audio bus. Applies to every rule, and the run
+     * reports how many findings it excused.
+     */
+    vocabulary?: string[];
+}
+/**
+ * Where a config path resolves to, whether or not anything is there.
+ *
+ * Separate from `loadConfig` because a relative `customRulesPaths` entry means
+ * "relative to the config that named it". Resolving those against
+ * `process.cwd()` is right for the CLI and wrong everywhere else: an editor does
+ * not run in the directory it is checking.
+ */
+declare function configLocation(configPath?: string): string;
+declare function loadConfig(configPath?: string): SloplessConfig;
+
 /**
  * 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
@@ -47,6 +70,7 @@ declare function resolveRules(configPath?: string): {
         exclude_test_code?: boolean | undefined;
         exclude_programs?: boolean | undefined;
         exclude_doc_comments?: boolean | undefined;
+        exclude_markdown_code?: 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";
@@ -84,4 +108,4 @@ declare function resolveRules(configPath?: string): {
 }[];
 declare function lintText(content: string, filePath: string, configPath?: string): Promise<Violation[]>;
 
-export { lintText, resolveRules };
+export { type SloplessConfig, configLocation, lintText, loadConfig, resolveRules };