@mimik/local 4.4.5 → 5.0.2

package/.eslintrc

@@ -11,8 +11,9 @@
   },
   "extends": "airbnb",
   "rules": {
-    "import/no-extraneous-dependencies": ["error", {"devDependencies": true}],
-    "brace-style": [1, "stroustrup", {"allowSingleLine": true}],
+    "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
+    "import/no-unresolved": ["error", { "amd": true, "commonjs": true, "caseSensitiveStrict": true }],
+    "brace-style": [1, "stroustrup", { "allowSingleLine": true }],
     "no-confusing-arrow": [0], // arrow isnt confusing
     "max-len": [1, 180, { "ignoreComments": true }],
     "linebreak-style": 0,
@@ -22,12 +23,11 @@
     "@mimik/document-env/validate-document-env": 2,
     "@mimik/dependencies/case-sensitive": 2,
     "@mimik/dependencies/no-cycles": 2,
-    "@mimik/dependencies/no-unresolved": 2,
     "@mimik/dependencies/require-json-ext": 2
   },
   "settings":{
     "react": {
-      "version": "latest"
+      "version": "detect"
     }
   },
   "globals": {

package/README.md

@@ -144,39 +144,13 @@ const local = require('@mimik/local');
 ```
 
 * [local](#module_local)
-    * _Gulp_
-        * [~test()](#module_local..test)
-        * [~lint()](#module_local..lint)
-        * [~docs()](#module_local..docs)
-    * _sync_
-        * [~mSTTestSetup()](#module_local..mSTTestSetup) ⇒
-        * [~mSTSetup()](#module_local..mSTSetup) ⇒
-        * [~testSetup()](#module_local..testSetup) ⇒
-        * [~setup()](#module_local..setup) ⇒
-        * [~testSetup()](#module_local..testSetup) ⇒
-        * [~setup()](#module_local..setup) ⇒
-
-<a name="module_local..test"></a>
-
-### local~test()
-Execute the test associated with that project. The test is under test/http-test.js.
+    * [~mSTTestSetup()](#module_local..mSTTestSetup) ⇒
+    * [~mSTSetup()](#module_local..mSTSetup) ⇒
+    * [~testSetup()](#module_local..testSetup) ⇒
+    * [~setup()](#module_local..setup) ⇒
+    * [~testSetup()](#module_local..testSetup) ⇒
+    * [~setup()](#module_local..setup) ⇒
 
-**Kind**: inner method of [<code>local</code>](#module_local)  
-**Category**: Gulp  
-<a name="module_local..lint"></a>
-
-### local~lint()
-Lint the files of the project.
-
-**Kind**: inner method of [<code>local</code>](#module_local)  
-**Category**: Gulp  
-<a name="module_local..docs"></a>
-
-### local~docs()
-Generate the README.md file for that project and add it to the git commit. The source to the file is in `./configuration/config.js`.
-
-**Kind**: inner method of [<code>local</code>](#module_local)  
-**Category**: Gulp  
 <a name="module_local..mSTTestSetup"></a>
 
 ### local~mSTTestSetup() ⇒

package/dotFiles/eslintrc.json

@@ -0,0 +1,64 @@
+{
+    "env": {
+      "node": true
+    },
+    "plugins": [
+      "@mimik/document-env",
+      "@mimik/dependencies"
+    ],
+    "extends": "airbnb",
+    "parserOptions": {
+      "ecmaVersion": 2020
+    },
+    "rules": {
+      "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
+      "import/no-unresolved": ["error", { "amd": true, "commonjs": true, "caseSensitiveStrict": true }],
+      "brace-style": [1, "stroustrup", { "allowSingleLine": true }],
+      "no-confusing-arrow": [0],
+      "max-len": [1, 180, { "ignoreComments": true }],
+      "linebreak-style": 0,
+      "quotes": [1, "single"],
+      "semi": [1, "always"],
+      "no-process-env": ["error"],
+      "@mimik/document-env/validate-document-env": 2,
+      "@mimik/dependencies/case-sensitive": 2,
+      "@mimik/dependencies/no-cycles": 2,
+      "@mimik/dependencies/require-json-ext": 2
+    },
+    "overrides": [
+      {
+        "files": [
+          "src/configuration/config.js",
+          "test/**/*.js",
+          "tools/**/*.js"
+        ],
+        "rules": {
+          "no-process-env": "off"
+        }
+      },
+      {
+        "files": [
+          "test/**/*.js",
+          "tools/**/*.js"
+        ],
+        "rules": {
+          "@mimik/document-env/validate-document-env": "off"
+        }
+      }
+    ],
+    "settings": {
+      "react": {
+        "version": "detect"
+      },
+    },
+    "globals": {
+      "module": true,
+      "require": true,
+      "const": false,
+      "it": false,
+      "describe": false,
+      "before": true,
+      "after": true,
+      "JSON": true
+    }
+  }

package/dotFiles/gitIgnore.txt

@@ -0,0 +1,63 @@
+# local
+*.sh
+local/start.json
+local/testStart.json
+package-lock.json
+test/.testConfig.json
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# sublime project
+*sublime*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+coverage
+mochawesome-reports
+mochawesome-report
+
+# Dependency directories
+node_modules
+jspm_packages
+api
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+#Webstorm configuration
+.idea
+
+#OAuth key, etc.
+.env
+
+#OSX
+.DS_Store
+
+#Windows
+start.*.bat
+
+# temp files
+*~

package/dotFiles/nycrc.json

@@ -0,0 +1,4 @@
+{
+    "exclude": ["gulpfile.js"],
+    "reporter": ["lcov", "text"]
+}

package/index.js

@@ -1,13 +1,6 @@
 /* eslint-disable prefer-template, no-console */
 const fs = require('fs');
 const path = require('path');
-const log = require('fancy-log');
-const gulp = require('gulp');
-const env = require('gulp-env');
-const eslint = require('gulp-eslint');
-const git = require('gulp-git');
-const jsdoc2md = require('jsdoc-to-markdown');
-const mocha = require('gulp-spawn-mocha');
 const _ = require('lodash');
 
 const { commitCheckMsg } = require('@mimik/git-hooks');
@@ -18,6 +11,9 @@ const {
   start2env,
   start2shell,
   baseUrl,
+  read,
+  write,
+  parse,
 } = require('./lib/helpers');
 const {
   defaultDirectory,
@@ -49,6 +45,8 @@ colors.setTheme({
   info: ['grey', 'bold'],
 });
 
+const INSTALL = 'install';
+
 /**
  * @module local
  * @example
@@ -620,142 +618,23 @@ const rootPath = (pathName, ignore) => {
   if (ignore) return `${IGNORE}${rootDir}`;
   return rootDir;
 };
-const files = [
-  rootPath('src/**/*.js'),
-  rootPath('Gulpfile.js'),
-  rootPath('local/**.js'),
-  rootPath('test/**/*.js'),
-  rootPath('tools/**/*.js'),
-  rootPath('tools/**/{node_modules,node_modules/**}', true),
-];
-
-/**
- *
- * Gulp function for local project: test.
- *
- * @function test
- * @category Gulp
- *
- * @description Execute the test associated with that project. The test is under test/http-test.js.
- */
-const test = () => {
-  const envs = env({ file: rootPath('server-test.json') });
-
-  return gulp.src([rootPath('test/http-test.js')], { allowEmpty: true })
-    .pipe(envs)
-    .pipe(mocha({
-      reporter: 'mochawesome',
-      exit: true,
-    }))
-    .pipe(envs.reset);
-};
-
-/**
- *
- * Gulp function for local project: lint.
- *
- * @function lint
- * @category Gulp
- *
- * @description Lint the files of the project.
- */
-const lint = () => gulp.src(files, { allowEmpty: true })
-  .pipe(eslint({}))
-  .pipe(eslint.format());
 
-const createDocs = (done) => {
-  jsdoc2md.render({ files: rootPath('src/configuration/config.js') })
-    .then((output) => fs.writeFileSync(rootPath('README.md'), output))
-    .catch((err) => log.error('docs creation failed:', err.message))
-    .finally(() => done());
+const dotFiles = () => {
+  write(rootPath('.eslintrc'), parse(read(path.join(__dirname, 'dotFiles', 'eslintrc.json'), INSTALL)), 'eslintrc.json', INSTALL, true);
+  write(rootPath('.nycrc'), parse(read(path.join(__dirname, 'dotFiles', 'nycrc.json'), 'nycrc.json', INSTALL)), INSTALL, true);
+  write(rootPath('.gitignore'), read(path.join(__dirname, 'dotFiles', 'gitIgnore.txt'), INSTALL), INSTALL);
 };
 
-const add = () => gulp.src(rootPath('README.md'))
-  .pipe(git.add({ quiet: true }));
-
-/**
- *
- * Gulp function for local project: docs.
- *
- * @function docs
- * @category Gulp
- *
- * @description Generate the README.md file for that project and add it to the git commit. The source to the file is in `./configuration/config.js`.
- */
-const docs = gulp.series(createDocs, add);
-
-const dotFiles = () => {
-  const eslintrc = {
-    env: {
-      node: true,
-    },
-    plugins: [
-      '@mimik/document-env',
-      '@mimik/dependencies',
-    ],
-    extends: 'airbnb',
-    parserOptions: {
-      ecmaVersion: 2020,
-    },
-    rules: {
-      'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
-      'brace-style': [1, 'stroustrup', { allowSingleLine: true }],
-      'no-confusing-arrow': [0], // arrow isnt confusing
-      'max-len': [1, 180, { ignoreComments: true }],
-      'linebreak-style': 0,
-      quotes: [1, 'single'],
-      semi: [1, 'always'],
-      'no-process-env': ['error'],
-      '@mimik/document-env/validate-document-env': 2,
-      '@mimik/dependencies/case-sensitive': 2,
-      '@mimik/dependencies/no-cycles': 2,
-      '@mimik/dependencies/no-unresolved': 2,
-      '@mimik/dependencies/require-json-ext': 2,
-    },
-    overrides: [
-      {
-        files: [
-          'src/configuration/config.js',
-          'test/**/*.js',
-          'tools/**/*.js',
-        ],
-        rules: {
-          'no-process-env': 'off',
-        },
-      },
-      {
-        files: [
-          'test/**/*.js',
-          'tools/**/*.js',
-        ],
-        rules: {
-          '@mimik/document-env/validate-document-env': 'off',
-        },
-      },
-    ],
-    settings: {
-      react: {
-        version: 'latest',
-      },
-    },
-    globals: {
-      module: true,
-      require: true,
-      const: false,
-      it: false,
-      describe: false,
-      before: true,
-      after: true,
-      JSON: true,
-    },
-  };
-  const nycrc = {
-    exclude: ['gulpfile.js'],
-    reporter: ['lcov', 'text'],
-  };
+const scripts = () => {
+  const packageFilename = rootPath('package.json');
+  const scriptsFile = parse(read(path.join(__dirname, 'scripts.json'), INSTALL), 'scripts.json', INSTALL);
+  const packageFile = parse(read(packageFilename, INSTALL), 'package.json', INSTALL);
 
-  fs.writeFileSync(rootPath('.eslintrc'), JSON.stringify(eslintrc, null, 2));
-  fs.writeFileSync(rootPath('.nycrc'), JSON.stringify(nycrc, null, 2));
+  Object.keys(scriptsFile.scripts).forEach((script) => {
+    packageFile.scripts[script] = scriptsFile.scripts[script];
+  });
+  packageFile.husky = scriptsFile.husky;
+  write(packageFilename, packageFile, 'package.json', INSTALL, true);
 };
 
 module.exports = {
@@ -765,10 +644,7 @@ module.exports = {
   mITSetup,
   testSetup,
   setup,
-  test,
-  lint,
-  docs,
-  add,
   dotFiles,
+  scripts,
   commitCheckMsg,
 };

package/lib/helpers.js

@@ -22,6 +22,31 @@ const exitError = (regType, error, filename) => {
   process.exit(1);
 };
 
+const read = (filename, regType) => {
+  let readFile;
+
+  try { readFile = fs.readFileSync(filename).toString(); }
+  catch (err) {
+    if (err.code !== 'ENOENT') return exitError(regType, err, filename);
+    throw err;
+  }
+  return readFile;
+};
+
+const write = (fname, origContent, regType, withJSON) => {
+  let content = origContent;
+
+  if (withJSON) content = json.stringify(content, null, 2);
+  try { fs.writeFileSync(fname, content); }
+  catch (err) { exitError(regType, err, fname); }
+  return content;
+};
+
+const parse = (rawFile, rawFilename, regType) => {
+  try { return json.parse(rawFile); }
+  catch (errParse) { return exitError(regType, errParse, rawFilename); }
+};
+
 const start2shell = (start) => {
   let result = '#!/bin/sh\n';
 
@@ -103,23 +128,7 @@ const baseUrl = (serverType, regType, config, literal) => {
 const retrieve = (regType, filename, options) => {
   let result;
 
-  const read = (fname) => {
-    let readFile;
-
-    try { readFile = json.parse(fs.readFileSync(fname).toString()); }
-    catch (err) {
-      if (err.code !== 'ENOENT') exitError(regType, err, fname);
-      throw err;
-    }
-    return readFile;
-  };
-
   const readMerge = (fname, fnameSupp) => {
-    const parse = (rawFile, rawFilename) => {
-      try { return json.parse(rawFile); }
-      catch (errParse) { return exitError(regType, errParse, rawFilename); }
-    };
-
     const merge = (origRawFile, parsedFile, origRawFileSupp, parsedFileSupp) => {
       const keysParsedFile = Object.keys(parsedFile);
       let rawFile = origRawFile;
@@ -137,30 +146,17 @@ const retrieve = (regType, filename, options) => {
       return `${rawFile},\n//-- test\n${rawFileSupp}`;
     };
 
-    let readFileRaw;
     let readFileSuppRaw;
-
-    try { readFileRaw = fs.readFileSync(fname).toString(); }
-    catch (errFname) {
-      if (errFname.code !== 'ENOENT') exitError(regType, errFname, fname);
-      throw errFname;
-    }
-    const readFile = parse(readFileRaw, fname);
+    const readFileRaw = read(fname, regType);
+    const readFile = parse(readFileRaw, fname, regType);
 
     if (!fnameSupp) return readFile;
-    try { readFileSuppRaw = fs.readFileSync(fnameSupp).toString(); }
+    try { readFileSuppRaw = read(fnameSupp, regType); }
     catch (errFnameSupp) {
-      if (errFnameSupp.code !== 'ENOENT') exitError(regType, errFnameSupp, fnameSupp);
       return readFile;
     }
 
-    return parse(merge(readFileRaw, readFile, readFileSuppRaw, parse(readFileSuppRaw, fnameSupp)), `${fname} + ${fnameSupp}`);
-  };
-
-  const write = (fname, content) => {
-    try { fs.writeFileSync(fname, json.stringify(content, null, 2)); }
-    catch (err) { exitError(regType, err, fname); }
-    return content;
+    return parse(merge(readFileRaw, readFile, readFileSuppRaw, parse(readFileSuppRaw, fnameSupp, regType)), `${fname} + ${fnameSupp}`, regType);
   };
 
   const readSourceDefault = (fSource, fSourceSupp, content, fname) => {
@@ -179,7 +175,7 @@ const retrieve = (regType, filename, options) => {
   };
 
   try {
-    result = read(filename);
+    result = parse(read(filename, regType), filename, regType);
     console.log('- using ' + filename.info);
     return result;
   }
@@ -187,7 +183,7 @@ const retrieve = (regType, filename, options) => {
     if (!options) exitError(regType, { statusCode: 404, message: `no options (${errFilename})` }, filename);
     if (options.altFilename) {
       try {
-        result = read(options.altFilename);
+        result = parse(read(options.altFilename, regType), options.altFilename, regType);
         console.log('- using ' + options.altFilename.info);
         return result;
       }
@@ -195,17 +191,17 @@ const retrieve = (regType, filename, options) => {
         if (!options.sourceFileName) {
           if (!options.default) exitError(regType, { statusCode: 404, message: `no files or default (${errAltFilename})` }, filename);
           console.log('- using ' + 'default'.warn + ' for ' + filename.info);
-          return write(filename, options.default);
+          return write(filename, options.default, regType);
         }
-        return write(filename, readSourceDefault(options.sourceFilename, options.sourceFilenameSupp, options.default, filename));
+        return write(filename, readSourceDefault(options.sourceFilename, options.sourceFilenameSupp, options.default, filename), regType);
       }
     }
     if (!options.sourceFilename) {
       if (!options.default) exitError(regType, { statusCode: 404, message: `no files or default (${errFilename.message})` }, filename);
       console.log('- using ' + 'default'.warn + ' for ' + filename.info);
-      return write(filename, options.default);
+      return write(filename, options.default, regType);
     }
-    return write(filename, readSourceDefault(options.sourceFilename, options.sourceFilenameSupp, options.default, filename));
+    return write(filename, readSourceDefault(options.sourceFilename, options.sourceFilenameSupp, options.default, filename), regType);
   }
 };
 
@@ -218,4 +214,7 @@ module.exports = {
   setDomainName,
   baseUrl,
   retrieve,
+  read,
+  write,
+  parse,
 };

package/manual-test/getAPI.js

@@ -1,3 +1,3 @@
 const start = require('../index');
 
-return start.getAPI('./testing', 'mimik', 'mDS', '1.1.1')
+start.getAPI('./testing', 'mimik', 'mDS', '1.1.1');

package/manual-test/retrieve.js

@@ -1,7 +1,8 @@
-const { retrieve }= require('../lib/helpers');
+/* eslint-disable no-console */
+const { retrieve } = require('../lib/helpers');
 
 // console.log(retrieve('test', 'test.json', { sourceFilename: './start-example.json', sourceFilenameSupp: 'startTest-example.json' } ));
 
 // console.log(retrieve('test', 'test.json'));
 // console.log(retrieve('test', 'test.json', { sourceFilename: './nonexistent.json', sourceFilenameSupp: 'startTest-example.json' }));
-console.log(retrieve('test', 'test.json', { sourceFilename: './start-example.json' } ));
+console.log(retrieve('test', 'test.json', { sourceFilename: './start-example.json' }));

package/manual-test/testMerge.js

@@ -1,3 +1,4 @@
+/* eslint-disable prefer-template, no-console, no-process-env */
 const colors = require('colors');
 const fs = require('fs');
 const json = require('comment-json');
@@ -21,46 +22,47 @@ const exitError = (regType, error, filename) => {
 const regType = 'test';
 
 const readMerge = (fname, fnameSupp) => {
-    const parse = (rawFile, rawFilename) => {
-      try { return json.parse(rawFile); }
-      catch (errParse) { exitError(regType, errParse, rawFilename); }
-    };
+  const parse = (rawFile, rawFilename) => {
+    try { return json.parse(rawFile); }
+    catch (errParse) {
+      return exitError(regType, errParse, rawFilename);
+    }
+  };
 
-    const merge = (origRawFile, parsedFile, origRawFileSupp, parsedFileSupp) => {
-      const keysParsedFile = Object.keys(parsedFile);
-      let rawFile = origRawFile;
-      let rawFileSupp = origRawFileSupp;
+  const merge = (origRawFile, parsedFile, origRawFileSupp, parsedFileSupp) => {
+    const keysParsedFile = Object.keys(parsedFile);
+    let rawFile = origRawFile;
+    let rawFileSupp = origRawFileSupp;
 
-      Object.keys(parsedFileSupp).forEach((key) => {
-        if (keysParsedFile.includes(key)) {
-          const regex = new RegExp(`\n[ \t]+"${key}"`);
+    Object.keys(parsedFileSupp).forEach((key) => {
+      if (keysParsedFile.includes(key)) {
+        const regex = new RegExp(`\n[ \t]+"${key}"`);
 
-          rawFile = rawFile.replace(regex, `\n// "${key}"`)
-        }
-      });
-      rawFile = rawFile.substring(0, rawFile.length - 2);
-      rawFileSupp = rawFileSupp.substring(1);
-      return `${rawFile},\n//-- test\n${rawFileSupp}`;
-    };
+        rawFile = rawFile.replace(regex, `\n// "${key}"`);
+      }
+    });
+    rawFile = rawFile.substring(0, rawFile.length - 2);
+    rawFileSupp = rawFileSupp.substring(1);
+    return `${rawFile},\n//-- test\n${rawFileSupp}`;
+  };
 
-    let readFileRaw;
-    let readFileSuppRaw;
+  let readFileRaw;
+  let readFileSuppRaw;
 
-    try { readFileRaw = fs.readFileSync(fname).toString(); }
-    catch (errFname) {
-      if (errFname.code !== 'ENOENT') exitError(regType, errFname, fname);
-      throw errFname;
-    }
-    const readFile = parse(readFileRaw, fname);
-  
-    try { readFileSuppRaw = fs.readFileSync(fnameSupp).toString(); }
-    catch (errFnameSupp) {
-      if (errFnameSupp.code !== 'ENOENT') exitError(regType, errFnameSupp, fnameSupp);
-      return readFile;
-    }
-   
-   return parse(merge(readFileRaw, readFile, readFileSuppRaw, parse(readFileSuppRaw, fnameSupp)), `${fname} + ${fnameSupp}`);
-  };
+  try { readFileRaw = fs.readFileSync(fname).toString(); }
+  catch (errFname) {
+    if (errFname.code !== 'ENOENT') exitError(regType, errFname, fname);
+    throw errFname;
+  }
+  const readFile = parse(readFileRaw, fname);
 
+  try { readFileSuppRaw = fs.readFileSync(fnameSupp).toString(); }
+  catch (errFnameSupp) {
+    if (errFnameSupp.code !== 'ENOENT') exitError(regType, errFnameSupp, fnameSupp);
+    return readFile;
+  }
+
+  return parse(merge(readFileRaw, readFile, readFileSuppRaw, parse(readFileSuppRaw, fnameSupp)), `${fname} + ${fnameSupp}`);
+};
 
-  console.log(json.stringify(readMerge('../../../mst-2297/local/start-example.json', '../../../mst-2297/local/startTest-example.json'), null, 2))
+console.log(json.stringify(readMerge('../../../mst-2297/local/start-example.json', '../../../mst-2297/local/startTest-example.json'), null, 2));

package/manual-test/testString.js

@@ -1,7 +1,8 @@
+/* eslint-disable no-console */
 const _ = require('lodash');
 
 const test = '  a, b  ,c,d  ';
-const allTest  = 'all '
+const allTest = 'all ';
 
 console.log(_.split(_.trim(test), /\s*,\s*/));
-console.log(_.split(_.trim(allTest), /\s*,\s*/));
+console.log(_.split(_.trim(allTest), /\s*,\s*/));

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@mimik/local",
-  "version": "4.4.5",
+  "version": "5.0.2",
   "description": "Local setup configuration for normal and test opreration",
   "main": "index.js",
   "scripts": {
-    "lint": "gulp lint",
-    "docs": "gulp docs",
-    "test": "exit 0",
-    "prepublishOnly": "gulp docs; gulp lint; npm run test",
-    "commit-ready": "gulp docs; gulp lint; npm run test",
+    "lint": "eslint --ignore-path .gitignore .",
+    "docs": "jsdoc2md index.js > README.md",
+    "test": "echo \"Error: no test specified\" && exit 0",
+    "test-ci": "echo \"Error: no test specified\" && exit 0",
+    "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
+    "commit-ready": "npm run docs && npm run lint && npm run test-ci",
     "prepare": "husky install"
   },
   "husky": {
@@ -22,43 +23,37 @@
     "microservice"
   ],
   "author": "mimik technology inc <support@mimik.com> (https://developer.mimik.com/)",
-  "license": "Apache-2.0",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://bitbucket.org/mimiktech/local"
   },
   "dependencies": {
-    "@mimik/eslint-plugin-dependencies": "2.4.1",
-    "@mimik/eslint-plugin-document-env": "1.0.1",
-    "@mimik/git-hooks": "1.5.3",
-    "axios": "0.24.0",
+    "@mimik/git-hooks": "1.5.4",
+    "axios": "0.27.2",
     "bluebird": "3.7.2",
-    "chai": "4.3.4",
     "colors": "1.4.0",
-    "comment-json": "4.1.1",
-    "debug": "4.3.3",
-    "eslint": "8.7.0",
-    "eslint-config-airbnb": "18.2.1",
-    "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-jsx-a11y": "6.5.1",
-    "eslint-plugin-react": "7.28.0",
-    "eslint-plugin-react-hooks": "4.3.0",
-    "fancy-log": "2.0.0",
-    "gulp": "4.0.2",
-    "gulp-env": "0.4.0",
-    "gulp-eslint": "6.0.0",
-    "gulp-git": "2.10.1",
-    "gulp-spawn-mocha": "6.0.0",
-    "ip": "1.1.5",
-    "jsdoc-to-markdown": "7.1.0",
+    "comment-json": "4.2.2",
+    "debug": "4.3.4",
+    "ip": "1.1.8",
     "lodash": "4.17.21",
-    "mocha": "9.1.4",
-    "mochawesome": "7.0.1",
+    "uuid": "8.3.2",
+    "@mimik/eslint-plugin-dependencies": "^2.4.3",
+    "@mimik/eslint-plugin-document-env": "^1.0.3",
+    "chai": "4.3.6",
+    "eslint": "8.16.0",
+    "eslint-config-airbnb": "19.0.4",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-jsx-a11y": "6.5.1",
+    "eslint-plugin-react": "7.30.0",
+    "eslint-plugin-react-hooks": "4.5.0",
+    "husky": "8.0.1",
+    "jsdoc-to-markdown": "7.1.1",
+    "mocha": "10.0.0",
+    "mochawesome": "7.1.3",
     "nyc": "15.1.0",
-    "supertest": "6.2.1",
-    "uuid": "8.3.2"
-  },
-  "devDependencies": {
-    "husky": "7.0.4"
+    "rewire": "6.0.0",
+    "sinon": "14.0.0",
+    "supertest": "6.2.3"
   }
 }

package/scripts.json

@@ -0,0 +1,21 @@
+{
+    "scripts": {
+        "lint": "eslint --ignore-path .gitignore .",
+        "docs": "jsdoc2md index.js > README.md",
+        "pretest": "node ./local/testSetup.js",
+        "test": "mocha --reporter mochawesome --bail --check-leaks test/",
+        "test-ci": "nyc --reporter=lcov --reporter=text npm test",
+        "prestart": "node ./local/setup.js",
+        "start": "sh server-start.sh",
+        "pre-push": "npm run docs && npm run lint && npm run test",
+        "pre-commit": "npm run docs && npm run lint",
+        "prepare": "husky install"
+    },
+    "husky": {
+        "hooks": {
+            "pre-commit": "npm run pre-commit",
+            "pre-push": "npm run pre-push",
+            "commit-msg": "node ./local/commitMsgCheck $1"
+        }
+    }
+}

package/Gulpfile.js

@@ -1,34 +0,0 @@
-/* eslint-disable import/no-extraneous-dependencies */
-const fs = require('fs');
-const log = require('fancy-log');
-const gulp = require('gulp');
-const eslint = require('gulp-eslint');
-const git = require('gulp-git');
-const jsdoc2md = require('jsdoc-to-markdown');
-
-const files = [
-  'index.js',
-  'Gulpfile.js',
-  'configuration/**/*.js',
-  'test/**/*.js',
-  'lib/**/*.js',
-];
-
-const createDocs = (done) => {
-  jsdoc2md.render({ files: 'index.js' })
-    .then((output) => fs.writeFileSync('README.md', output))
-    .catch((err) => log.error('docs creation failed:', err.message))
-    .finally(() => done());
-};
-
-const lint = () => gulp.src(files)
-  .pipe(eslint({}))
-  .pipe(eslint.format());
-
-const add = () => gulp.src('README.md')
-  .pipe(git.add({ quiet: true }));
-
-const docs = gulp.series(createDocs, add);
-
-gulp.task('docs', docs);
-gulp.task('lint', lint);