@secretlint/core - npm Package Compare versions

Comparing version 3.1.0 to 3.3.0

lib/index.d.ts

@@ -14,2 +14,8 @@ import { SecretLintCoreDescriptor, SecretLintCoreResult, SecretLintRawSource, SecretLintRuleLocaleTag } from "@secretlint/types";
         /**
+         * If this is true, mask all message's data values
+         * Replace data value with "****" strings
+         * Default: false
+         */
+        maskSecrets?: boolean;
+        /**
          * config present secretlintrc object
@@ -16,0 +22,0 @@ */

lib/index.js

@@ -12,3 +12,3 @@ "use strict";
 const lintSource = ({ source, options }) => {
-    var _a;
+    var _a, _b;
     profiler_1.secretLintProfiler.mark({
@@ -22,2 +22,3 @@ type: "@core>lint::start",
     const locale = (_a = options.locale) !== null && _a !== void 0 ? _a : "en";
+    const maskSecrets = (_b = options.maskSecrets) !== null && _b !== void 0 ? _b : false;
     const contextEvents = RuleContext_1.createContextEvents();
@@ -77,2 +78,3 @@ const runningEvents = RunningEvents_1.createRunningEvents();
                 allowMessageIds: runningEvents.collectAllowMessageIds(),
+                maskSecrets,
             }),
@@ -79,0 +81,0 @@ };

lib/messages/index.d.ts

@@ -9,7 +9,9 @@ import { SecretLintCoreIgnoreMessage, SecretLintCoreResultMessage } from "@secretlint/types";
     }[];
+    maskSecrets: boolean;
 };
 /**
- * Cleanup messages
+ * Post cleanup messages
  * - filter ignored range
  * - filter disabled message
+ * - [masSecrets] mask secrets message
  * - filter duplicated messages
@@ -16,0 +18,0 @@ * - sort messages by range

lib/messages/index.js

@@ -9,6 +9,8 @@ "use strict";
 const filter_message_id_1 = require("./filter-message-id");
+const filter_mask_secrets_1 = require("./filter-mask-secrets");
 /**
- * Cleanup messages
+ * Post cleanup messages
  * - filter ignored range
  * - filter disabled message
+ * - [masSecrets] mask secrets message
  * - filter duplicated messages
@@ -21,3 +23,6 @@ * - sort messages by range
     const reportedMessagesWithoutAllowMessageIds = filter_message_id_1.filterByAllowMessageIds(reportedMessages, options.allowMessageIds);
-    const filterProcess = MessageProcessManager_1.createMessageProcessor([filter_duplicated_process_1.filterDuplicatedMessages]);
+    const filters = options.maskSecrets
+        ? [filter_duplicated_process_1.filterDuplicatedMessages, filter_mask_secrets_1.filterMaskSecretsData]
+        : [filter_duplicated_process_1.filterDuplicatedMessages];
+    const filterProcess = MessageProcessManager_1.createMessageProcessor(filters);
     return sort_messages_process_1.sortMessagesByLocation(filterProcess.process(reportedMessagesWithoutAllowMessageIds));
@@ -24,0 +29,0 @@ };

lib/RuleContext.js

@@ -49,2 +49,3 @@ "use strict";
             contextEvents.ignore({
+                type: "ignore",
                 ruleId: ruleId,
@@ -64,7 +65,7 @@ ruleParentId,
             if (ruleParentId) {
-                contextEvents.report(Object.assign(Object.assign({}, descriptor), { ruleId: ruleId, ruleParentId, loc: sourceCode.rangeToLocation(descriptor.range), severity: severityLevel, message,
+                contextEvents.report(Object.assign(Object.assign({}, descriptor), { type: "message", ruleId: ruleId, ruleParentId, loc: sourceCode.rangeToLocation(descriptor.range), severity: severityLevel, message,
                     messageId, docsUrl: ((_a = meta.docs) === null || _a === void 0 ? void 0 : _a.url) ? `${meta.docs.url}#${messageId}` : undefined, data }));
             }
             else {
-                contextEvents.report(Object.assign(Object.assign({}, descriptor), { ruleId: ruleId, loc: sourceCode.rangeToLocation(descriptor.range), severity: severityLevel, message,
+                contextEvents.report(Object.assign(Object.assign({}, descriptor), { type: "message", ruleId: ruleId, loc: sourceCode.rangeToLocation(descriptor.range), severity: severityLevel, message,
                     messageId, docsUrl: ((_b = meta.docs) === null || _b === void 0 ? void 0 : _b.url) ? `${meta.docs.url}#${messageId}` : undefined, data }));
@@ -71,0 +72,0 @@ }

package.json

 {
     "name": "@secretlint/core",
-    "version": "3.1.0",
+    "version": "3.3.0",
     "description": "Core library for @secretlint.",
@@ -44,3 +44,3 @@ "keywords": [
         "@secretlint/profiler": "^3.1.0",
-        "@secretlint/types": "^3.1.0",
+        "@secretlint/types": "^3.3.0",
         "debug": "^4.1.1",
@@ -65,3 +65,3 @@ "structured-source": "^3.0.2"
     },
-    "gitHead": "634a3fb30f99492e94676a358aaae3de31d99207"
+    "gitHead": "f6ee7794184c8cfb89c0bcd87e11e58d99301b25"
 }

src/index.ts

@@ -33,2 +33,8 @@ import {
         /**
+         * If this is true, mask all message's data values
+         * Replace data value with "****" strings
+         * Default: false
+         */
+        maskSecrets?: boolean;
+        /**
          * config present secretlintrc object
@@ -48,2 +54,3 @@ */
     const locale = options.locale ?? "en";
+    const maskSecrets = options.maskSecrets ?? false;
     const contextEvents = createContextEvents();
@@ -103,2 +110,3 @@ const runningEvents = createRunningEvents();
                     allowMessageIds: runningEvents.collectAllowMessageIds(),
+                    maskSecrets,
                 }),
@@ -105,0 +113,0 @@ };

src/messages/index.ts

@@ -7,2 +7,3 @@ import { SecretLintCoreIgnoreMessage, SecretLintCoreResultMessage } from "@secretlint/types";
 import { filterByAllowMessageIds } from "./filter-message-id";
+import { filterMaskSecretsData } from "./filter-mask-secrets";
 
@@ -16,7 +17,9 @@ export type cleanupMessagesOptions = {
     }[];
+    maskSecrets: boolean;
 };
 /**
- * Cleanup messages
+ * Post cleanup messages
  * - filter ignored range
  * - filter disabled message
+ * - [masSecrets] mask secrets message
  * - filter duplicated messages
@@ -29,4 +32,7 @@ * - sort messages by range
     const reportedMessagesWithoutAllowMessageIds = filterByAllowMessageIds(reportedMessages, options.allowMessageIds);
-    const filterProcess = createMessageProcessor([filterDuplicatedMessages]);
+    const filters = options.maskSecrets
+        ? [filterDuplicatedMessages, filterMaskSecretsData]
+        : [filterDuplicatedMessages];
+    const filterProcess = createMessageProcessor(filters);
     return sortMessagesByLocation(filterProcess.process(reportedMessagesWithoutAllowMessageIds));
 };

src/RuleContext.ts

@@ -89,2 +89,3 @@ import { EventEmitter } from "events";
             contextEvents.ignore({
+                type: "ignore",
                 ruleId: ruleId,
@@ -105,2 +106,3 @@ ruleParentId,
                     ...descriptor,
+                    type: "message",
                     ruleId: ruleId,
@@ -118,2 +120,3 @@ ruleParentId,
                     ...descriptor,
+                    type: "message",
                     ruleId: ruleId,
@@ -120,0 +123,0 @@ loc: sourceCode.rangeToLocation(descriptor.range),

No alert changes

Improved metrics

Total package byte prevSize

102136

increased by9.37%

Number of package files

63

increased by6.78%

Lines of code

2017

increased by9.92%

Dependency changes

• Updated@secretlint/types@^3.3.0