Package Exports

eslint-plugin-no-credentials
eslint-plugin-no-credentials/build/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-plugin-no-credentials) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

eslint-plugin-no-credentials

An ESlint plugin checking for any hardcoded credentials like a password or a token.

This library detects credentials hardcoded in a JS string (no matter whether it's defined with apostrophes, quotation marks or it's a template string) or a JS comment.

However, it doesn't check non-JS files like JSON or txt.

The percentage of found hardcoded credentials depends on applied params which should be chosen according to the code in a given project.

I recommend using additionally a spellchecking tool like that as the credentials are usually strings not matching any word found in a dictionary.

how to install?

yarn add --dev eslint-plugin-no-credentials

npm i --save-dev eslint-plugin-no-credentials

how to use?

In your .eslintrc file add "no-credentials" to the plugins section:

  "plugins": [
    "no-credentials"
  ],

and the no-credentials/no-credentials rule with the chosen params to that file:

    "no-credentials/no-credentials": [
      "error",
      {
        delimiters: [" ", "/", "-", "_", "."],
        maximumEntropy: 8,
        minimumWordLength: 5,
        shouldSplitCamelCase: true,
      },
    ],

Possible params:

delimiters (default [' ']): delimiters used to split each string into words so for each word, the entropy is calculated separately
minimumNumberOfWords (default 0): if the number of words in a given string is less than this param, the entire string is treated as one word
minimumWordLength (default 1): if a given word is shorter than this param, it's concatenated to the next word
maximumEntropy (default 5): maximum tolerated entropy for each word
shouldSplitCamelCase (default false): whether a camelCase string should be split into separate words

In order to have a better understanding, how these params work, you can read the tests.