@secretlint/types - npm Package Compare versions

Comparing version 4.2.0 to 5.0.0

lib/index.d.ts

@@ -1,2 +0,2 @@
-export { SecretLintCoreIgnoreDescriptor, SecretLintCoreReportDescriptor, SecretLintCoreIgnoreMessage, SecretLintCoreResult, SecretLintCoreResultMessage, SecretLintCoreDescriptor, SecretLintRuleModule, SecretLintUnionRuleCreator, SecretLintCoreDescriptorUnionRule, SecretLintCoreDescriptorRule, SecretLintCoreDescriptorRulePreset, } from "./SecretLintCore";
+export { SecretLintCoreIgnoreDescriptor, SecretLintCoreReportDescriptor, SecretLintCoreIgnoreMessage, SecretLintCoreResult, SecretLintCoreResultMessage, SecretLintCoreConfig, SecretLintRuleModule, SecretLintUnionRuleCreator, SecretLintCoreConfigUnionRule, SecretLintCoreConfigRule, SecretLintCoreConfigRulePreset, } from "./SecretLintCore";
 export { SecretlintCoreSharedOptions } from "./SecretlintCoreSharedOptions";
@@ -3,0 +3,0 @@ export { SecretLintRuleSeverityLevel } from "./SecretLintRuleSeverityLevel";

lib/SecretLintConfigDescriptor.d.ts

@@ -1,3 +0,3 @@
-import { SecretLintRuleCreator, SecretLintRuleCreatorOptions } from "./SecretLintRule";
-import { SecretLintRulePresetCreator, SecretLintRulePresetCreatorOptions } from "./SecretLintRulePreset";
+import { SecretLintRuleCreatorOptions } from "./SecretLintRule";
+import { SecretLintRulePresetCreatorOptions } from "./SecretLintRulePreset";
 import { SecretLintRuleSeverityLevel } from "./SecretLintRuleSeverityLevel";
@@ -35,7 +35,2 @@ import { SecretlintCoreSharedOptions } from "./SecretlintCoreSharedOptions";
     severity?: SecretLintRuleSeverityLevel;
-    /**
-     * FOR DEBUG
-     * Rule instance
-     */
-    rule?: SecretLintRuleCreator<Options>;
 };
@@ -72,7 +67,2 @@ export declare type SecretLintConfigDescriptorRulePreset<Options = SecretLintRulePresetCreatorOptions> = {
     rules?: SecretLintConfigDescriptorRule[];
-    /**
-     * FOR DEBUG
-     * Rule instance
-     */
-    rule?: SecretLintRulePresetCreator<Options>;
 };
@@ -79,0 +69,0 @@ /**

lib/SecretLintCore.d.ts

@@ -6,3 +6,3 @@ import { SecretLintRuleIgnoreDescriptor, SecretLintRuleReportDescriptor, SecretLintRuleCreator, SecretLintRuleCreatorOptions } from "./SecretLintRule";
 import { SecretlintCoreSharedOptions } from "./SecretlintCoreSharedOptions";
-export declare type SecretLintCoreDescriptorRule<Options = SecretLintRuleCreatorOptions> = {
+export declare type SecretLintCoreConfigRule<Options = SecretLintRuleCreatorOptions> = {
     /**
@@ -38,3 +38,3 @@ * Rule id that is package name or shorten package name
 };
-export declare type SecretLintCoreDescriptorRulePreset<Options = SecretLintRulePresetCreatorOptions> = {
+export declare type SecretLintCoreConfigRulePreset<Options = SecretLintRulePresetCreatorOptions> = {
     /**
@@ -52,3 +52,3 @@ * Rule id that is package name or shorten package name
      */
-    rules?: SecretLintCoreDescriptorRule[];
+    rules?: Omit<SecretLintCoreConfigRule, "rule">[];
     /**
@@ -66,9 +66,14 @@ * Rule options
 export declare type SecretLintUnionRuleCreator<Options = SecretLintRuleCreatorOptions | SecretLintRulePresetCreatorOptions> = SecretLintRuleCreator<Options> | SecretLintRulePresetCreator<Options>;
-export declare type SecretLintCoreDescriptorUnionRule<Options = SecretLintRuleCreatorOptions | SecretLintRulePresetCreatorOptions> = SecretLintCoreDescriptorRule<Options> | SecretLintCoreDescriptorRulePreset<Options>;
+export declare type SecretLintCoreConfigUnionRule<Options = SecretLintRuleCreatorOptions | SecretLintRulePresetCreatorOptions> = SecretLintCoreConfigRule<Options> | SecretLintCoreConfigRulePreset<Options>;
 export declare type SecretLintRuleModule = {
     creator: SecretLintUnionRuleCreator;
 };
-export declare type SecretLintCoreDescriptor = {
+/**
+ * Loaded Config Object
+ * - Config: Full
+ * - ConfigDescriptor: Partial
+ */
+export declare type SecretLintCoreConfig = {
     sharedOptions?: SecretlintCoreSharedOptions;
-    rules: SecretLintCoreDescriptorUnionRule[];
+    rules: SecretLintCoreConfigUnionRule[];
 };
@@ -75,0 +80,0 @@ export declare type SecretLintCoreResult = {

lib/SecretLintRulePreset.d.ts

@@ -1,2 +0,2 @@
-import { SecretLintCoreDescriptorRule } from "./SecretLintCore";
+import { SecretLintCoreConfigRule } from "./SecretLintCore";
 import { SecretLintRuleCreator, SecretLintRuleCreatorOptions } from "./SecretLintRule";
@@ -6,3 +6,3 @@ import { SecretlintCoreSharedOptions } from "./SecretlintCoreSharedOptions";
     sharedOptions: SecretlintCoreSharedOptions;
-    registerRule<Options = SecretLintRuleCreatorOptions>(rule: SecretLintRuleCreator<Options>, defaultValue?: Omit<SecretLintCoreDescriptorRule<Options>, "id" | "rule">): void;
+    registerRule<Options = SecretLintRuleCreatorOptions>(rule: SecretLintRuleCreator<Options>, defaultValue?: Omit<SecretLintCoreConfigRule<Options>, "id" | "rule">): void;
 };
@@ -19,3 +19,4 @@ export declare type SecretLintRulePresetCreatorOptions = {};
     };
+    rules: SecretLintRuleCreator<unknown>[];
     create(context: SecretLintRulePresetContext, options: Options): void;
 };

package.json

 {
     "name": "@secretlint/types",
-    "version": "4.2.0",
+    "version": "5.0.0",
     "description": "A typing package for @secretlint",
@@ -44,3 +44,3 @@ "keywords": [
         "@types/mocha": "^9.0.0",
-        "@types/node": "^16.9.1",
+        "@types/node": "^17.0.21",
         "mocha": "^9.0.1",
@@ -51,7 +51,7 @@ "prettier": "^2.3.1",
         "ts-node-test-register": "^10.0.0",
-        "tsd": "^0.17.0",
+        "tsd": "^0.19.1",
         "typescript": "^4.3.4"
     },
     "engines": {
-        "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+        "node": "^14.13.1 || >=16.0.0"
     },
@@ -61,3 +61,3 @@ "publishConfig": {
     },
-    "gitHead": "7879c01d93ae5932822c2864e9bb51e7a6627f0f"
+    "gitHead": "4c1b6508b78a3c1f3e9175a8b36e56caa369a302"
 }

src/index.ts

@@ -8,9 +8,9 @@ // Core Interface
     SecretLintCoreResultMessage,
-    SecretLintCoreDescriptor,
+    SecretLintCoreConfig,
     SecretLintRuleModule,
     // union
     SecretLintUnionRuleCreator,
-    SecretLintCoreDescriptorUnionRule,
-    SecretLintCoreDescriptorRule,
-    SecretLintCoreDescriptorRulePreset,
+    SecretLintCoreConfigUnionRule,
+    SecretLintCoreConfigRule,
+    SecretLintCoreConfigRulePreset,
 } from "./SecretLintCore";
@@ -17,0 +17,0 @@ export { SecretlintCoreSharedOptions } from "./SecretlintCoreSharedOptions";

src/SecretLintConfigDescriptor.ts

@@ -1,3 +0,3 @@
-import { SecretLintRuleCreator, SecretLintRuleCreatorOptions } from "./SecretLintRule";
-import { SecretLintRulePresetCreator, SecretLintRulePresetCreatorOptions } from "./SecretLintRulePreset";
+import { SecretLintRuleCreatorOptions } from "./SecretLintRule";
+import { SecretLintRulePresetCreatorOptions } from "./SecretLintRulePreset";
 import { SecretLintRuleSeverityLevel } from "./SecretLintRuleSeverityLevel";
@@ -36,8 +36,2 @@ import { SecretlintCoreSharedOptions } from "./SecretlintCoreSharedOptions";
     severity?: SecretLintRuleSeverityLevel;
-    // DEBUG USAGE
-    /**
-     * FOR DEBUG
-     * Rule instance
-     */
-    rule?: SecretLintRuleCreator<Options>;
 };
@@ -74,8 +68,2 @@ export type SecretLintConfigDescriptorRulePreset<Options = SecretLintRulePresetCreatorOptions> = {
     rules?: SecretLintConfigDescriptorRule[];
-    // DEBUG USAGE
-    /**
-     * FOR DEBUG
-     * Rule instance
-     */
-    rule?: SecretLintRulePresetCreator<Options>;
 };
@@ -82,0 +70,0 @@

src/SecretLintCore.ts

@@ -13,3 +13,3 @@ // Core Input and Output
 
-export type SecretLintCoreDescriptorRule<Options = SecretLintRuleCreatorOptions> = {
+export type SecretLintCoreConfigRule<Options = SecretLintRuleCreatorOptions> = {
     /**
@@ -45,3 +45,3 @@ * Rule id that is package name or shorten package name
 };
-export type SecretLintCoreDescriptorRulePreset<Options = SecretLintRulePresetCreatorOptions> = {
+export type SecretLintCoreConfigRulePreset<Options = SecretLintRulePresetCreatorOptions> = {
     /**
@@ -59,3 +59,3 @@ * Rule id that is package name or shorten package name
      */
-    rules?: SecretLintCoreDescriptorRule[];
+    rules?: Omit<SecretLintCoreConfigRule, "rule">[];
     /**
@@ -75,5 +75,4 @@ * Rule options
     | SecretLintRulePresetCreator<Options>;
-export type SecretLintCoreDescriptorUnionRule<
-    Options = SecretLintRuleCreatorOptions | SecretLintRulePresetCreatorOptions
-> = SecretLintCoreDescriptorRule<Options> | SecretLintCoreDescriptorRulePreset<Options>;
+export type SecretLintCoreConfigUnionRule<Options = SecretLintRuleCreatorOptions | SecretLintRulePresetCreatorOptions> =
+    SecretLintCoreConfigRule<Options> | SecretLintCoreConfigRulePreset<Options>;
 // module export named `creator`
@@ -83,5 +82,10 @@ export type SecretLintRuleModule = {
 };
-export type SecretLintCoreDescriptor = {
+/**
+ * Loaded Config Object
+ * - Config: Full
+ * - ConfigDescriptor: Partial
+ */
+export type SecretLintCoreConfig = {
     sharedOptions?: SecretlintCoreSharedOptions;
-    rules: SecretLintCoreDescriptorUnionRule[];
+    rules: SecretLintCoreConfigUnionRule[];
 };
@@ -88,0 +92,0 @@

src/SecretLintRulePreset.ts

 // Rule Interfaces
-import { SecretLintCoreDescriptorRule } from "./SecretLintCore";
+import { SecretLintCoreConfigRule } from "./SecretLintCore";
 import { SecretLintRuleCreator, SecretLintRuleCreatorOptions } from "./SecretLintRule";
@@ -10,3 +10,3 @@ import { SecretlintCoreSharedOptions } from "./SecretlintCoreSharedOptions";
         rule: SecretLintRuleCreator<Options>,
-        defaultValue?: Omit<SecretLintCoreDescriptorRule<Options>, "id" | "rule">
+        defaultValue?: Omit<SecretLintCoreConfigRule<Options>, "id" | "rule">
     ): void;
@@ -24,4 +24,4 @@ };
     };
-
+    rules: SecretLintRuleCreator<unknown>[];
     create(context: SecretLintRulePresetContext, options: Options): void;
 };

No alert changes

Worsened metrics

Total package byte prevSize

37175

-1.03%

Lines of code

924

-1.18%

No dependency changes