@fyuld/snitch 1.6.0 → 2.0.0

package/snitchconfig.schema.json

@@ -0,0 +1,151 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Snitch Configuration",
+  "description": "Configuration file for Snitch code quality policies",
+  "type": "object",
+  "properties": {
+    "extends": {
+      "type": "string",
+      "description": "Base configuration to extend from"
+    },
+    "sourceDirectory": {
+      "type": "string",
+      "description": "Directory containing source code to analyze"
+    },
+    "testsDirectory": {
+      "type": "string",
+      "description": "Directory containing test files"
+    },
+    "policies": {
+      "type": "object",
+      "description": "Policy definitions with provider pipelines",
+      "additionalProperties": {
+        "$ref": "#/definitions/Policy"
+      }
+    }
+  },
+  "required": ["sourceDirectory", "testsDirectory", "policies"],
+  "additionalProperties": false,
+  "definitions": {
+    "Policy": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "Human-readable policy title"
+        },
+        "violations": {
+          "type": "array",
+          "description": "Violation rules for this policy",
+          "items": {
+            "$ref": "#/definitions/ViolationRule"
+          }
+        }
+      },
+      "required": ["title", "violations"],
+      "additionalProperties": false
+    },
+    "ViolationRule": {
+      "type": "object",
+      "properties": {
+        "message": {
+          "type": "string",
+          "description": "Violation message template with placeholders"
+        },
+        "cause": {
+          "type": "string",
+          "description": "Cause description template with placeholders"
+        },
+        "providers": {
+          "type": "array",
+          "description": "Provider pipeline for detecting violations",
+          "items": {
+            "$ref": "#/definitions/ProviderConfig"
+          }
+        }
+      },
+      "required": ["message", "cause", "providers"],
+      "additionalProperties": false
+    },
+    "ProviderConfig": {
+      "oneOf": [
+        { "$ref": "#/definitions/IdentityProvider" },
+        { "$ref": "#/definitions/FilterByFileProvider" },
+        { "$ref": "#/definitions/FilterExcludeFunctionNamesProvider" },
+        { "$ref": "#/definitions/FilterHasLiteralArgumentsProvider" },
+        { "$ref": "#/definitions/FilterByDeclarationTypeProvider" }
+      ]
+    },
+    "IdentityProvider": {
+      "type": "object",
+      "properties": {
+        "type": { "const": "identity" },
+        "source": {
+          "enum": [
+            "functionInvocations",
+            "literals",
+            "declarations",
+            "typeDeclarations",
+            "topLevelFunctions",
+            "exports",
+            "sequentialGroups"
+          ]
+        }
+      },
+      "required": ["type", "source"],
+      "additionalProperties": false
+    },
+    "FilterByFileProvider": {
+      "type": "object",
+      "properties": {
+        "type": { "const": "filter-by-file" },
+        "patterns": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      },
+      "required": ["type", "patterns"],
+      "additionalProperties": false
+    },
+    "FilterExcludeFunctionNamesProvider": {
+      "type": "object",
+      "properties": {
+        "type": { "const": "filter-exclude-function-names" },
+        "names": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      },
+      "required": ["type", "names"],
+      "additionalProperties": false
+    },
+    "FilterHasLiteralArgumentsProvider": {
+      "type": "object",
+      "properties": {
+        "type": { "const": "filter-has-literal-arguments" },
+        "literalKinds": {
+          "type": "array",
+          "items": {
+            "enum": ["string", "number", "boolean", "null", "object", "array"]
+          }
+        }
+      },
+      "required": ["type", "literalKinds"],
+      "additionalProperties": false
+    },
+    "FilterByDeclarationTypeProvider": {
+      "type": "object",
+      "properties": {
+        "type": { "const": "filter-by-declaration-type" },
+        "declarationTypes": {
+          "type": "array",
+          "items": {
+            "enum": ["interface", "type", "enum", "class", "function", "const", "let", "var"]
+          }
+        }
+      },
+      "required": ["type", "declarationTypes"],
+      "additionalProperties": false
+    }
+  }
+}

package/dist/commands/badimports.d.ts

@@ -1,2 +0,0 @@
-export declare function badimportsCommand(sourceDirectory: string): Promise<void>;
-//# sourceMappingURL=badimports.d.ts.map

package/dist/commands/badimports.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"badimports.d.ts","sourceRoot":"","sources":["../../src/commands/badimports.ts"],"names":[],"mappings":"AAEA,wBAAsB,iBAAiB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE9E"}

package/dist/commands/badimports.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.badimportsCommand = badimportsCommand;
-const scan_1 = require("./scan");
-async function badimportsCommand(sourceDirectory) {
-    await (0, scan_1.scanCommand)(["badimports", sourceDirectory]);
-}
-//# sourceMappingURL=badimports.js.map

package/dist/commands/badimports.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"badimports.js","sourceRoot":"","sources":["../../src/commands/badimports.ts"],"names":[],"mappings":";;AAEA,8CAEC;AAJD,iCAAqC;AAE9B,KAAK,UAAU,iBAAiB,CAAC,eAAuB;IAC7D,MAAM,IAAA,kBAAW,EAAC,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;AACrD,CAAC"}

package/dist/commands/dirtydefaults.d.ts

@@ -1,2 +0,0 @@
-export declare function dirtydefaultsCommand(sourceDirectory: string): Promise<void>;
-//# sourceMappingURL=dirtydefaults.d.ts.map

package/dist/commands/dirtydefaults.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dirtydefaults.d.ts","sourceRoot":"","sources":["../../src/commands/dirtydefaults.ts"],"names":[],"mappings":"AAEA,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC,CAEf"}

package/dist/commands/dirtydefaults.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dirtydefaultsCommand = dirtydefaultsCommand;
-const scan_1 = require("./scan");
-async function dirtydefaultsCommand(sourceDirectory) {
-    await (0, scan_1.scanCommand)(['dirtydefaults', sourceDirectory]);
-}
-//# sourceMappingURL=dirtydefaults.js.map

package/dist/commands/dirtydefaults.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"dirtydefaults.js","sourceRoot":"","sources":["../../src/commands/dirtydefaults.ts"],"names":[],"mappings":";;AAEA,oDAIC;AAND,iCAAoC;AAE7B,KAAK,UAAU,oBAAoB,CACxC,eAAuB;IAEvB,MAAM,IAAA,kBAAW,EAAC,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC,CAAA;AACvD,CAAC"}

package/dist/commands/enumerate.d.ts

@@ -1,2 +0,0 @@
-export declare function enumerateCommand(sourceDirectory: string): Promise<void>;
-//# sourceMappingURL=enumerate.d.ts.map

package/dist/commands/enumerate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"enumerate.d.ts","sourceRoot":"","sources":["../../src/commands/enumerate.ts"],"names":[],"mappings":"AAEA,wBAAsB,gBAAgB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE7E"}

package/dist/commands/enumerate.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.enumerateCommand = enumerateCommand;
-const scan_1 = require("./scan");
-async function enumerateCommand(sourceDirectory) {
-    await (0, scan_1.scanCommand)(["enumerate", sourceDirectory]);
-}
-//# sourceMappingURL=enumerate.js.map

package/dist/commands/enumerate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"enumerate.js","sourceRoot":"","sources":["../../src/commands/enumerate.ts"],"names":[],"mappings":";;AAEA,4CAEC;AAJD,iCAAqC;AAE9B,KAAK,UAAU,gBAAgB,CAAC,eAAuB;IAC5D,MAAM,IAAA,kBAAW,EAAC,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;AACpD,CAAC"}

package/dist/commands/expectmagic.d.ts

@@ -1,2 +0,0 @@
-export declare function expectmagicCommand(sourceDirectory: string): Promise<void>;
-//# sourceMappingURL=expectmagic.d.ts.map

package/dist/commands/expectmagic.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"expectmagic.d.ts","sourceRoot":"","sources":["../../src/commands/expectmagic.ts"],"names":[],"mappings":"AAEA,wBAAsB,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/E"}

package/dist/commands/expectmagic.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.expectmagicCommand = expectmagicCommand;
-const scan_1 = require("./scan");
-async function expectmagicCommand(sourceDirectory) {
-    await (0, scan_1.scanCommand)(["expectmagic", sourceDirectory]);
-}
-//# sourceMappingURL=expectmagic.js.map

package/dist/commands/expectmagic.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"expectmagic.js","sourceRoot":"","sources":["../../src/commands/expectmagic.ts"],"names":[],"mappings":";;AAEA,gDAEC;AAJD,iCAAqC;AAE9B,KAAK,UAAU,kBAAkB,CAAC,eAAuB;IAC9D,MAAM,IAAA,kBAAW,EAAC,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC,CAAC;AACtD,CAAC"}

package/dist/commands/fixtures.d.ts

@@ -1,2 +0,0 @@
-export declare function fixturesCommand(sourceDirectory: string): Promise<void>;
-//# sourceMappingURL=fixtures.d.ts.map

package/dist/commands/fixtures.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../../src/commands/fixtures.ts"],"names":[],"mappings":"AAEA,wBAAsB,eAAe,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE5E"}

package/dist/commands/fixtures.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fixturesCommand = fixturesCommand;
-const scan_1 = require("./scan");
-async function fixturesCommand(sourceDirectory) {
-    await (0, scan_1.scanCommand)(["fixtures", sourceDirectory]);
-}
-//# sourceMappingURL=fixtures.js.map

package/dist/commands/fixtures.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fixtures.js","sourceRoot":"","sources":["../../src/commands/fixtures.ts"],"names":[],"mappings":";;AAEA,0CAEC;AAJD,iCAAqC;AAE9B,KAAK,UAAU,eAAe,CAAC,eAAuB;IAC3D,MAAM,IAAA,kBAAW,EAAC,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC;AACnD,CAAC"}

package/dist/datamodel.d.ts

@@ -1,18 +0,0 @@
-export declare enum TypeScriptTypeKind {
-    Type = "type",
-    Enum = "enum",
-    Interface = "interface",
-    Class = "class"
-}
-export declare enum SnitchCommands {
-    Init = "init",
-    Scan = "scan",
-    Dirtydefaults = "dirtydefaults",
-    Dm = "dm",
-    Expectmagic = "expectmagic",
-    Fixtures = "fixtures",
-    Enumerate = "enumerate",
-    Badimports = "badimports",
-    Vocab = "vocab"
-}
-//# sourceMappingURL=datamodel.d.ts.map

package/dist/datamodel.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"datamodel.d.ts","sourceRoot":"","sources":["../src/datamodel.ts"],"names":[],"mappings":"AAAA,oBAAY,kBAAkB;IAC5B,IAAI,SAAS;IACb,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED,oBAAY,cAAc;IACxB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,aAAa,kBAAkB;IAC/B,EAAE,OAAO;IACT,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,KAAK,UAAU;CAChB"}

package/dist/datamodel.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SnitchCommands = exports.TypeScriptTypeKind = void 0;
-var TypeScriptTypeKind;
-(function (TypeScriptTypeKind) {
-    TypeScriptTypeKind["Type"] = "type";
-    TypeScriptTypeKind["Enum"] = "enum";
-    TypeScriptTypeKind["Interface"] = "interface";
-    TypeScriptTypeKind["Class"] = "class";
-})(TypeScriptTypeKind || (exports.TypeScriptTypeKind = TypeScriptTypeKind = {}));
-var SnitchCommands;
-(function (SnitchCommands) {
-    SnitchCommands["Init"] = "init";
-    SnitchCommands["Scan"] = "scan";
-    SnitchCommands["Dirtydefaults"] = "dirtydefaults";
-    SnitchCommands["Dm"] = "dm";
-    SnitchCommands["Expectmagic"] = "expectmagic";
-    SnitchCommands["Fixtures"] = "fixtures";
-    SnitchCommands["Enumerate"] = "enumerate";
-    SnitchCommands["Badimports"] = "badimports";
-    SnitchCommands["Vocab"] = "vocab";
-})(SnitchCommands || (exports.SnitchCommands = SnitchCommands = {}));
-//# sourceMappingURL=datamodel.js.map

package/dist/datamodel.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"datamodel.js","sourceRoot":"","sources":["../src/datamodel.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,mCAAa,CAAA;IACb,6CAAuB,CAAA;IACvB,qCAAe,CAAA;AACjB,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AAED,IAAY,cAUX;AAVD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,+BAAa,CAAA;IACb,iDAA+B,CAAA;IAC/B,2BAAS,CAAA;IACT,6CAA2B,CAAA;IAC3B,uCAAqB,CAAA;IACrB,yCAAuB,CAAA;IACvB,2CAAyB,CAAA;IACzB,iCAAe,CAAA;AACjB,CAAC,EAVW,cAAc,8BAAd,cAAc,QAUzB"}