Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(recommend): Add OpenAI rule to recommend #700

Merged
merged 1 commit into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"build": "rollup --config",
"build:tsc": "tsc -p . --noEmit",
"clean": "rimraf module/",
"sync-canary": "cp ../secretlint-rule-preset-canary/src/index.ts src/ && sed -i '' -e 's/\\@secretlint\\/secretlint-rule-preset-canary/\\@secretlint\\/secretlint-rule-preset-recommend/' src/index.ts && cp -r ../secretlint-rule-preset-canary/test/ test && node cp-canary-deps.cjs && yarn install && npm run build && npm run updateSnapshot",
"sync-canary": "cp ../secretlint-rule-preset-canary/src/index.ts src/ && sed -i '' -e 's/\\@secretlint\\/secretlint-rule-preset-canary/\\@secretlint\\/secretlint-rule-preset-recommend/' src/index.ts && cp -r ../secretlint-rule-preset-canary/test/ test && sed -i '' -e 's/\\@secretlint\\/secretlint-rule-preset-canary/\\@secretlint\\/secretlint-rule-preset-recommend/' test/index.test.ts && node cp-canary-deps.cjs && yarn install && npm run build && npm run updateSnapshot",
"prepublishOnly": "npm run clean && npm run build",
"prettier": "prettier --write \"**/*.{js,jsx,ts,tsx,css}\"",
"prepublish": "npm run --if-present build",
Expand Down Expand Up @@ -90,4 +90,4 @@
"publishConfig": {
"access": "public"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { creator as ruleGCP } from "@secretlint/secretlint-rule-gcp";
import { creator as ruleNpm } from "@secretlint/secretlint-rule-npm";
import { creator as ruleSlack } from "@secretlint/secretlint-rule-slack";
import { creator as ruleBasicAuth } from "@secretlint/secretlint-rule-basicauth";
import { creator as ruleOpenAi } from "@secretlint/secretlint-rule-openai";
import { creator as rulePrivateKey } from "@secretlint/secretlint-rule-privatekey";
import { creator as ruleSendgrid } from "@secretlint/secretlint-rule-sendgrid";
import { creator as ruleShopify } from "@secretlint/secretlint-rule-shopify";
Expand All @@ -20,6 +21,7 @@ export const rules = [
ruleSendgrid,
ruleShopify,
ruleGitHub,
ruleOpenAi,
ruleFilterComments,
];
export type Options = {};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import test from "node:test";
import { creator as rule } from "../module/index.js";

const __dirname = path.dirname(fileURLToPath(import.meta.url));
test("Snapshot Testing", async (t) => {
test("@secretlint/secretlint-rule-preset-recommend", async (t) => {
const snapshot = (await import("@secretlint/tester")).snapshot;
const eachRulesDir = fs
.readdirSync(path.join(__dirname, "snapshots"), {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sk-sUeBP9asw6GiYHXqtg70T3BlbkFJJuLwJFco90bOpU0Ntest
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"filePath": "[SNAPSHOT]/ng.secret/input.txt",
"messages": [
{
"message": "found OpenAI API token: sk-sUeBP9asw6GiYHXqtg70T3BlbkFJJuLwJFco90bOpU0Ntest",
"range": [
0,
51
],
"type": "message",
"ruleId": "@secretlint/secretlint-rule-openai",
"ruleParentId": "@secretlint/secretlint-rule-preset-recommend",
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 1,
"column": 51
}
},
"severity": "error",
"messageId": "OPENAI_TOKEN",
"docsUrl": "https://github.com/secretlint/secretlint/blob/master/packages/%40secretlint/secretlint-rule-openai/README.md#OPENAI_TOKEN",
"data": {
"TOKEN": "sk-sUeBP9asw6GiYHXqtg70T3BlbkFJJuLwJFco90bOpU0Ntest"
}
}
],
"sourceContent": "sk-sUeBP9asw6GiYHXqtg70T3BlbkFJJuLwJFco90bOpU0Ntest\n",
"sourceContentType": "text"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sk-sUeBP9asw6GiYHXqtg70abcdefghJuLwJFco90bOpU0Ntest
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"filePath": "[SNAPSHOT]/ok.valid/input.txt",
"messages": [],
"sourceContent": "sk-sUeBP9asw6GiYHXqtg70abcdefghJuLwJFco90bOpU0Ntest\n",
"sourceContentType": "text"
}