@shi-corp/development-utilities 1.1.0 → 2.0.1

package/README.md

@@ -1,4 +1,4 @@
-# Development Utilities [![Unit Test](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/Unit-Test.yml/badge.svg)](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/Unit-Test.yml) [![Lint Check](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/Lint.yml/badge.svg)](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/Lint.yml) [![CodeQL](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/github-code-scanning/codeql)
+# Development Utilities [![Unit Test](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/Test-Unit.yml/badge.svg)](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/Test-Unit.yml) [![Lint Check](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/Test-Lint.yml/badge.svg)](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/Test-Lint.yml) [![CodeQL](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/actions/workflows/github-code-scanning/codeql)
 
 Shared development-time configurations for TypeScript, ESLint (flat config), and Next.js. These utilities are dev-only and should not ship with application runtime artifacts.
 
@@ -22,7 +22,7 @@ in tsconfig.json make these changes
 
 ```jsonc
 {
-  "extends": "@shi-corp/development-utilities/config/baseTsConfig.json",
+  "extends": "@shi-corp/development-utilities/config/typescript/baseTsConfig.json",
   "compilerOptions": {
     "outDir": "./bin" // Adjust for your project
   }
@@ -34,13 +34,26 @@ in tsconfig.json make these changes
 
 This project is using flat file for eslint (best results achieved with version >=9.9.0) and the intention to be compatible with that style only:
 
-in eslint.config.(m)js make these changes
+In `eslint.config.(m)js` make these changes:
 
-```JavaScript
-import { eslintConfig } from '@shi-corp/development-utilities';
+### Normal (Non-UI)
+
+```TypeScript
+import { baseLintConfig } from '@shi-corp/development-utilities';
+
+export default [
+    ...baseLintConfig,
+    // Add project-specific rules, ignores, or plugins here
+];
+```
+
+### User Interface (Next.JS)
+
+```TypeScript
+import { baseLintConfig } from '@shi-corp/development-utilities';
 
 export default [
-    ...eslintConfig,
+    ...nextLintConfig,
     // Add project-specific rules, ignores, or plugins here
 ];
 ```
@@ -49,7 +62,7 @@ export default [
 
 in next.config.(m)js make these changes
 
-```JavaScript
+```TypeScript
 import { nextConfig } from '@shi-corp/development-utilities';
 
 export default {
@@ -67,9 +80,9 @@ export default {
 ## Compatibility
 
 - Node.JS (Latest LTS)
-- ES Lint >= 9.40
+- ES Lint >= 9.38.0
 - TypeScript >= 5.9
-- Next.JS >= 15 (only if using the provided next config)
+- Next.JS >= 16 (only if using the provided next config)
 
 ## License
 

package/bin/config/{baseLintConfig.js → linter/base.js}

@@ -1,25 +1,10 @@
-import { defineConfig } from 'eslint/config';
+import { defineConfig, globalIgnores } from 'eslint/config';
 import eslint from '@eslint/js';
 import globals from 'globals';
 import jsdoc from 'eslint-plugin-jsdoc';
 import stylistic from '@stylistic/eslint-plugin';
 import tseslint from 'typescript-eslint';
 export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.configs['flat/recommended-typescript'], ...tseslint.configs.strictTypeChecked, ...tseslint.configs.stylisticTypeChecked, {
-    'ignores': [
-        'eslint.config.mjs',
-        'eslint.config.js',
-        'next.config.mjs',
-        'next.config.js',
-        'jest.config.mjs',
-        'node_modules/',
-        'bin/',
-        'dist/',
-        'out/',
-        'build/',
-        '.next/',
-        'next-env.d.ts'
-    ]
-}, {
     'languageOptions': {
         'globals': {
             ...globals.mocha,
@@ -39,9 +24,6 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
         '@typescript-eslint/default-param-last': 'warn',
         '@typescript-eslint/explicit-function-return-type': 'warn',
         '@typescript-eslint/init-declarations': 'warn',
-        '@typescript-eslint/no-array-constructor': 'warn',
-        '@typescript-eslint/no-empty-function': 'warn',
-        '@typescript-eslint/no-implied-eval': 'warn',
         '@typescript-eslint/no-invalid-this': 'warn',
         '@typescript-eslint/no-loop-func': 'warn',
         '@typescript-eslint/no-misused-promises': [
@@ -55,7 +37,6 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
         '@typescript-eslint/no-non-null-assertion': 'off',
         '@typescript-eslint/no-restricted-imports': 'warn',
         '@typescript-eslint/no-shadow': 'warn',
-        '@typescript-eslint/no-unused-expressions': 'warn',
         '@typescript-eslint/no-unused-vars': [
             'warn',
             {
@@ -64,10 +45,7 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
             }
         ],
         '@typescript-eslint/no-use-before-define': 'warn',
-        '@typescript-eslint/no-useless-constructor': 'warn',
         '@typescript-eslint/prefer-destructuring': 'warn',
-        '@typescript-eslint/prefer-promise-reject-errors': 'warn',
-        '@typescript-eslint/require-await': 'warn',
         '@typescript-eslint/restrict-template-expressions': [
             'warn',
             {
@@ -100,7 +78,6 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
         'id-length': 'warn',
         'id-match': 'warn',
         'init-declarations': 'off',
-        'jsdoc/check-alignment': 'warn',
         'jsdoc/check-indentation': [
             'warn',
             {
@@ -147,8 +124,6 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
                 }
             }
         ],
-        'jsdoc/require-param': 'warn',
-        'jsdoc/valid-types': 'warn',
         'max-classes-per-file': 'warn',
         'max-depth': [
             'warn',
@@ -157,7 +132,6 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
         'max-nested-callbacks': 'warn',
         'new-cap': 'warn',
         'no-alert': 'warn',
-        'no-array-constructor': 'off',
         'no-bitwise': 'warn',
         'no-caller': 'warn',
         'no-console': 'warn',
@@ -166,7 +140,6 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
         'no-div-regex': 'warn',
         'no-duplicate-imports': 'warn',
         'no-else-return': 'warn',
-        'no-empty-function': 'off',
         'no-eq-null': 'warn',
         'no-eval': 'warn',
         'no-extend-native': 'warn',
@@ -174,7 +147,6 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
         'no-extra-label': 'warn',
         'no-implicit-coercion': 'warn',
         'no-implicit-globals': 'warn',
-        'no-implied-eval': 'off',
         'no-invalid-this': 'off',
         'no-iterator': 'warn',
         'no-label-var': 'warn',
@@ -215,23 +187,19 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
         'no-sequences': 'warn',
         'no-shadow': 'off',
         'no-template-curly-in-string': 'warn',
-        'no-throw-literal': 'warn',
         'no-undef-init': 'warn',
         'no-undefined': 'warn',
         'no-underscore-dangle': 'warn',
         'no-unmodified-loop-condition': 'warn',
         'no-unneeded-ternary': 'warn',
         'no-unreachable-loop': 'warn',
-        'no-unused-expressions': 'off',
         'no-unused-vars': 'off',
         'no-use-before-define': 'off',
         'no-useless-call': 'warn',
         'no-useless-computed-key': 'warn',
         'no-useless-concat': 'warn',
-        'no-useless-constructor': 'off',
         'no-useless-rename': 'warn',
         'no-useless-return': 'warn',
-        'no-var': 'warn',
         'no-warning-comments': [
             'warn',
             {
@@ -248,20 +216,15 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
         ],
         'operator-assignment': 'warn',
         'prefer-arrow-callback': 'warn',
-        'prefer-const': 'warn',
         'prefer-destructuring': 'off',
         'prefer-exponentiation-operator': 'warn',
         'prefer-named-capture-group': 'warn',
         'prefer-numeric-literals': 'warn',
         'prefer-object-spread': 'warn',
-        'prefer-promise-reject-errors': 'off',
         'prefer-regex-literals': 'warn',
-        'prefer-rest-params': 'warn',
-        'prefer-spread': 'warn',
         'prefer-template': 'warn',
         'radix': 'warn',
         'require-atomic-updates': 'warn',
-        'require-await': 'off',
         'require-unicode-regexp': 'warn',
         'sort-imports': 'warn',
         'sort-keys': 'warn',
@@ -300,6 +263,10 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
         'stylistic/function-paren-newline': 'warn',
         'stylistic/generator-star-spacing': 'warn',
         'stylistic/implicit-arrow-linebreak': 'warn',
+        'stylistic/indent': [
+            'warn',
+            4
+        ],
         'stylistic/jsx-quotes': 'warn',
         'stylistic/key-spacing': 'warn',
         'stylistic/keyword-spacing': 'warn',
@@ -471,4 +438,10 @@ export const eslintConfig = defineConfig(eslint.configs.recommended, jsdoc.confi
             'contexts': ['TSInterfaceDeclaration']
         }
     }
-});
+}, globalIgnores([
+    'node_modules/',
+    'eslint.config.mjs',
+    'eslint.config.js',
+    'bin/',
+    'dist/'
+]));

package/bin/config/{nextLintConfig.d.ts → linter/next.d.ts}

@@ -1,2 +1,2 @@
 /** Baseline configuration used for linting Next.JS projects the SHI - Lab way. */
-export declare const nextLintConfig: import("eslint/config").Config[];
+export declare const eslintConfig: import("eslint/config").Config[];

package/bin/config/linter/next.js

@@ -0,0 +1,26 @@
+import { defineConfig, globalIgnores } from 'eslint/config';
+import { eslintConfig as baselineConfig } from './base.js';
+import globals from 'globals';
+import nextVitals from 'eslint-config-next/core-web-vitals';
+import react from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+export const eslintConfig = defineConfig([
+    ...baselineConfig,
+    {
+        'languageOptions': { 'globals': { ...globals.browser } },
+        'settings': { 'react': { 'version': 'detect' } }
+    },
+    react.configs.flat['recommended'],
+    react.configs.flat['jsx-runtime'],
+    reactHooks.configs.flat.recommended,
+    ...nextVitals,
+    globalIgnores([
+        'next.config.mjs',
+        'next.config.js',
+        'next-env.d.ts',
+        '.next/**',
+        'out/**',
+        'build/**',
+        'jest.config.mjs'
+    ])
+]);

package/bin/config/next/base.js

@@ -0,0 +1,3 @@
+export const nextConfig = {
+    'output': 'export'
+};

package/bin/index.d.ts

@@ -1,3 +1,3 @@
-export { eslintConfig } from './config/baseLintConfig.js';
-export { nextLintConfig } from './config/nextLintConfig.js';
-export { nextConfig } from './config/baseNextConfig.js';
+export { eslintConfig as baseLintConfig } from './config/linter/base.js';
+export { eslintConfig as nextLintConfig } from './config/linter/next.js';
+export { nextConfig } from './config/next/base.js';

package/bin/index.js

@@ -1,3 +1,3 @@
-export { eslintConfig } from './config/baseLintConfig.js';
-export { nextLintConfig } from './config/nextLintConfig.js';
-export { nextConfig } from './config/baseNextConfig.js';
+export { eslintConfig as baseLintConfig } from './config/linter/base.js';
+export { eslintConfig as nextLintConfig } from './config/linter/next.js';
+export { nextConfig } from './config/next/base.js';

package/package.json

@@ -1,66 +1,82 @@
 {
-  "name": "@shi-corp/development-utilities",
-  "version": "1.1.0",
-  "description": "Collection of configurations, settings and packages to be common across multiple products/repositories.",
-  "main": "bin/index.js",
-  "type": "module",
-  "scripts": {
-    "build:Dev": "tsc",
-    "prebuild:Prod": "tsc -p prod.tsconfig.json --emitDeclarationOnly false",
-    "build:Prod": "tsc -p prod.tsconfig.json --removeComments false",
-    "lint": "eslint --max-warnings 0",
-    "test:Unit": "mocha"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Software-Hardware-Integration-Lab/Development-Utilities"
-  },
-  "keywords": [
-    "ESLint",
-    "config",
-    "lint",
-    "standardization",
-    "JSDoc",
-    "Stylistic",
-    "TypeScript",
-    "tsconfig",
-    "Next.js config"
-  ],
-  "author": "Pasha Zayko <pasha_zayko@shi.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/issues"
-  },
-  "homepage": "https://github.com/Software-Hardware-Integration-Lab/Development-Utilities#readme",
-  "dependencies": {
-    "@eslint/js": "~9.38.0",
-    "@stylistic/eslint-plugin": "~5.5.0",
-    "eslint": "~9.38.0",
-    "eslint-plugin-jsdoc": "~61.1.4",
-    "eslint-plugin-react": "~7.37.5",
-    "eslint-plugin-react-hooks": "~7.0.0",
-    "typescript-eslint": "~8.46.1"
-  },
-  "devDependencies": {
-    "@types/chai": "~5.2.2",
-    "@types/eslint": "~9.6.1",
-    "@types/mocha": "~10.0.10",
-    "chai": "~6.2.0",
-    "mocha": "~11.7.4",
-    "next": "~15.5.6",
-    "typescript": "~5.9.3"
-  },
-  "overrides": {
-    "is-unicode-supported": "npm:@socketregistry/is-unicode-supported@^1",
-    "safe-buffer": "npm:@socketregistry/safe-buffer@^1"
-  },
-  "resolutions": {
-    "is-unicode-supported": "npm:@socketregistry/is-unicode-supported@^1",
-    "safe-buffer": "npm:@socketregistry/safe-buffer@^1"
-  },
-  "mocha": {
-    "recursive": true,
-    "spec": "bin/test/",
-    "color": true
-  }
+    "name": "@shi-corp/development-utilities",
+    "version": "2.0.1",
+    "description": "Collection of configurations, settings and packages to be common across multiple products/repositories.",
+    "main": "bin/index.js",
+    "type": "module",
+    "scripts": {
+        "build:Dev": "tsc",
+        "prebuild:Prod": "tsc -p prod.tsconfig.json --emitDeclarationOnly false",
+        "build:Prod": "tsc -p prod.tsconfig.json --removeComments false",
+        "lint": "eslint --max-warnings 0",
+        "test:Unit": "mocha"
+    },
+    "packageManager": "npm@11.6.2",
+    "devEngines": {
+        "runtime": {
+            "name": "node",
+            "version": ">=22.17.0",
+            "onFail": "error"
+        },
+        "packageManager": {
+            "name": "npm",
+            "onFail": "error"
+        }
+    },
+    "engines": {
+        "node": ">=22.17.0"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Software-Hardware-Integration-Lab/Development-Utilities"
+    },
+    "keywords": [
+        "ESLint",
+        "config",
+        "lint",
+        "standardization",
+        "JSDoc",
+        "Stylistic",
+        "TypeScript",
+        "tsconfig",
+        "Next.js config"
+    ],
+    "author": "Pasha Zayko <pasha_zayko@shi.com>",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/Software-Hardware-Integration-Lab/Development-Utilities/issues"
+    },
+    "homepage": "https://github.com/Software-Hardware-Integration-Lab/Development-Utilities#readme",
+    "dependencies": {
+        "@eslint/js": "~9.38.0",
+        "@stylistic/eslint-plugin": "~5.5.0",
+        "eslint": "~9.38.0",
+        "eslint-config-next": "~16.0.0",
+        "eslint-plugin-jsdoc": "~61.1.9",
+        "eslint-plugin-react": "~7.37.5",
+        "eslint-plugin-react-hooks": "~7.0.1",
+        "typescript-eslint": "~8.46.2"
+    },
+    "devDependencies": {
+        "@types/chai": "~5.2.3",
+        "@types/eslint": "~9.6.1",
+        "@types/mocha": "~10.0.10",
+        "chai": "~6.2.0",
+        "mocha": "~11.7.4",
+        "next": "~16.0.0",
+        "typescript": "~5.9.3"
+    },
+    "overrides": {
+        "is-unicode-supported": "npm:@socketregistry/is-unicode-supported@^1",
+        "safe-buffer": "npm:@socketregistry/safe-buffer@^1"
+    },
+    "resolutions": {
+        "is-unicode-supported": "npm:@socketregistry/is-unicode-supported@^1",
+        "safe-buffer": "npm:@socketregistry/safe-buffer@^1"
+    },
+    "mocha": {
+        "recursive": true,
+        "spec": "bin/test/",
+        "color": true
+    }
 }

package/bin/config/baseNextConfig.js

@@ -1,4 +0,0 @@
-export const nextConfig = {
-    'output': 'export',
-    'reactStrictMode': false
-};

package/bin/config/nextLintConfig.js

@@ -1,13 +0,0 @@
-import { eslintConfig as baselineConfig } from './baseLintConfig.js';
-import { defineConfig } from 'eslint/config';
-import globals from 'globals';
-import react from 'eslint-plugin-react';
-import reactHooks from 'eslint-plugin-react-hooks';
-export const nextLintConfig = defineConfig(...baselineConfig, react.configs.flat['recommended'], react.configs.flat['jsx-runtime'], reactHooks.configs.flat['recommended'], {
-    'languageOptions': { 'globals': { ...globals.browser } },
-    'settings': {
-        'react': {
-            'version': 'detect'
-        }
-    }
-});