@bbc/exposure-scanning

⛔️ This is an alpha component ⛔️

This component is currently tagged as alpha and is not suitable for production use.

exposure-scanning -

This package provides a utility to scan and patch issues and pull requests for content that matches a given regular expression.

Installation

npm install @bbc/exposure-scanning --save

Usage

The script can be imported and executed like so:

// /scripts/scan-exposures/index.jsx
import scanExposures from '@bbc/exposure-scanning';

(async () => {
  await scanExposures();
})();

Then, this can be executed in the command line:

./scripts/scan-exposures psammead -pr 1234 "foo|bar"

The command line arguments are as follows:

• repository (psammead in the example)
• content type (-pr or -issue)
• id (of the issue or pull request)
• regex ("foo|bar" in the example)

Contributing

Psammead is completely open source. We are grateful for any contributions, whether they be new components, bug fixes or general improvements. Please see our primary contributing guide which can be found at the root of the Psammead respository.

Code of Conduct

We welcome feedback and help on this work. By participating in this project, you agree to abide by the code of conduct. Please take a moment to read it.

License

Psammead is Apache 2.0 licensed.