Rewrite to TypeScript

Author: jbdemonte

.eslintrc

@@ -2,4 +2,6 @@ bin
 node_modules
 .idea
 .DS_Store
-coverage
+coverage
+dist
+*.log

.gitignore

@@ -2,9 +2,14 @@ bin
 node_modules
 .idea
 .gitignore
-.eslintrc
 .npmignore
 .DS_Store
-.travis.yml
 coverage
-tests
+src
+.travis.yml
+.prettierrc
+jest.json
+tsconfig.json
+tslint.json
+yarn.lock
+*.log

.npmignore

@@ -0,0 +1,6 @@
+{
+  "parser": "typescript",
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 150
+}

.prettierrc

@@ -1,9 +1,8 @@
 language: node_js
 
 node_js:
-  - "9"
+  - "10"
   - "8"
-  - "7"
 
 script:
   - yarn test --coverage

.travis.yml

@@ -1,94 +1,65 @@
-Node p7zip wrapper
-==================
+# Node p7zip
 
 [![travis build](https://img.shields.io/travis/jbdemonte/node-p7zip.svg)](https://travis-ci.org/jbdemonte/node-p7zip)
 [![Coverage Status](https://coveralls.io/repos/github/jbdemonte/node-p7zip/badge.svg?branch=master)](https://coveralls.io/github/jbdemonte/node-p7zip?branch=master)
-[![NPM Version](https://img.shields.io/npm/v/p7zip.svg)](https://www.npmjs.com/package/p7zip)
 ![node (tag)](https://img.shields.io/node/v/p7zip/latest.svg)
 
+## Description
 
-A node wrapper for p7zip including the latest version of `7za`.
+Use `p7zip` directly in JavaScript or TypeScript.  
 
-Limitation
-----------
+You do not need to install anything by your own.  
 
-Because p7zip is a portage of 7-zip for linux systems, this package is not usable on Windows.
+During the installation process, the latest version of [p7zip](https://github.com/jbdemonte/p7zip) is compiled to be used.
 
-Description
------------
+## Limitation
 
-During the installation process, the latest version of [p7zip](https://github.com/jbdemonte/p7zip) is compiled to be used.
-This module handle both callback and promise syntax.
+Because p7zip is a portage of 7-zip for linux systems, this package is not usable on Windows.
 
-Installation
-------------
+## Installation
 
 ```
 npm install --save p7zip
 ```
-
-
-Usage
------
+or
 ```
-var p7zip = require('p7zip');
-
-p7zip
-  .add('test.7z', '*.js')
-  .then(function (count) {
-    console.log('File added: ', count);
-  })
-  .then(function () {
-    return p7zip.list('test.7z');
-  })
-  .then(function (data) {
-    console.log('Path: ', data.path);
-    console.log('Type: ', data.type);
-    console.log('Method: ', data.method);
-
-    data.files.forEach(function (file, index) {
-      console.log('\nFile #' + (index + 1));
-      console.log(file.name);
-      console.log(file.date);
-    });
-  })
-  .catch(function (err) {
-    console.log(err);
-  });
+yarn add p7zip
 ```
 
-Promise library use node Promise, but may be replaced:
 
-```
-var p7zip = require('p7zip');
+## Usage
 
-p7zip.Promise = require('bluebird');
 ```
+import * as p7zip from 'p7zip';
 
 
-API
----
+const count = await p7zip.add('test.7z', '*.js');
+console.log('File added: ', count);
 
-### p7zip.add
+const content = await p7zip.read('test.7z');
+console.log('Path: ', content.path);
+console.log('Type: ', content.type);
+console.log('Method: ', content.method);
 
-**Arguments**
- * `archive` The archive path.
- * `files` The file list to add (string or array of string).
- * `switches` Switches (string or array of string).
+for (const file of data.files) {
+  console.log(file.name, file.date);
+}
+
+await p7zip.extract('test.7z', './tmp')
+```
 
-**Returns**
- * `count` The file count added.
 
+## Methods
 
-### p7zip.delete
+### p7zip.add
 
 **Arguments**
  * `archive` The archive path.
- * `files` The file list to delete (string or array of string).
+ * `files` The file list to add (string or array of string).
  * `switches` Switches (string or array of string).
 
 **Returns**
- * none
+ * `count` The file count added.
 
 
 ### p7zip.extract
@@ -106,14 +77,14 @@ Default overwrite mode is set to "Overwrite All existing files without prompt" u
  * none
 
 
-### p7zip.list
+### p7zip.read
 
 **Arguments**
  * `archive` The archive path.
  * `switches` Switches (string or array of string).
 
 **Returns**
- * `data`           object
+ * `data`           Archive
 
  * `data.path`          string
  * `data.type`          string
@@ -122,26 +93,40 @@ Default overwrite mode is set to "Overwrite All existing files without prompt" u
  * `data.method`        string
  * `data.solid`         string
  * `data.blocks`        number
- * `data.directories`   array (same as `data.files`)
- * `data.files`         array
+ * `data.directories`   array of Entry
+ * `data.files`         array of Entry
 
+with Entry:
  * `data.files[].attr`          string
  * `data.files[].compressed`    number
  * `data.files[].date`          date
  * `data.files[].name`          number
  * `data.files[].size`          number
 
 
+### p7zip.remove
+
+**Arguments**
+ * `archive` The archive path.
+ * `files` The file list to delete (string or array of string).
+ * `switches` Switches (string or array of string).
+
+**Returns**
+ * none
+
+
 ### p7zip.rename
 
 **Arguments**
  * `archive` The archive path.
- * `files` Hashmap of the file list to rename ({oldName: newName, ...}.
+ * `oldName` The original name
+ * `newName` The replacement name
  * `switches` Switches (string or array of string).
 
 **Returns**
  * none
 
+
 ### p7zip.update
 
 **Arguments**

README.md

@@ -0,0 +1,27 @@
+{
+  "testEnvironment": "node",
+  "transform": {
+    "^.+\\.ts$": "ts-jest"
+  },
+  "modulePaths": [
+    "<rootDir>/src/"
+  ],
+  "moduleFileExtensions": [
+    "ts",
+    "js",
+    "json"
+  ],
+  "collectCoverageFrom" : [
+    "src/**/*.ts",
+    "!src/index.ts",
+    "!**/node_modules/**"
+  ],
+  "coverageReporters": ["json", "lcov"],
+  "coverageDirectory": "coverage",
+  "verbose": true,
+  "globals": {
+    "ts-jest": {
+      "tsConfig": "./tsconfig.json"
+    }
+  }
+}