feat(init): updated using generator-node-mdl v2.6.0 🔥

.esdoc.json

@@ -0,0 +1,38 @@
+{
+  "source": "./src",
+  "destination": "./docs",
+  "excludes": ["__mocks__"],
+  "plugins": [
+    {
+      "name": "esdoc-standard-plugin",
+      "option": {
+        "lint": { "enable": true },
+        "accessor": {
+          "access": ["public", "protected"],
+          "autoPrivate": true
+        },
+        "undocumentIdentifier": { "enable": false },
+        "unexportedIdentifier": { "enable": false },
+        "typeInference": { "enable": true },
+        "manual": {
+          "index": "./readme.md",
+          "globalIndex": true,
+          "files": [
+            "./other/examples.md",
+            "./contributing.md",
+            "./other/code_of_conduct.md",
+            "./other/roadmap.md"
+          ]
+        },
+        "test": {
+          "source": "./src",
+          "interfaces": ["describe", "it", "context", "suite", "test"],
+          "includes": ["\\.test\\.js$"]
+        }
+      }
+    }, {
+      "name": "esdoc-ecmascript-proposal-plugin",
+      "option": { "all": true }
+    }
+  ]
+}

.eslintignore

@@ -1,4 +1,5 @@
 coverage/
 dist/
+docs/
 package-lock.json
 package.json

.gitignore

@@ -59,3 +59,6 @@ typings/
 
 # compiled
 dist
+
+# Docs
+docs

.npmignore

@@ -1,6 +1,9 @@
 # Source
 ./src
 
+# Docs
+./docs
+
 # Test files
 *test.*.*
 

.travis.yml

@@ -22,7 +22,13 @@ jobs:
       node_js: 12
       script: yarn build
       deploy:
-        provider: script
-        skip_cleanup: true
-        script: yarn semantic-release
+        - provider: script
+          skip_cleanup: true
+          script: yarn semantic-release
+        - provider: pages
+          skip_cleanup: true
+          github_token: $GH_TOKEN
+          local_dir: ./docs
+          keep_history: true
+
 

contributing.md

@@ -28,6 +28,20 @@ Run test suits to validate the project is working:
 
 ```sh
 yarn test
+# run test in watch mode
+yarn test:watch
+```
+
+Build the project:
+
+```sh
+yarn build
+# only build the dist folder from source
+yarn build:babel
+# only build the docs using esdocs
+yarn build:docs
+# build docs in watch mode
+yarn develop:docs
 ```
 
 Run linter to validate the project code:
@@ -46,8 +60,6 @@ yarn lint:commit
 ```
 
 
-## Committing and Pushing changes
-
 ## Committing and Pushing changes
 
 Create a branch and start hacking:

package.json

@@ -14,7 +14,10 @@
   },
   "scripts": {
     "prebuild": "rimraf dist",
-    "build": "babel src --out-dir dist --ignore **/*.test.js",
+    "build": "yarn build:babel && yarn build:docs",
+    "build:babel": "babel src --out-dir dist --ignore **/*.test.js",
+    "build:docs": "esdoc -c .esdoc.json",
+    "develop:docs": "watch \"yarn build:docs\" . --ignoreDirectoryPattern='/node_modules|docs|dist|coverage|.git|.nyc*./'",
     "test:watch": "jest --watch",
     "test": "jest --coverage",
     "coveralls": "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
@@ -41,6 +44,9 @@
     "babel-plugin-add-module-exports": "^1.0.0",
     "commitlint-config-cz": "^0.12.0",
     "coveralls": "^3.0.2",
+    "esdoc": "^1.1.0",
+    "esdoc-ecmascript-proposal-plugin": "^1.0.0",
+    "esdoc-standard-plugin": "^1.0.0",
     "eslint": "^6.1.0",
     "eslint-config-prettier": "^6.0.0",
     "eslint-config-standard": "^13.0.1",

src/index.js

@@ -1 +1,6 @@
+/**
+ * Return the passed argument as is.
+ * @param  {String} [input='No args passed!'] input argument to return.
+ * @return {String} return the recived import.
+ */
 export default (input = 'No args passed!') => input;