README.md

ccscan

Scan files for credit card numbers

Usage

npx ccscan

Precommit Hook

You can also add ccscan to your project and set it up as a precommit hook that will block any commits that contain card numbers.

Install Dependencies

yarn add --dev ccscan husky lint-staged or npm install -D ccscan husky lint-staged

Add to package.json

"husky": {
  "hooks": {
    "pre-commit": "lint-staged"
  }
},
"lint-staged": {
  "*.{ts,tsx,js}": [
    "ccscan",
    "git add"
  ]
}

Contributing

1. Fork this repo
2. Clone the forked repo
3. Install dependencies: yarn

Building

yarn build

To clean the build directory run yarn clean

Running Tests

yarn test

Publishing

1. Update the version in package.json
2. Add a CHANGELOG.md entry
3. Commit your changes
4. Run npm pack to see what will be published then delete the .tgz file that was created
5. Run npm publish
6. Create a release on GitHub. Use the version as the tag and release name. For example for version 1.0.0 the tag and release name would be v1.0.0.