Merge pull request #13 from oganexon/develop

Develop

Author: SteelAlloy

.gitignore

@@ -4,5 +4,6 @@
 /dist
 /tmp
 /yarn.lock
+/coverage
 node_modules
 README.html

.travis.yml

@@ -0,0 +1,29 @@
+language : node_js
+
+node_js:
+  - "8"
+  - "10"
+  - "12"
+
+os:
+  - linux
+  - osx
+  - windows
+
+cache:
+  directories:
+    - "node_modules"
+
+branches:
+  only:
+  - master
+  - develop
+
+install:
+ - npm install
+
+before_script:
+ - npm run build-ts
+
+script:
+ - npm test

CHANGELOG.md

@@ -14,10 +14,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2019-08-26
+
+### Added
+- End message when the process is finished.
+- Types definitions.
+- Mute argument in cli.
+- New badges in readme.
+- Travis Continuous Integration.
+
+### Changed
+- All JavaScript files have been converted to TypeScript files.
+- 'Method' is now 'standard' in the cli and in the lib.
+- Custom standard has changed. See the doc.
+
+### Soon deprecated
+- CLI will be ported in its own package.
+
 ## [1.1.1] - 2019-08-20
 
 ### Added
-- Comment on every file.
+- Comments on every file.
 - Error recap at the end of the process.
 
 ## [1.1.0] - 2019-08-19

CONTRIBUTING.md

@@ -1,3 +1,16 @@
+<p align="center">
+  <a href="https://jestjs.io"><img src="https://img.shields.io/badge/tested_with-jest-99424f.svg?style=for-the-badge&logo=jest" alt="Tested with Jest"></a>
+  <a href="https://www.npmjs.com"><img src="https://img.shields.io/librariesio/release/npm/secure-rm?style=for-the-badge&logo=npm" alt="Dependencies"></a>
+  <a href="https://nodejs.org"><img src="https://img.shields.io/node/v/secure-rm?style=for-the-badge" alt="Node version"></a>
+  <a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/language-typescript-blue?style=for-the-badge" alt="language"></a>
+</p>
+<p align="center">
+  <img src="https://img.shields.io/github/contributors/oganexon/secure-rm?style=for-the-badge" alt="Contributors">
+  <img src="https://img.shields.io/github/last-commit/oganexon/secure-rm/develop?style=for-the-badge" alt="Last commit">
+  <img src="https://img.shields.io/npm/collaborators/secure-rm?style=for-the-badge" alt="npm collaborators">
+</p>
+
+
 # Contributing / Developing
 
 Contributions are welcome. Fork this repository and issue a pull request with your changes.

README.md

@@ -6,10 +6,13 @@
 </h1>
 
 <p align="center">
-  <a href="https://www.npmjs.com/package/secure-rm"><img src="https://img.shields.io/npm/v/secure-rm.svg" alt="Version"></a>
-  <a href="https://www.npmjs.com/package/secure-rm"><img src="https://img.shields.io/npm/dw/secure-rm.svg" alt="Downloads/week"></a>
-  <a href="https://github.com/oganexon/secure-rm/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/secure-rm.svg" alt="License: MIT"></a>
-  <a href="https://jestjs.io"><img src="https://img.shields.io/badge/tested_with-jest-99424f.svg" alt="Tested with Jest"></a>
+  <a href="https://www.npmjs.com/package/secure-rm"><img src="https://img.shields.io/npm/v/secure-rm.svg?style=for-the-badge" alt="Version"></a>
+  <a href="https://www.npmjs.com/package/secure-rm"><img src="https://img.shields.io/npm/dw/secure-rm.svg?style=for-the-badge" alt="Downloads/week"></a>
+  <a href="https://github.com/oganexon/secure-rm/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/secure-rm.svg?style=for-the-badge" alt="License: MIT"></a>
+</p>
+<p align="center">
+  <a href="https://travis-ci.org/oganexon/secure-rm"><img src="https://img.shields.io/travis/oganexon/secure-rm/master.svg?style=for-the-badge&label=master%20build" alt="Build status: master"></a>
+  <a href="https://travis-ci.org/oganexon/secure-rm"><img src="https://img.shields.io/travis/oganexon/secure-rm/develop.svg?style=for-the-badge&label=development%20build" alt="Build status: develop"></a>
 </p>
 
 ## ❓ Why
@@ -28,7 +31,7 @@ You can use this package in two different ways, the _npm module version_:
 npm install secure-rm --save
 ```
 
-Or the _command-line version_:
+Or the _command-line version_: **(soon deprecated, will be ported to secure-rm-cli)**
 
 ```shell
 npm install secure-rm -g
@@ -62,6 +65,7 @@ srm('./folder/*.js')
 ```
 
 ### Command line version
+**(soon deprecated, will be ported to secure-rm-cli)**
 
 If you want to delete files on the fly, just use the command line tool:
 ```shell
@@ -79,8 +83,8 @@ secure-rm ./folder/*.js
   - a relative path (e.g. `./data/file.js`, `../../data`);
   - a [glob pattern](https://www.npmjs.com/package/glob#glob-primer) (e.g. `./*.js`, `./**/*`, `@(pattern|pat*|pat?erN)`).
 - `options` [\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) (optional) :
-  - `method` [\<String\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) : ID of the method (default: 'secure');
-  - `customMethod` [\<Function\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) : your own method to remove a file (if specified, priority over `method`);
+  - `standard` [\<String\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) : ID of the standard (default: 'secure');
+  - `customStandard` [\<Function\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) : your own standard to remove a file (if specified, priority over `standard`);
   - `maxBusyTries` [\<Number\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) : number of retries if an error occur;
   - `disableGlob` [\<Boolean\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) : allow or not file globbing (default: true).
 - `callback` [\<Function\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) (if missing, return a promise):
@@ -89,7 +93,7 @@ secure-rm ./folder/*.js
 #### Examples:
 ```javascript
 const options = {
-  method: 'gutmann',
+  standard: 'gutmann',
   maxBusyTries: 5,
   disableGlob: true
 }
@@ -102,22 +106,24 @@ srm('./data/file*.js', options, (err, path) => {
 
 ```javascript
 const options = {
-  customMethod: function (file, callback) {
+  customStandard: new srm.UnlinkStandard({
+    method: function (file, callback) {
     srm.write.init(file)
       .then(({ fileSize, file }) => srm.write.zeroes(file, fileSize))
       .then(({ fileSize, file }) => srm.write.ones(file, fileSize))
       .then(({ fileSize, file }) => srm.write.random(file, fileSize))
       .then(({ file }) => srm.write.unlink(file))
       .then(() => callback())
       .catch((err) => callback(err))
+  })
 }
 
 srm('./*', options)
   .then((path) => console.log(`Successfully removed ${path} !`))
   .catch((err) => {throw err})
 ```
 
-If you want to make your own cutom method, see [write.js](./lib/write.js) file for more details.
+If you want to make your own cutom standard, see [write.js](./lib/write.js) file for more details.
 
 #### Events
 When running, secure-rm emits events to let you know the progression of the deletion.
@@ -145,15 +151,15 @@ secure-rm <PATHS> [OPTIONS]
 - `OPTIONS` (flags):
   - `-f, --force`: avoid checks if you want to use it in a shell or bash file;
   - `-h, --help`: show CLI help, see below;
-  - `-m, --method`: numerical ID of the method, default is 0. See them detailed below;
+  - `-s, --standard`: numerical ID of the standard, default is 0. See them detailed below;
   - `-r, --retries`: max retries if an error occur;
-  - `-t, --table `: show the methods table. See them detailed below;
+  - `-t, --table `: show the standards table. See them detailed below;
   - `-v, --version `: show CLI version;
   - `--no-globbing `: disable file globbing.
 
 Example:
 ```shell
-secure-rm ./folder/*.js ./garbage ./file.js -m 6 -f
+secure-rm ./folder/*.js ./file.js -s gutmann -f
 ```
 You can invoke the built-in help with `secure-rm -h`:
 
@@ -162,24 +168,29 @@ You can invoke the built-in help with `secure-rm -h`:
 CLI help:
 
 USAGE
- $ secure-rm PATH
+  $ secure-rm PATH
 
 OPTIONS
-  -f, --force            avoid checks
-  -h, --help             show CLI help
-  -m, --method=method    [default: secure] select the erasure method
-  -r, --retries=retries  max retries if error
-  -t, --table            show the methods table
-  -v, --version          show CLI version
-  --[no-]globbing        allow or not file globbing
+  -f, --force              avoid checks
+  -h, --help               show CLI help
+  -m, --mute               mutes the cli to the bare minimum
+  -r, --retries=retries    [default: 3] max retries if error
+  -s, --standard=standard  [default: secure] select the erasure standard
+  -t, --table              show the standards table
+  -v, --version            show CLI version
+  --[no-]globbing          allow or not file globbing
 
 DESCRIPTION
   Completely erases files by making recovery impossible.
   For extra documentation, go to https://www.npmjs.com/package/secure-rm
+
+EXAMPLES
+  $ secure-rm ./folder/*.js ./file.js -s gutmann -f
+  $ secure-rm /d/code -m
 ```
 <!--AUTO GENERATED HELP END-->
 
-### Methods
+### Standards
 
 <!--AUTO GENERATED METHODS TABLE START-->
 ID | Name | Passes | Description
@@ -188,7 +199,7 @@ ID | Name | Passes | Description
  randomByte | Pseudorandom byte | 1 | Overwriting with a random byte.
  zeroes | Zeroes | 1 | Overwriting with zeroes.
  ones | Ones | 1 | Overwriting with ones.
- secure | **Secure-rm method** | 3 | Pass 1: Overwriting with random data;<br>Pass 2: Renaming the file with random data;<br>Pass 3: Truncating between 25% and 75% of the file.
+ secure | **Secure-rm standard** | 3 | Pass 1: Overwriting with random data;<br>Pass 2: Renaming the file with random data;<br>Pass 3: Truncating between 25% and 75% of the file.
  GOST_R50739-95 | Russian State Standard GOST R 50739-95 | 2 | Pass 1: Overwriting with zeroes;<br>Pass 2: Overwriting with random data.
  HMG_IS5 | British HMG Infosec Standard 5 | 3 | Also known as "Air Force System Security Instructions AFSSI-5020",<br>"Standard of the American Department of Defense (DoD 5220.22 M)"<br>"National Computer Security Center NCSC-TG-025 Standard"<br>and "Navy Staff Office Publication NAVSO P-5239-26"<br>Pass 1: Overwriting with zeroes;<br>Pass 2: Overwriting with ones;<br>Pass 3: Overwriting with random data as well as verifying the writing of this data.
  AR380-19 | US Army AR380-19 | 3 | Pass 1: Overwriting with random data;<br>Pass 2: Overwriting with a random byte;<br>Pass 3: Overwriting with the complement of the 2nd pass, and verifying the writing.
@@ -202,7 +213,7 @@ Note: Node ensures that the file is correctly written, checking the writing in t
 
 ## 🚩 Troubleshooting / Common issues
 
-Should works on OS X, Linux, and Windows.
+Should works on OS X, Linux (almost, see below), and Windows. (See build status)
 
 ### File systems
 
@@ -241,13 +252,24 @@ See the [changelog](/CHANGELOG.md) or [releases](https://github.com/oganexon/sec
 
 ## 📌 TODO
 
-- [x] Release of 1.0.0 (stable API)
 - [ ] Implement more tests
-- [ ] TypeScript
+- [x] TypeScript
 - [ ] Support of 64bit files
 
 ## 🏗 Contributing
 
+<p align="center">
+  <a href="https://jestjs.io"><img src="https://img.shields.io/badge/tested_with-jest-99424f.svg?style=for-the-badge&logo=jest" alt="Tested with Jest"></a>
+  <a href="https://www.npmjs.com"><img src="https://img.shields.io/librariesio/release/npm/secure-rm?style=for-the-badge&logo=npm" alt="Dependencies"></a>
+  <a href="https://nodejs.org"><img src="https://img.shields.io/node/v/secure-rm?style=for-the-badge" alt="Node version"></a>
+  <a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/language-typescript-blue?style=for-the-badge" alt="language"></a>
+</p>
+<p align="center">
+  <img src="https://img.shields.io/github/contributors/oganexon/secure-rm?style=for-the-badge" alt="Contributors">
+  <img src="https://img.shields.io/github/last-commit/oganexon/secure-rm/develop?style=for-the-badge" alt="Last commit">
+  <img src="https://img.shields.io/npm/collaborators/secure-rm?style=for-the-badge" alt="npm collaborators">
+</p>
+
 See [contributing guidelines](/CONTRIBUTING.md)
 
 ### Licensing