Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tcorral/sensitive-data-cleaner
NPM package that will remove all sensitive data in package.json or package-lock.json
https://github.com/tcorral/sensitive-data-cleaner
Last synced: 5 days ago
JSON representation
NPM package that will remove all sensitive data in package.json or package-lock.json
- Host: GitHub
- URL: https://github.com/tcorral/sensitive-data-cleaner
- Owner: tcorral
- License: mit
- Created: 2020-06-23T06:29:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T21:49:21.000Z (almost 2 years ago)
- Last Synced: 2024-08-11T00:47:01.257Z (3 months ago)
- Language: TypeScript
- Size: 293 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# sensitive-data-cleaner
Use this library to remove all sensitive information from your package.json on installing before publishing your app
[](https://travis-ci.org/tcorral/sensitive-data-cleaner)
[](http://badge.fury.io/js/sensitive-data-cleaner)
[](https://gitter.im/tcorral/sensitive-data-cleaner?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## Installation
*sensitive-data-cleaner* is available as an NPM package. You can install *sensitive-data-cleaner*
in your project's directory as usual:
```bash
$ npm install sensitive-date-cleaner --save-dev
```
## Usage
### sensitive-data-cleaner
*sensitive-data-cleaner* is an utility for your development life cycle so you don't expose any potential information that can be used against you as user names, emails, jenkins or npm private registry paths.
When *sensitive-data-cleaner* exposes a cli called `clean-sensitive-data`
In order to make this tool work we have to provide some arguments.
-------
### Arguments
#### pattern *REQUIRED*
In order to find the package.json files it's needed to provide at least one pattern, but you can provide more than just one pattern.
The pattern accepts wildcards.
##### Single Pattern
```bash
clean-sensitive-data --pattern **/node_modules/**/package.json
```
##### Multiple Patterns
```bash
clean-sensitive-data --pattern **/node_modules/**/package.json --pattern node_modules/@scope/**/package.json
```
##### Using alias
```bash
clean-sensitive-data -p **/node_modules/**/package.json -p node_modules/@scope/**/package.json
```
#### verbose *OPTIONAL*
By default `clean-sensitive-data` only shows a message on finishing processing all the files found using the provided patterns.
On setting *verbose* argument it will show a lot of more information about all the files being processed, package.json information before stripping data, after stripping data...
##### Setting verbose mode
```bash
clean-sensitive-data --verbose --pattern **/node_modules/**/package.json --pattern node_modules/@scope/**/package.json
```
## Build the source
This library has been written using [TypeScript](http://typescriptlang.org).
If you need to use it in your project but you are not working with TypeScript you can always to build the code using ```npm run build``` This command will *lint your code*, *run the tests* and *compile to TypeScript.
## Contributing
This project is maintained by a community of developers. Contributions are welcome and appreciated.
You can find sensitive-data-cleaner on GitHub; feel free to start an issue or create a pull requests:
[https://github.com/tcorral/sensitive-data-cleaner](https://github.com/tcorral/sensitive-data-cleaner)
For more information, read the [contribution guide](https://github.com/tcorral/sensitive-data-cleaner/blob/master/CONTRIBUTING.md).
## License
Copyright (c) 2019 [Tomas Corral](http://github.com/tcorral).
Copyright (c) 2019 [sensitive-data-cleaner Contributors](https://github.com/tcorral/sensitive-data-cleaner/graphs/contributors).
Licensed under the MIT License.