fix: use export default instead of module exports

chore(deps): bump npm packages chore: add husky, commitlint, standard version docs: update usage for new export default syntax
maitrungduc1410 · Jul 8, 2021 · 0bfbc8c · 0bfbc8c
1 parent 2f9a066
commit 0bfbc8c
Show file tree

Hide file tree

Showing 8 changed files with 2,263 additions and 81 deletions.
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit "$1"
diff --git a/.npmignore b/.npmignore
@@ -3,4 +3,5 @@ src
 .git*
 tsconfig.json
 tslint.json
-test.js
+test.js
+.github
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 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.7](#) (2020-09-18)
 ### Features
 - Add authentication using `privateKey`

diff --git a/README.md b/README.md
@@ -32,9 +32,13 @@ yarn add node-scp
 ## Scp file from local to remote server
 Using `Promise`
 ```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',
   port: 22,
   username: 'username',
@@ -52,11 +56,15 @@ scp({
 
 Using `async/await`:
 ```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',
       port: 22,
       username: 'username',
@@ -79,9 +87,13 @@ test()
 ## Scp file from remote server to local
 Using `Promise`
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
+
+// with ES Module
+import { Client } from 'node-scp'
 
-scp({
+Client({
   host: 'your host',
   port: 22,
   username: 'username',
@@ -99,11 +111,15 @@ scp({
 
 Using `async/await`:
 ```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',
       port: 22,
       username: 'username',
@@ -124,9 +140,13 @@ test()
 ## Scp a directory from local to remote server
 Using `Promise`
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
+
+// with ES Module
+import { Client } from 'node-scp'
 
-scp({
+Client({
   host: 'your host',
   port: 22,
   username: 'username',
@@ -144,11 +164,15 @@ scp({
 
 Using `async/await`:
 ```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',
       port: 22,
       username: 'username',
@@ -169,9 +193,13 @@ test()
 ## Scp a directory from remote server to local
 Using `Promise`
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
+
+// with ES Module
+import { Client } from 'node-scp'
 
-scp({
+Client({
   host: 'your host',
   port: 22,
   username: 'username',
@@ -189,11 +217,15 @@ scp({
 
 Using `async/await`:
 ```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',
       port: 22,
       username: 'username',
@@ -214,9 +246,13 @@ test()
 ## Create a directory on remote server
 Using `Promise`
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
+
+// with ES Module
+import { Client } from 'node-scp'
 
-scp({
+Client({
   host: 'your host',
   port: 22,
   username: 'username',
@@ -234,11 +270,15 @@ scp({
 
 Using `async/await`:
 ```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',
       port: 22,
       username: 'username',
@@ -259,9 +299,13 @@ test()
 ## Check if a path exists on remote server
 Using `Promise`
 ```js
-const scp = require('node-scp')
+// with commonJS
+const { Client } = require('node-scp')
+
+// with ES Module
+import { Client } from 'node-scp'
 
-scp({
+Client({
   host: 'your host',
   port: 22,
   username: 'username',
@@ -280,10 +324,14 @@ scp({
 
 Using `async/await`:
 ```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',
       port: 22,
       username: 'username',
@@ -305,9 +353,13 @@ test()
 ## Get stats of a path on remote server
 Using `Promise`
 ```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',
   port: 22,
   username: 'username',
@@ -326,11 +378,15 @@ scp({
 
 Using `async/await`:
 ```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',
       port: 22,
       username: 'username',
@@ -352,9 +408,13 @@ test()
 ## List all files in remote directory
 Using `Promise`
 ```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',
   port: 22,
   username: 'username',
@@ -373,11 +433,15 @@ scp({
 
 Using `async/await`:
 ```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',
       port: 22,
       username: 'username',
@@ -399,9 +463,13 @@ test()
 ## Convert relative path to absolute path on remote server
 Using `Promise`
 ```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',
   port: 22,
   username: 'username',
@@ -420,11 +488,15 @@ scp({
 
 Using `async/await`:
 ```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',
       port: 22,
       username: 'username',

diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']}