https://github.com/shiva-hack/eslint-plugin-pii

PII linting rules for ESLint
https://github.com/shiva-hack/eslint-plugin-pii

Last synced: 3 months ago
JSON representation

PII linting rules for ESLint

• Host: GitHub
• URL: https://github.com/shiva-hack/eslint-plugin-pii
• Owner: shiva-hack
• License: mit
• Created: 2021-04-13T14:58:14.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-04-25T19:30:47.000Z (almost 3 years ago)
• Last Synced: 2024-11-11T20:15:51.919Z (3 months ago)
• Language: JavaScript
• Size: 44.9 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-eslint - pii - Checks and enforces PII Compliance of the code. i.e. no email address, birth date, IP address or phone number in comments or string literals. (Plugins / Security)

README

        
# eslint-plugin-pii

![npm](https://img.shields.io/npm/v/eslint-plugin-pii) ![GitHub last commit](https://img.shields.io/github/last-commit/shiva-hack/eslint-plugin-pii) ![npm peer dependency version](https://img.shields.io/npm/dependency-version/eslint-plugin-pii/peer/eslint) ![Dependents (via libraries.io)](https://img.shields.io/librariesio/dependents/npm/eslint-plugin-pii?cacheSeconds=300) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/f77de857bbe7426ba4eebe33d307ef84)](https://www.codacy.com/gh/shiva-hack/eslint-plugin-pii/dashboard?utm_source=github.com&utm_medium=referral&utm_content=shiva-hack/eslint-plugin-pii&utm_campaign=Badge_Grade) [![GitHub issues](https://img.shields.io/github/issues/shiva-hack/eslint-plugin-pii?cacheSeconds=300)](https://github.com/shiva-hack/eslint-plugin-pii/issues) [![GitHub license](https://img.shields.io/github/license/shiva-hack/eslint-plugin-pii?cacheSeconds=300)](https://github.com/shiva-hack/eslint-plugin-pii/blob/main/LICENSE)

PII linting rules for ESLint

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ 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.

```json

{

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

}

```

## Custom Usage

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

```json

{

  "plugins": ["pii"]

}

```

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

```json

{

  "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](https://support.milyli.com/docs/quickstarts/regex/general-pii-regex)

## Show some love