diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 9eb63c9..70acbc5 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -12,7 +12,7 @@ jobs: strategy: matrix: # Have to use 18.x and up because later versions of eslint require structuredClone - node-version: [18.x, 20.x] + node-version: [18.x, 20.x, 22.x] steps: - uses: actions/checkout@v4 - name: Run tests against node ${{ matrix.node-version }} diff --git a/.npmignore b/.npmignore index 672b9d3..59bc277 100644 --- a/.npmignore +++ b/.npmignore @@ -2,4 +2,8 @@ tests/* /node_modules/ *.log staging/* -.travis.yml \ No newline at end of file +.travis.yml +.github/* +src/* +tsconfig.json +v1tov2.md \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 1055008..1ff99fd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # CHANGELOG +## 2.1.0 + +### Major + +- Removed support for non-supported node & npm versions +- Removed support for ESLint 4 and below + +### Minor + +- Module is now written in typescript + ## 1.1.2 ### Minor diff --git a/README.md b/README.md index ccf7063..7db3cc7 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,13 @@ An eslint rule that searches for potential secrets/keys in code and JSON files. +This plugin has two rules: + +- `no-secrets`: Find potential secrets using cryptographic entropy or patterns in the AST (acts like a standard eslint rule, more configurable) +- `no-pattern-match`: Find potential secrets in text (acts like `grep`, less configurable, but potentially more flexible) + +--- + - 1. [Usage](#Usage) @@ -11,14 +18,17 @@ An eslint rule that searches for potential secrets/keys in code and JSON files. - 1.2. [eslintrc](#eslintrc) - 1.3. [Include JSON files](#IncludeJSONfiles) - 1.3.1. [Include JSON files with in "flat configs"](#IncludeJSONfileswithinflatconfigs) -- 2. [Config](#Config) -- 3. [When it's really not a secret](#Whenitsreallynotasecret) - - 3.1. [ Either disable it with a comment](#Eitherdisableitwithacomment) - - 3.2. [ use the `ignoreContent` to ignore certain content](#usetheignoreContenttoignorecertaincontent) - - 3.3. [ Use `ignoreIdentifiers` to ignore certain variable/property names](#UseignoreIdentifierstoignorecertainvariablepropertynames) - - 3.4. [ Use `additionalDelimiters` to further split up tokens](#UseadditionalDelimiterstofurthersplituptokens) -- 4. [Options](#Options) -- 5. [Acknowledgements](#Acknowledgements) +- 2. [`no-secrets`](#no-secrets) + - 2.1. [`no-secrets` examples](#no-secretsexamples) + - 2.2. [When it's really not a secret](#Whenitsreallynotasecret) + - 2.2.1. [ Either disable it with a comment](#Eitherdisableitwithacomment) + - 2.2.2. [ use the `ignoreContent` to ignore certain content](#usetheignoreContenttoignorecertaincontent) + - 2.2.3. [ Use `ignoreIdentifiers` to ignore certain variable/property names](#UseignoreIdentifierstoignorecertainvariablepropertynames) + - 2.2.4. [ Use `additionalDelimiters` to further split up tokens](#UseadditionalDelimiterstofurthersplituptokens) + - 2.3. [`no-secrets` Options](#no-secretsOptions) +- 3. [`no-pattern-match`](#no-pattern-match) + - 3.1. [`no-pattern-match` options](#no-pattern-matchoptions) +- 4. [Acknowledgements](#Acknowledgements)