Add ESLint configuration and refactor grefplus to use ES modules

begin-again · begin-again · commit 794d2334a79b · 2024-10-15T17:40:20.000-04:00
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,95 @@
+{
+    "parserOptions": {
+        "sourceType": "script",
+        "ecmaFeatures": {
+            "impliedStrict": true
+        },
+        "ecmaVersion": 2020
+    },
+    "extends": [ "eslint:recommended", "plugin:node/recommended" ],
+    "env": {
+        "node": true,
+        "mocha": true,
+        "es2020": true
+    },
+    "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",
+        "node/callback-return": "warn",
+        "node/global-require": "warn",
+        "node/no-deprecated-api": "warn",
+        "node/no-unpublished-require": "off"
+    }
+}
diff --git a/src/alias.sh b/src/alias.sh
@@ -11,7 +11,7 @@ alias ll='ls -ltrh'
 ## tools
 alias resource='source $HOME/.bashrc'
 alias clean='node $DEVROOT/dev-tools/src/clean/index.js'
-alias grefp='node $DEVROOT/dev-tools/src/grefplus'
+alias grefp='node $DEVROOT/dev-tools/src/grefplus/index.mjs'
 alias branches='node $DEVROOT/dev-tools/src/branches'
 alias nt='node $DEVROOT/dev-tools/src/node-tools'
 alias yn='node $DEVROOT/dev-tools/src/yarn'
diff --git a/src/grefplus/.eslintrc.json b/src/grefplus/.eslintrc.json
@@ -0,0 +1,6 @@
+{
+    "extends": "../../.eslintrc.json",
+    "parserOptions": {
+        "sourceType": "module"
+    }
+}
diff --git a/src/grefplus/cmdline.mjs b/src/grefplus/cmdline.mjs
@@ -1,6 +1,6 @@
-const { accessSync, constants, lstatSync } = require('fs');
-const yargs = require('yargs');
-const { DateTime } = require('luxon');
+import { accessSync, constants, lstatSync } from 'node:fs';
+import yargs from 'yargs/yargs';
+import { DateTime } from 'luxon';
 
 const options = {
     dateOptions: 'yyyy-MM-dd hh:mm:ss a'
@@ -32,7 +32,7 @@ const cmdKeys = {
         alias: 'r'
         , describe: 'root folder of development environment (/c/blah/blah). Default is DEVROOT'
         , type: 'array'
-        // eslint-disable-next-line no-process-env
+
         , default: process.env.DEVROOT
     }
     , 'date': {
@@ -46,13 +46,14 @@ const cmdKeys = {
 /**
  * Validates from and to dates,
  *
- * @param {String} checkDate
+ * @param {string} checkDate
+ * @param {string} msg
  * @throws if date is not valid
  * @private
  */
 const validateDate = (checkDate, msg) => {
     try {
-        const parsed = DateTime.fromFormat(checkDate, options.allowedFormat);
+        const parsed = DateTime.fromFormat(checkDate.toString(), options.allowedFormat);
         if(!parsed.isValid) {
             throw new Error('unknown format');
         }
@@ -69,11 +70,11 @@ const validateDate = (checkDate, msg) => {
 /**
  * Aborts build if dev root path does not exist
  *
- * @param {String} devRoot
+ * @param {string[]} devRoot
  * @throws if path not accessible
  * @private
  */
-const validatePath = ({ devRoot }) => {
+const validatePath = (devRoot) => {
     let problematicRoot = null;
 
     devRoot.forEach(root => {
@@ -111,21 +112,23 @@ const isFuture = (checkDate) => {
 /**
  * Parse command line and configures options
  *
- * @param {Boolean} test - used for testing only
+ * @param {Boolean} [test] - used for testing only
  */
 const setOptions = (test) => {
-    const argv = test || yargs
+    const argv = test || yargs(process.argv.slice(2))
+        // @ts-ignore
         .options(cmdKeys)
         .version(false)
         .help(true)
         .strict(true)
         .check((_argv) => {
             // super secret shortcut
             if(!_argv.date && !_argv.fromDate && !_argv.toDate && Number.isInteger(_argv._[0])) {
+                const days = Number(_argv._[0]);
                 const _date = DateTime
-                    .fromFormat(_argv._[0], options.allowedFormat)
-                    .plus({ days: _argv._[0] })
-                    .format('MM/DD/YY');
+                    .fromFormat(days.toString(), options.allowedFormat)
+                    .plus({ days })
+                    .toFormat('MM/DD/YY');
                 _argv.date = _date;
             }
             else {
@@ -138,53 +141,66 @@ const setOptions = (test) => {
             }
             return true;
         })
-        .check(({ date }) => {
-            if(date) {
-                validateDate(date, '--date');
-                if(isFuture(date)) {
+        .check((argv) => {
+            /** @type {string} */
+            const dt = `${argv.date}` || '';
+            if(dt) {
+                validateDate(dt, '--date');
+                if(isFuture(dt)) {
                     throw new Error('--date cannot exceed current date');
                 }
             }
             return true;
         })
-        .check(({ fromDate }) => {
-            if(fromDate) {
-                validateDate(fromDate, '--from-date');
-                if(isFuture(fromDate)) {
+        .check((argv) => {
+            /** @type {string} */
+            const dt = `${argv.fromDate}` || '';
+            if(dt) {
+                validateDate(dt, '--from-date');
+                if(isFuture(dt)) {
                     throw new Error('--from-date cannot exceed current date');
                 }
             }
             return true;
         })
-        .check(({ toDate }) => {
-            if(toDate) {
-                validateDate(toDate, '--to-date');
+        .check((argv) => {
+            /** @type {string} */
+            const dt = `${argv.toDate}` || '';
+            if(dt) {
+                validateDate(dt, '--to-date');
             }
             return true;
         })
-        .check(({ folderNames }) => {
+        .check((argv) => {
+            const folderNames = Array.isArray(argv.folderNames) ? argv.folderNames : [];
             if(folderNames && !folderNames.length) {
                 throw new Error('--folder-names requires at least one name');
             }
             return true;
         })
-        .check(validatePath)
+        .check(argv => {
+            const devRoot = `${argv.devRoot}`;
+            return validatePath(devRoot);
+        })
         .argv;
 
+    // @ts-ignore
     if(argv.date) {
+        // @ts-ignore
         const date = DateTime.fromFormat(argv.date, options.allowedFormat);
-        module.exports.options.fromDate = date.startOf('day');
-        module.exports.options.toDate = date.endOf('day');
+        options.fromDate = date.startOf('day');
+        options.toDate = date.endOf('day');
     }
     else {
-        module.exports.options.fromDate = argv.fromDate ? DateTime.fromFormat(argv.fromDate, options.allowedFormat).startOf('day') : null;
-        module.exports.options.toDate = argv.toDate ? DateTime.fromFormat(argv.toDate, options.allowedFormat).endOf('day') : null;
+        // @ts-ignore
+        options.fromDate = argv.fromDate ? DateTime.fromFormat(argv.fromDate, options.allowedFormat).startOf('day') : null;
+        // @ts-ignore
+        options.toDate = argv.toDate ? DateTime.fromFormat(argv.toDate, options.allowedFormat).endOf('day') : null;
     }
-    module.exports.options.devRoot = argv.devRoot;
-    module.exports.options.folderNames = argv.folderNames || [];
+    // @ts-ignore
+    options.devRoot = argv.devRoot;
+    // @ts-ignore
+    options.folderNames = argv.folderNames || [];
 };
 
-module.exports = {
-    options
-    , setOptions
-};
+export { options, setOptions };
diff --git a/src/grefplus/index.mjs b/src/grefplus/index.mjs
