Add eslint and semantic-release

Author: Shadi Abu Hilal

.eslintignore

@@ -0,0 +1,7 @@
+node_modules
+coverage
+docs
+.editorconfig
+.DS_Store
+.gitignore
+index.cjs

.eslintrc.json

@@ -0,0 +1,168 @@
+{
+    "env": {
+        "node": true,
+        "es6": true
+    },
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "extends": "eslint:recommended",
+    "rules": {
+        "camelcase": "off",
+        "consistent-return": "off",
+        "vars-on-top": "off",
+        "new-cap": "off",
+        "no-console": "off",
+        "no-constant-condition": "error",
+        "no-empty": "off",
+        "no-native-reassign": "off",
+        "no-underscore-dangle": "off",
+        "no-undef": [
+            "error",
+            {
+                "typeof": false
+            }
+        ],
+        "no-process-exit": "off",
+        "no-unused-expressions": "off",
+        "no-regex-spaces": "off",
+        "no-catch-shadow": "off",
+        "no-lonely-if": "off",
+        "brace-style": [
+            "warn",
+            "stroustrup"
+        ],
+        "no-shadow": [
+            "warn",
+            {
+                "allow": [
+                    "err",
+                    "done"
+                ]
+            }
+        ],
+        "no-unused-vars": [
+            "warn",
+            {
+                "vars": "all",
+                "varsIgnorePattern": "^internals$",
+                "args": "none"
+            }
+        ],
+        "one-var": [
+            "error",
+            "never"
+        ],
+        "handle-callback-err": [
+            "error",
+            "^(e|err|error)$"
+        ],
+        "array-bracket-spacing": "warn",
+        "dot-notation": "warn",
+        "eol-last": "warn",
+        "no-trailing-spaces": "warn",
+        "no-eq-null": "warn",
+        "no-extend-native": "warn",
+        "no-redeclare": "warn",
+        "no-loop-func": "warn",
+        "yoda": [
+            "warn",
+            "never"
+        ],
+        "sort-vars": "warn",
+        "arrow-parens": [
+            "error",
+            "always"
+        ],
+        "arrow-spacing": [
+            "error",
+            {
+                "before": true,
+                "after": true
+            }
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "consistent-this": [
+            "error",
+            "self"
+        ],
+        "new-parens": "error",
+        "no-array-constructor": "error",
+        "no-new-object": "error",
+        "no-spaced-func": "error",
+        "no-mixed-spaces-and-tabs": "error",
+        "keyword-spacing": [
+            "error",
+            {
+                "before": true,
+                "after": true
+            }
+        ],
+        "semi": [
+            "error",
+            "always"
+        ],
+        "semi-spacing": [
+            "error",
+            {
+                "before": false,
+                "after": true
+            }
+        ],
+        "space-infix-ops": "error",
+        "space-unary-ops": [
+            "warn",
+            {
+                "words": true,
+                "nonwords": false
+            }
+        ],
+        "strict": [
+            "error",
+            "global"
+        ],
+        "eqeqeq": "error",
+        "curly": [
+            "error",
+            "all"
+        ],
+        "no-eval": "error",
+        "no-else-return": "error",
+        "no-return-assign": "error",
+        "no-new-wrappers": "error",
+        "comma-dangle": [
+            "error",
+            "never"
+        ],
+        "no-sparse-arrays": "error",
+        "no-ex-assign": "error",
+        "indent": [
+            "error",
+            4,
+            {
+                "SwitchCase": 1
+            }
+        ],
+        "space-before-function-paren": [
+            "error",
+            {
+                "anonymous": "always",
+                "named": "never"
+            }
+        ],
+        "func-style": [
+            "error",
+            "expression"
+        ],
+        "object-curly-spacing": [
+            "error",
+            "always"
+        ],
+        "no-unsafe-finally": "error",
+        "no-useless-computed-key": "error"
+    }
+}

.npmignore

@@ -4,3 +4,4 @@ docs/
 .nyc_output
 .jsdoc.json
 README.md
+.releaserc.json

.releaserc.json

@@ -0,0 +1,11 @@
+{
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/git",
+      "@semantic-release/github"
+    ]
+  }
+  

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "dbaeumer.vscode-eslint"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": true
+    },
+    "editor.formatOnSave": false,
+    "editor.tabSize": 4,
+    "editor.detectIndentation": false
+}

docs/global.html

@@ -1286,7 +1286,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Dec 06 2023 17:48:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Dec 06 2023 18:05:11 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/index.html

@@ -76,7 +76,7 @@ <h3> </h3>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Dec 06 2023 17:48:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Dec 06 2023 18:05:11 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/index.js.html

@@ -135,7 +135,7 @@ <h1 class="page-title">index.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Dec 06 2023 17:48:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Dec 06 2023 18:05:11 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

index.js

@@ -3,9 +3,9 @@
  * @description Supported JSON content type values ['application/json', 'application/problem+json', 'application/vnd.api+json', 'application/hal+json'].
  */
 const jsonContentTypes = [
-    'application/json', 
-    'application/problem+json', 
-    'application/vnd.api+json', 
+    'application/json',
+    'application/problem+json',
+    'application/vnd.api+json',
     'application/hal+json'
 ];
 
@@ -17,21 +17,21 @@ const jsonContentTypes = [
  * @param {string} req.headers."content-type" - Http request content-type header
  * @returns {boolean}
  */
-export const isJsonReq = (req)=> {
+export const isJsonReq = (req) => {
     const contentType = req && req.headers && req.headers['content-type'];
 
     const normalizedContentType = contentType && contentType.toLowerCase();
 
-    if (normalizedContentType && jsonContentTypes.some((value)=> normalizedContentType.includes(value))) {
+    if (normalizedContentType && jsonContentTypes.some((value) => normalizedContentType.includes(value))) {
         return true;
     }
 
     return false;
 };
 
-const checkMethod = (req, method)=> {
+const checkMethod = (req, method) => {
     const normalizedReqMethod  = req && req.method && req.method && req.method.toLowerCase();
-    
+
     if (normalizedReqMethod === method) {
         return true;
     }
@@ -46,16 +46,16 @@ const checkMethod = (req, method)=> {
  * @param {string} req.method - Http request method string
  * @returns {boolean}
  */
-export const isGetReq = (req)=> checkMethod(req, 'get');
+export const isGetReq = (req) => checkMethod(req, 'get');
 
 /**
- * @function 
+ * @function
  * @description Function that check if current request is a http POST method request or not.
  * @param {Object} req - Http request object
  * @param {string} req.method - Http request method string
  * @returns {boolean}
  */
-export const isPostReq = (req)=> checkMethod(req, 'post');
+export const isPostReq = (req) => checkMethod(req, 'post');
 
 /**
  * @function
@@ -64,13 +64,13 @@ export const isPostReq = (req)=> checkMethod(req, 'post');
  * @param {string} req.method - Http request method string
  * @returns {boolean}
  */
-export const isPutReq = (req)=> checkMethod(req, 'put');
+export const isPutReq = (req) => checkMethod(req, 'put');
 
 /**
- * @function 
+ * @function
  * @description Function that check if current request is a http DELETE method request or not.
  * @param {Object} req - Http request object
  * @param {string} req.method - Http request method string
  * @returns {boolean}
  */
-export const isDeleteReq = (req)=> checkMethod(req, 'delete');
+export const isDeleteReq = (req) => checkMethod(req, 'delete');