Convert to ESM

.coderabbit.yaml

@@ -0,0 +1,11 @@
+
+reviews:
+  path_instructions:
+    - path: "**/*.js"
+      instructions: |
+        Review the JavaScript code against the Google JavaScript style guide and point out any mismatches
+    - path: "test/**.*"
+      instructions: |
+        Review the following unit test code written using the Mocha test library. Ensure that:
+        - The code adheres to best practices associated with Mocha.
+        - Descriptive test names are used to clearly convey the intent of each test.

.github/workflows/eslint.yml

@@ -31,7 +31,7 @@ jobs:
 
       - name: Install ESLint
         run: |
-          npm install eslint@8.56.0
+          npm install eslint@9.1.0
           npm install @microsoft/[email protected]
 
       - name: Run ESLint

.yarnrc.yml

@@ -4,4 +4,4 @@ enableGlobalCache: false
 
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.3.0.cjs
+yarnPath: .yarn/releases/yarn-4.3.1.cjs

README.md

@@ -6,7 +6,11 @@ Only works in Windows with Git For Windows installed. Not WSL.
 
 ## setup
 
-Assumption is the all the local clones are in the same folder. For instance, I keep my work in a folder named _projects_ and every clone exists in that folder including this repository. There's a setup script which exits/creates one's bash_profile & bashrc files (with backup). The changes to bashrc are: 
+Assumption is the all the local clones are in the same folder. For instance, I keep my work in a folder named _projects_ and every clone exists in that folder including this repository. There's a setup script which exits/creates one's bash_profile & bashrc files (with backup). The changes to bashrc are:
 
-1. Creation of a DEVROOT variable pointing to the parent folder where the repositories are kept. 
+1. Creation of a DEVROOT variable pointing to the parent folder where the repositories are kept.
 2. A source command to load in this repository's `src/bash.sh`
+
+## testing
+
+The unit tests are required to be run with the latest node engine supported. Run `node src/misc/scripts.js` to obtain the nodejs engines in use.

eslint.config.js

@@ -0,0 +1,102 @@
+import pluginJs from '@eslint/js';
+import globals from 'globals';
+const IndentSpaces = 4;
+
+export default [
+    pluginJs.configs.recommended
+    , {
+        files: [ '**/*.js' ]
+        , languageOptions: {
+            ecmaVersion: 2020
+            , globals: {
+                ...globals.es2020
+                , ...globals.node
+                , ...globals.mocha
+                , console: true
+                , process: true
+            }
+        }
+        , linterOptions : {
+            noInlineConfig: false
+        }
+        , plugins: {
+            pluginJs
+        }
+        , rules: {
+            'array-bracket-spacing': [ 'error', 'always' ]
+            , 'arrow-spacing': [ 'error', { 'before': true, 'after': true } ]
+            , 'block-scoped-var': 'error'
+            , 'brace-style': [ 'error', 'stroustrup' ]
+            , 'camelcase': 'error'
+            , 'comma-spacing': [ 'error', { 'after': true } ]
+            , 'comma-style': [ 'error', 'first' ]
+            , 'curly': [ 'warn' ]
+            , 'default-case': 'error'
+            , 'dot-location': [ 'error', 'property' ]
+            , 'dot-notation': [ 'error' ]
+            , 'eqeqeq': [ 'error', 'smart' ]
+            , 'func-call-spacing': [ 'error', 'never' ]
+            , 'handle-callback-err': 'error'
+            , 'indent': [ 'error', IndentSpaces, { 'MemberExpression': 1, 'ArrayExpression': 1, 'ObjectExpression': 1 } ]
+            , 'keyword-spacing': [ 'error', { 'overrides': { 'if': { 'after': false }, 'for': { 'after': false }, 'while': { 'after': false } } } ]
+            , 'line-comment-position': [ 'error', { 'position': 'above' } ]
+            , 'newline-per-chained-call': [ 'error', { 'ignoreChainWithDepth': 2 } ]
+            , 'no-alert': [ 'error' ]
+            , 'no-caller': 'error'
+            , 'no-console': 'warn'
+            , 'no-div-regex': 'error'
+            , 'no-duplicate-imports': [ 'error', { includeExports: true } ]
+            , 'no-else-return': [ 'error', { allowElseIf: false } ]
+            , 'no-empty-function': 'error'
+            , 'no-eq-null': 'error'
+            , 'no-floating-decimal': 'error'
+            , 'no-implicit-coercion': [ 'error' ]
+            , 'no-irregular-whitespace': [ 'error', { skipComments: true } ]
+            , 'no-lone-blocks': [ 'error' ]
+            , 'no-lonely-if': 'error'
+            , 'no-magic-numbers': [ 'error', { ignore: [ 2, 1, 0, -1 ], ignoreArrayIndexes: true } ]
+            , 'no-multi-spaces': 'error'
+            , 'no-param-reassign': [ 'error', { props: false } ]
+            , 'no-path-concat': 'error'
+            , 'no-return-await': 'error'
+            , 'no-script-url': 'error'
+            , 'no-self-compare': [ 'error' ]
+            , 'no-tabs': 'error'
+            , 'no-trailing-spaces': 'error'
+            , 'no-unneeded-ternary': [ 'error' ]
+            , 'no-unsafe-negation': [ 'error' ]
+            , 'no-unused-vars': [ 'error', { args: 'all', caughtErrors: 'all' } ]
+            , 'no-useless-return': 'error'
+            , 'no-var': 'error'
+            , 'no-whitespace-before-property': 'error'
+            , 'object-curly-spacing': [ 'error', 'always' ]
+            , 'one-var': [ 'error', { var: 'always', let: 'never', const: 'never' } ]
+            , 'prefer-const': 'error'
+            , 'prefer-destructuring': [
+                'error'
+                , {
+                    VariableDeclarator: {
+                        array: false
+                        , object: true,
+                    }
+                    , AssignmentExpression: {
+                        array: true
+                        , object: false,
+                    },
+                }
+                , {
+                    enforceForRenamedProperties: false,
+                }
+                , ]
+            , 'prefer-template': 'error'
+            , quotes: [ 'error', 'single', { allowTemplateLiterals: true } ]
+            , semi: [ 'error', 'always', { omitLastInOneLineBlock: true } ]
+            , 'space-before-blocks': [ 'error', 'always' ]
+            , 'space-in-parens': [ 'error', 'never' ]
+            , 'space-infix-ops': [ 'error' ]
+            , 'space-unary-ops': [ 'error', { words: true, nonwords: false } ]
+            , 'spaced-comment': [ 'error', 'always' ]
+            , yoda: 'error'
+        }
+    }
+];

jsconfig.json

@@ -1,8 +1,8 @@
 {
     "compilerOptions": {
-        "module": "commonjs",
+        "module": "NodeNext",
         "target": "esnext",
-        "checkJs": true
+        "checkJs": true,
     },
     "include": [
         "src/**/*.js",

package.json

@@ -1,7 +1,8 @@
 {
     "name": "my-dev-tools",
-    "version": "4.0.0",
+    "version": "5.0.0",
     "main": "",
+    "type": "module",
     "repository": "https://github.com/begin-again/dev-tools.git",
     "license": "MIT",
     "private": true,
@@ -15,24 +16,28 @@
     },
     "dependencies": {
         "dotenv": "^16.4.5",
-        "luxon": "^3.4.4",
-        "semver": "^7.6.2",
+        "luxon": "^3.5.0",
+        "semver": "^7.6.3",
         "shelljs": "^0.8.5",
-        "simple-git": "^3.25.0",
+        "simple-git": "^3.27.0",
         "uuid": "10.0.0",
         "yargs": "^17.7.2"
     },
     "devDependencies": {
-        "chai": "^4.4.1",
-        "eslint": "^8.56.0",
+        "@eslint/js": "^9.12.0",
+        "@types/mocha": "^10.0.8",
+        "@types/node": "^22.7.4",
+        "chai": "^4.5.0",
+        "eslint": "^9.12.0",
         "eslint-plugin-node": "^11.1.0",
-        "mocha": "10",
-        "mock-fs": "^5.2.0",
-        "nyc": "^17.0.0",
+        "globals": "^15.10.0",
+        "mocha": "^10.7.3",
+        "mock-fs": "^5.3.0",
+        "nyc": "^17.1.0",
         "proxyquire": "^2.1.3",
         "randomatic": "^3.1.1",
-        "sinon": "^18.0.0",
+        "sinon": "^18.0.1",
         "sinon-chai": "^3.7.0"
     },
-    "packageManager": "[email protected].0"
+    "packageManager": "[email protected].1"
 }

src/branches/branches.js

@@ -1,6 +1,6 @@
-const { basename } = require('path');
-const { options } = require('./cmdline');
-const { currentBranch, currentHash, commitDiffCounts, isDirty } = require('../common/git');
+import { basename } from 'node:path';
+import { options } from './cmdline.js';
+import { currentBranch, currentHash, commitDiffCounts, isDirty } from '../common/git.js';
 const hashLength = 7;
 
 /**
@@ -68,7 +68,7 @@ const branches = (repoPath) => {
         });
 };
 
-module.exports = {
+export {
     branches
     , report
 };

src/branches/cmdline.js

@@ -1,6 +1,5 @@
-
-const yargs = require('yargs');
-const { constants, accessSync, lstatSync } = require('fs');
+import { constants, accessSync, lstatSync } from 'node:fs';
+import yargs from 'yargs/yargs';
 
 const cmdKeys = {
     'folder-names': {
@@ -13,7 +12,7 @@ const cmdKeys = {
         alias: 'r'
         , describe: 'over ride the value in $DEVROOT'
         , type: 'string'
-        // eslint-disable-next-line no-process-env
+
         , default: process.env.DEVROOT
     }
     , 'fetch': {
@@ -71,7 +70,7 @@ const validateNoConflict = ({ folderNames, deploy }) => {
 const options = {};
 
 const setOptions = (test) => {
-    const argv = test || yargs
+    const argv = test || yargs(process.argv.slice(2))
         .options(cmdKeys)
         .help(true)
         .version(false)
@@ -85,14 +84,14 @@ const setOptions = (test) => {
         .check(validateNoConflict)
         .argv;
 
-    module.exports.options.root = argv.root;
-    module.exports.options.folderNames = argv.folderNames || [];
-    module.exports.options.fetch = argv.fetch;
-    module.exports.options.silent = argv.silent;
-    module.exports.options.deploy = argv.deploy;
+    options.root = argv.root;
+    options.folderNames = argv.folderNames || [];
+    options.fetch = argv.fetch;
+    options.silent = argv.silent;
+    options.deploy = argv.deploy;
 };
 
-module.exports = {
+export {
     options
     , setOptions
 };