PCI-DSS Sanitizer

Release:

Development:

Usage

You can use this synchronously

import sanitize from 'pci-dss-sanitizer';
const unsanitized_string = 'your string containing sensitive banking info';
const sanitized_string = sanitize(unsanitized_string);

Or you can use it as a stream (this is actually the recommended way to use this library)

import { createStream as createSanitizerStream } from 'pci-dss-sanitizer';
const unsanitized_stream = process.stdin;
const sanitized_stream = unsanitized_stream.pipe(createSanitizerStream())
sanitized_stream.pipe(process.stdout);
// you could also write this as a one-liner:
process.stdin.pipe(createSanitizerStream()).pipe(process.stdout);

Or if you're more into Promises/callbacks, you could use it as an async function

import { async as sanitizeAsync } from 'pci-dss-sanitizer';
const unsanitized_string = 'your string containing sensitive banking info';
const sanitized_promise = sanitizeAsync(unsanitized_string, your_optional_callback_here);
sanitized_promise.then(function(sanitized_string) {
  ...
});

Contributing

Commits

Use npm run commit when you want to commit a change.

Releases

This project uses GitHub actions and semantic-release for creating releases.

Release Candidates

To make a (temporary) release candidate, you can use the following commands:

# Create a new rc from the latest/remote develop
npm run release-candidate

or

# Create a new rc from a specific branch
npm run release-candidate -- feature/SKED-XXXX

That command will make a new rc branch (locally and remotely) on which semantic-release is configured to create a new release candidate (see .releaserc).

Final Releases

Since semantic-release is currently configured to run on any push'es to master, creating and merging a GitHub Pull Request into master will trigger a new release automatically.

Typically we do this via a temporary release/next or release/SKED-XXXX branch and creating a PR via GitHub UI.

Stack

This repostiory uses TSDX for development.

Commands

TSDX scaffolds your new library inside /src.

To run TSDX, use:

npm start # or yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

Jest

Jest tests are set up to run with npm test or yarn test.

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

TypeScript

tsconfig.json is set up to interpret dom and esnext types. Adjust according to your needs.

Optimizations

Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

// ./types/index.d.ts
declare var __DEV__: boolean;

// inside your code...
if (__DEV__) {
  console.log('foo');
}

You can also choose to install and use invariant and warning functions.

Module Formats

CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in package.json and dist/index.js accordingly. Please report if any issues are found.