https://github.com/neofinancial/ccscan

Scan files for credit card numbers
https://github.com/neofinancial/ccscan

compliance hacktoberfest nodejs pci precommit-hooks squad-dx

Last synced: 2 months ago
JSON representation

Scan files for credit card numbers

• Host: GitHub
• URL: https://github.com/neofinancial/ccscan
• Owner: neofinancial
• License: mit
• Created: 2019-10-29T01:23:47.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-08T20:39:05.000Z (6 months ago)
• Last Synced: 2025-04-14T01:14:54.644Z (2 months ago)
• Topics: compliance, hacktoberfest, nodejs, pci, precommit-hooks, squad-dx
• Language: TypeScript
• Homepage:
• Size: 905 KB
• Stars: 7
• Watchers: 37
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ccscan

[![Build status](https://github.com/neofinancial/config-dug/workflows/CI/badge.svg)](https://github.com/neofinancial/ccscan/actions)

![TypeScript 3.5.3](https://img.shields.io/badge/TypeScript-3.5.3-brightgreen.svg)

[![codecov.io](https://codecov.io/github/neofinancial/ccscan/coverage.svg)](https://codecov.io/github/neofinancial/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.

#### Add to `package.json`

```json

"husky": {

  "hooks": {

    "pre-commit": "lint-staged"

  }

},

"lint-staged": {

  "*.{ts,tsx,js}": [

    "ccscan",

    "git add"

  ]

}

```

## Contributing

1. Fork this repo

1. Clone the forked repo

1. Install dependencies: `npm i`

### Building

#### `npm run build`

To clean the build directory run `npm run clean`

### Running Tests

#### `npm run test`

## Publishing

1. Update the version in `package.json`

1. Add a `CHANGELOG.md` entry

1. Commit your changes

1. Run `npm pack` to see what will be published then delete the `.tgz` file that was created

1. Run `npm publish`

1. 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`.