node-scp - npm Package Compare versions

Comparing version 0.0.14 to 0.0.15

CHANGELOG.md

@@ -0,1 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### 0.0.15 (2021-07-08)
+
+
+### Features
+
+* add download for remote dir ([e9ea319](https://github.com/maitrungduc1410/node-scp-async/commit/e9ea319cbe09b1202baa684e5077c01bac32d284))
+* add support for readyTimeout and keepalive ([0fc1742](https://github.com/maitrungduc1410/node-scp-async/commit/0fc1742819776cbae6ae6623cdce4b6e2de21cb5))
+
+
+### Bug Fixes
+
+* use export default instead of module exports ([0bfbc8c](https://github.com/maitrungduc1410/node-scp-async/commit/0bfbc8c87088c9184b6c485231ea6fb7a585484e))
+
 # [0.0.7](#) (2020-09-18)
@@ -2,0 +19,0 @@ ### Features

lib/index.d.ts

@@ -42,1 +42,2 @@ /// <reference types="node" />
 export declare function Client(options: IScpOptions): Promise<ScpClient>;
+export default Client;

lib/index.js

@@ -10,2 +10,4 @@ "use strict";
     return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
         extendStatics(d, b);
@@ -590,2 +592,2 @@ function __() { this.constructor = d; }
 exports.Client = Client;
-module.exports = Client;
+exports.default = Client;

lib/types.js

@@ -10,2 +10,4 @@ "use strict";
     return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
         extendStatics(d, b);
@@ -12,0 +14,0 @@ function __() { this.constructor = d; }

package.json

@@ -5,3 +5,3 @@ {
   "description": "Lightweight, fast and secure SCP function for NodeJS",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "main": "lib/index.js",
@@ -35,12 +35,17 @@ "types": "lib/index.d.ts",
     "watch": "tsc -w",
-    "prepublish": "npm --no-git-tag-version version patch && git add .",
-    "build": "tsc"
+    "build": "tsc",
+    "release": "standard-version"
   },
   "dependencies": {
-    "ssh2": "^0.8.9"
+    "ssh2": "^1.1.0"
   },
   "devDependencies": {
-    "@types/ssh2": "^0.5.44",
-    "typescript": "^4.0.2"
+    "@commitlint/cli": "^12.1.4",
+    "@commitlint/config-conventional": "^12.1.4",
+    "@types/node": "^16.0.1",
+    "@types/ssh2": "^0.5.47",
+    "husky": "^7.0.1",
+    "standard-version": "^9.3.0",
+    "typescript": "^4.3.5"
   }
 }

README.md

@@ -35,5 +35,9 @@ # New SCP module for NodeJS
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
-scp({
+// with ES Module
+import { Client } from 'node-scp'
+
+Client({
   host: 'your host',
@@ -56,7 +60,11 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
+// with ES Module
+import { Client } from 'node-scp'
+
 async function test() {
   try {
-    const client = await scp({
+    const client = await Client({
       host: 'your host',
@@ -84,5 +92,9 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
-scp({
+// with ES Module
+import { Client } from 'node-scp'
+
+Client({
   host: 'your host',
@@ -105,7 +117,11 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
+// with ES Module
+import { Client } from 'node-scp'
+
 async function test () {
   try {
-    const client = await scp({
+    const client = await Client({
       host: 'your host',
@@ -131,5 +147,9 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
-scp({
+// with ES Module
+import { Client } from 'node-scp'
+
+Client({
   host: 'your host',
@@ -152,7 +172,11 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
+// with ES Module
+import { Client } from 'node-scp'
+
 async funtion test () {
   try {
-    const client = await scp({
+    const client = await Client({
       host: 'your host',
@@ -178,5 +202,9 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
-scp({
+// with ES Module
+import { Client } from 'node-scp'
+
+Client({
   host: 'your host',
@@ -199,7 +227,11 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
+// with ES Module
+import { Client } from 'node-scp'
+
 async funtion test () {
   try {
-    const client = await scp({
+    const client = await Client({
       host: 'your host',
@@ -225,5 +257,9 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
-scp({
+// with ES Module
+import { Client } from 'node-scp'
+
+Client({
   host: 'your host',
@@ -246,7 +282,11 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
+// with ES Module
+import { Client } from 'node-scp'
+
 async function test() {
   try {
-    const client = await scp({
+    const client = await Client({
       host: 'your host',
@@ -272,5 +312,9 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
-scp({
+// with ES Module
+import { Client } from 'node-scp'
+
+Client({
   host: 'your host',
@@ -294,6 +338,10 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
+
+// with ES Module
+import { Client } from 'node-scp'
 async function test() {
   try {
-    const client = await scp({
+    const client = await Client({
       host: 'your host',
@@ -320,5 +368,9 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
-scp({
+// with ES Module
+import { Client } from 'node-scp'
+
+Client({
   host: 'your host',
@@ -342,7 +394,11 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
+// with ES Module
+import { Client } from 'node-scp'
+
 async function test() {
   try {
-    const client = await scp({
+    const client = await Client({
       host: 'your host',
@@ -369,5 +425,9 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
-scp({
+// with ES Module
+import { Client } from 'node-scp'
+
+Client({
   host: 'your host',
@@ -391,7 +451,11 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
+// with ES Module
+import { Client } from 'node-scp'
+
 async function test() {
   try {
-    const client = await scp({
+    const client = await Client({
       host: 'your host',
@@ -418,5 +482,9 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
-scp({
+// with ES Module
+import { Client } from 'node-scp'
+
+Client({
   host: 'your host',
@@ -440,7 +508,11 @@ port: 22,
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
 
+// with ES Module
+import { Client } from 'node-scp'
+
 async function test() {
   try {
-    const client = await scp({
+    const client = await Client({
       host: 'your host',
@@ -477,4 +549,5 @@ port: 22,
 - **keepaliveCountMax** - *integer* -  How many consecutive, unanswered SSH-level keepalive packets that can be sent to the server before disconnection (similar to OpenSSH's ServerAliveCountMax config option). **Default**: `3`
-**Default authentication method order**: None -> Password -> Private Key
+- **remoteOsType** - string (value: `posix` | `win32`): use backslash `\` for Windows or slash `/` on posix system (Linux, MacOS) when handling remote server path. **Default**: `posix`
+- **Default authentication method order**: None -> Password -> Private Key
 # Support
 If you like this project, give me 1 ⭐️

No alert changes

Improved metrics

Total package byte prevSize

87927

increased by3.46%

Number of package files

14

increased by16.67%

Lines of code

1716

increased by0.35%

Number of lines in readme file

534

increased by15.84%

Worsened metrics

Dev dependency count

7

increased by250%

Dependency changes

• + Addedbuildcheck@0.0.6(transitive)

• + Addedcpu-features@0.0.10(transitive)

• + Addednan@2.19.0(transitive)

• + Addedssh2@1.15.0(transitive)

• - Removedssh2@0.8.9(transitive)

• - Removedssh2-streams@0.4.10(transitive)

• - Removedstreamsearch@0.1.2(transitive)

• Updatedssh2@^1.1.0