Feature/modkit plugin

.github/workflows/pull_request.yml

@@ -0,0 +1,18 @@
+name: Code quality
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Biome
+        uses: biomejs/setup-biome@v2
+        with:
+          version: latest
+      - name: Run Biome
+        run: biome ci . --reporter=github

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}": ["biome check --write --no-errors-on-unmatched"]
+}

.npmrc

@@ -1,2 +1,3 @@
 registry=https://registry.npmjs.org/
-link-workspace-packages=true
+link-workspace-packages=true
+enable-pre-post-scripts=true

.vscode/extensions.json

@@ -1,5 +1,3 @@
 {
-    "recommendations": [
-        "biomejs.biome"
-    ]
-}
+  "recommendations": ["biomejs.biome"]
+}

.vscode/settings.json

@@ -17,5 +17,5 @@
     "source.organizeImports.biome": "explicit"
   },
   "conventionalCommits.scopes": ["arguments-builder", "sgmoudle-tools"],
-  "cSpell.words": ["iringo", "modkit", "rsbuild"]
+  "cSpell.words": ["iringo", "MITM", "modkit", "rsbuild"]
 }

biome.json

@@ -1,7 +1,15 @@
 {
-  "$schema": "https://biomejs.dev/schemas/1.9.2/schema.json",
-  "vcs": { "enabled": true, "clientKind": "git", "useIgnoreFile": true },
-  "files": { "ignoreUnknown": false, "ignore": [] },
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "vcs": {
+    "enabled": true,
+    "defaultBranch": "main",
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": true,
+    "ignore": ["packages/modkit/tests/src/arguments.d.ts"]
+  },
   "formatter": {
     "enabled": true,
     "useEditorconfig": true,
@@ -13,19 +21,90 @@
     "attributePosition": "auto",
     "bracketSpacing": true
   },
-  "organizeImports": { "enabled": true },
+  "organizeImports": {
+    "enabled": true,
+    "include": ["./**/*.js", "./**/*.jsx", "./**/*.ts", "./**/*.tsx", "./**/*.mjs", "./**/*.cjs"]
+  },
+  "css": {
+    "parser": {
+      "cssModules": true
+    }
+  },
   "linter": {
     "enabled": true,
     "rules": {
-      "recommended": true,
-      "suspicious": {
-        "noExplicitAny": "warn"
-      },
+      "recommended": false,
       "complexity": {
-        "noForEach": "off"
+        "noForEach": "off",
+        "noExtraBooleanCast": "error",
+        "noStaticOnlyClass": "error",
+        "noUselessCatch": "error",
+        "noUselessConstructor": "error",
+        "noWith": "error",
+        "useLiteralKeys": "error"
+      },
+      "correctness": {
+        "noConstantCondition": "error",
+        "noEmptyCharacterClassInRegex": "error",
+        "noEmptyPattern": "error",
+        "noGlobalObjectCalls": "error",
+        "noInnerDeclarations": "error",
+        "noInvalidConstructorSuper": "error",
+        "noNewSymbol": "error",
+        "noPrecisionLoss": "error",
+        "noSelfAssign": "error",
+        "noSetterReturn": "error",
+        "noSwitchDeclarations": "error",
+        "noUndeclaredVariables": "error",
+        "noUnreachable": "error",
+        "noUnreachableSuper": "error",
+        "noUnsafeFinally": "error",
+        "noUnsafeOptionalChaining": "error",
+        "noUnusedVariables": "error",
+        "useArrayLiterals": "error",
+        "useIsNan": "error",
+        "useValidForDirection": "error"
       },
+      "security": { "noGlobalEval": "error" },
       "style": {
-        "noNonNullAssertion": "warn"
+        "noArguments": "error",
+        "noVar": "error",
+        "useBlockStatements": "error",
+        "useConsistentBuiltinInstantiation": "error",
+        "useConst": "error",
+        "useDefaultParameterLast": "error",
+        "useDefaultSwitchClause": "error",
+        "useFilenamingConvention": {
+          "level": "warn",
+          "options": { "requireAscii": true, "filenameCases": ["kebab-case", "snake_case"] }
+        },
+        "useTemplate": "warn",
+        "useThrowOnlyError": "error",
+        "useImportType": "error"
+      },
+      "suspicious": {
+        "noAssignInExpressions": "error",
+        "noAsyncPromiseExecutor": "error",
+        "noCatchAssign": "error",
+        "noClassAssign": "error",
+        "noCompareNegZero": "error",
+        "noControlCharactersInRegex": "error",
+        "noDebugger": "error",
+        "noDoubleEquals": "error",
+        "noDuplicateCase": "error",
+        "noDuplicateClassMembers": "error",
+        "noEmptyBlockStatements": "error",
+        "noFallthroughSwitchClause": "error",
+        "noFunctionAssign": "error",
+        "noGlobalAssign": "error",
+        "noImportAssign": "error",
+        "noPrototypeBuiltins": "error",
+        "noSparseArray": "error",
+        "noUnsafeNegation": "error",
+        "useAwait": "error",
+        "useDefaultSwitchClauseLast": "error",
+        "useGetterReturn": "error",
+        "useValidTypeof": "error"
       }
     }
   },
@@ -41,5 +120,104 @@
       "attributePosition": "auto",
       "bracketSpacing": true
     }
-  }
+  },
+  "overrides": [
+    {
+      "include": ["*.ts", "*.tsx"],
+      "linter": {
+        "rules": {
+          "complexity": {
+            "noBannedTypes": "error",
+            "noStaticOnlyClass": "error",
+            "noUselessConstructor": "off",
+            "noUselessThisAlias": "error",
+            "noUselessTypeConstraint": "error",
+            "useLiteralKeys": "off",
+            "useOptionalChain": "warn"
+          },
+          "correctness": {
+            "noConstAssign": "off",
+            "noGlobalObjectCalls": "off",
+            "noInvalidConstructorSuper": "off",
+            "noNewSymbol": "off",
+            "noPrecisionLoss": "off",
+            "noSetterReturn": "off",
+            "noUndeclaredVariables": "off",
+            "noUnreachable": "off",
+            "noUnreachableSuper": "off",
+            "noUnusedVariables": "off",
+            "useArrayLiterals": "off"
+          },
+          "style": {
+            "noInferrableTypes": "error",
+            "noNamespace": "error",
+            "noNonNullAssertion": "warn",
+            "useAsConstAssertion": "error",
+            "useDefaultParameterLast": "off",
+            "useForOf": "warn",
+            "useLiteralEnumMembers": "error",
+            "useNamingConvention": {
+              "level": "error",
+              "options": {
+                "strictCase": false,
+                "conventions": [
+                  { "selector": { "kind": "class" }, "formats": ["PascalCase"] },
+                  { "selector": { "kind": "interface" }, "formats": ["PascalCase"] },
+                  { "selector": { "kind": "typeLike" }, "formats": ["PascalCase"] },
+                  { "selector": { "kind": "enumMember" }, "formats": ["PascalCase", "CONSTANT_CASE"] },
+                  { "selector": { "kind": "function" }, "match": "([^_]*)", "formats": ["camelCase"] },
+                  {
+                    "selector": { "kind": "importNamespace" },
+                    "formats": ["camelCase", "PascalCase", "CONSTANT_CASE"]
+                  },
+                  { "selector": { "kind": "importAlias" }, "formats": ["camelCase", "PascalCase", "CONSTANT_CASE"] },
+                  { "selector": { "kind": "objectLiteralProperty" }, "match": ".*" },
+                  { "selector": { "kind": "functionParameter" }, "match": "_?([^_]*)", "formats": ["camelCase"] },
+                  { "selector": { "kind": "typeProperty" }, "formats": ["camelCase", "snake_case"] },
+                  {
+                    "selector": { "kind": "variable", "scope": "global" },
+                    "formats": ["camelCase", "PascalCase", "CONSTANT_CASE"]
+                  },
+                  {
+                    "selector": { "kind": "variable" },
+                    "formats": ["camelCase", "snake_case", "PascalCase", "CONSTANT_CASE"]
+                  },
+                  { "formats": ["camelCase", "CONSTANT_CASE", "PascalCase"] },
+                  { "selector": { "kind": "variable" }, "formats": ["camelCase", "CONSTANT_CASE"] },
+                  {
+                    "selector": { "kind": "function" },
+                    "formats": ["camelCase", "CONSTANT_CASE"]
+                  },
+                  {
+                    "selector": { "kind": "functionParameter" },
+                    "formats": ["camelCase", "CONSTANT_CASE"]
+                  }
+                ]
+              }
+            },
+            "useThrowOnlyError": "off"
+          },
+          "suspicious": {
+            "noConfusingVoidType": "error",
+            "noDuplicateClassMembers": "off",
+            "noDuplicateObjectKeys": "off",
+            "noDuplicateParameters": "off",
+            "noEmptyBlockStatements": "off",
+            "noEmptyInterface": "error",
+            "noExplicitAny": "warn",
+            "noExtraNonNullAssertion": "error",
+            "noFunctionAssign": "off",
+            "noImportAssign": "off",
+            "noMisleadingInstantiator": "error",
+            "noRedeclare": "off",
+            "noUnsafeNegation": "off",
+            "useAwait": "off",
+            "useGetterReturn": "off",
+            "useNamespaceKeyword": "off",
+            "useValidTypeof": "off"
+          }
+        }
+      }
+    }
+  ]
 }

package.json

@@ -4,9 +4,11 @@
   "version": "1.0.0",
   "main": "index.js",
   "scripts": {
+    "prepare": "husky",
     "build": "cross-env NX_DAEMON=false nx run-many -t build --exclude @examples/* @e2e/* --parallel=10",
     "mk:dev": "nx run-many -t dev --projects=@iringo/utils,@iringo/modkit* --parallel=10",
     "mk:build": "nx run-many -t build --projects=@iringo/utils,@iringo/modkit* --parallel=10",
+    "mk:test": "nx run-many -t test --projects=@iringo/utils,@iringo/modkit* --parallel=10",
     "change": "changeset"
   },
   "author": "",
@@ -17,6 +19,8 @@
     "@changesets/cli": "^2.27.8",
     "@nx/js": "^20.0.0",
     "cross-env": "^7.0.3",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
     "nx": "^20.0.0"
   }
 }

packages/arguments-builder/package.json

@@ -30,10 +30,7 @@
     "ts-jest": "^29.2.5",
     "typescript": "^5.6.2"
   },
-  "files": [
-    "dist",
-    "CHANGELOG.md"
-  ],
+  "files": ["dist", "CHANGELOG.md"],
   "repository": {
     "type": "git",
     "url": "https://github.com/NSRingo/engineering-solutions",

packages/doc-ui/package.json

@@ -11,10 +11,7 @@
     "build:watch": "modern build -w",
     "build": "modern build"
   },
-  "files": [
-    "dist",
-    "CHANGELOG.md"
-  ],
+  "files": ["dist", "CHANGELOG.md"],
   "dependencies": {
     "@rc-component/qrcode": "^1.0.0",
     "rc-tooltip": "^6.2.1"

packages/doc-ui/src/module-install/module-install-item.tsx

@@ -3,7 +3,9 @@ import type { SupportedApp } from './constants';
 
 export const ModuleInstallItem: React.FC<
   {
+    // biome-ignore lint/style/useNamingConvention: <explanation>
     __appType: SupportedApp;
+    // biome-ignore lint/style/useNamingConvention: <explanation>
     __urlPrefix?: string;
   } & Omit<AppTabContentProps, 'appType'>
 > = ({ __appType, __urlPrefix = '', url, ...rest }) => {

packages/doc-ui/src/module-install/module-install-tab.tsx

@@ -4,6 +4,7 @@
 
 export interface ModuleInstallTabProps {
   type: SupportedApp;
+  // biome-ignore lint/style/useNamingConvention: <explanation>
   __urlPrefix?: string;
   children?: React.ReactNode;
 }
@@ -20,7 +21,7 @@
               'displayName' in childType &&
               childType.displayName === 'ModuleInstallItem'
             ) {
               return cloneElement(child, { __appType: appType, __urlPrefix } as any);
             }
             return createElement(
               'div',

packages/doc-ui/src/module-install/module-install.tsx

@@ -9,11 +9,12 @@
 export interface ModuleInstallProps {
   urlPrefix?: string;
   urls?: {
-    [key in SupportedApp]?: string;
+    [Key in SupportedApp]?: string;
   };
   children?: React.ReactNode;
 }
 
+// biome-ignore lint/style/useNamingConvention: React Component
 export function ModuleInstall({ urlPrefix = '', urls, children }: ModuleInstallProps) {
   const renderTabLabel = useCallback((appType: SupportedApp) => {
     return (
@@ -49,7 +50,7 @@
     if (children) {
       return Children.map(children, (child) => {
         if (isValidElement(child)) {
           return cloneElement(child, { __urlPrefix: urlPrefix } as any);
         }
         return null;
       });
@@ -57,7 +58,9 @@
     const result: React.ReactNode[] = [];
     SUPPORTED_APPS.forEach((appType) => {
       const url = urls?.[appType];
-      if (!url) return;
+      if (!url) {
+        return;
+      }
       result.push(
         <Tab key={appType}>
           <AppTabContent key={url} appType={appType} url={`${urlPrefix}${url}`} />

packages/doc-ui/src/nav-icon/nav-icon.tsx

@@ -5,7 +5,7 @@ import { PopoverContent } from './popover-content';
 
 export const NavIcon: React.FC = () => {
   return (
-    <Popover overlay={<PopoverContent />} placement='bottomLeft'>
+    <Popover overlay={<PopoverContent />} placement="bottomLeft">
       <span className={styles.icon}>
         <IconNav />
       </span>

packages/doc-ui/src/nav-icon/popover-content.tsx

@@ -24,7 +24,7 @@ const PROJECTS = [
 export const PopoverContent: React.FC = () => {
   const renderLink = ({ icon, url, title, description }: (typeof PROJECTS)[number]) => {
     return (
-      <a key={title} className={styles.item} href={url} target='_blank' rel='noopener noreferrer'>
+      <a key={title} className={styles.item} href={url} target="_blank" rel="noopener noreferrer">
         <img className={styles.icon} src={icon} alt={title} />
         <div>
           <span className={styles.title}>{title}</span>

packages/modkit/core/bin/modkit.js

@@ -1,4 +1,6 @@
 #!/usr/bin/env node
-const { initCommand } = require('../dist/index.js');
+const { ModKitCli } = require('../dist/index.js');
 
-initCommand();
+const cli = new ModKitCli();
+
+cli.run();