eslint-plugin-pii

PII linting rules for ESLint

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-pii:

$ npm install eslint-plugin-pii --save-dev

Recommended Usage

Use the recommended rules by extending your configuration. This adds the plugin to the eslint config and enforces the recommended rules.

{
  "extend": ["plugin:pii/recommended"]
}

Custom Usage

Add pii to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["pii"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "pii/no-email": "error",
    "pii/no-dob": "warn",
    "pii/no-ip": "error",
    "pii/no-phone-number": "error"
  }
}

Supported Rules

• pii/no-email - enforces no email in comments or string literals
• pii/no-dob - enforces no birth date in comments or string literals
• pii/no-ip - enforces no IP address in comments or string literals
• pii/no-phone-number - enforces no phone numbers in comments or string literals

References

• General PII Regular Expression

Show some love