code-quality-lib 2.0.1 → 2.5.0

package/.code-quality/.prettierignore

@@ -0,0 +1,87 @@
+# Quality reports and configuration
+.quality-report.md
+.code-quality/
+
+# Build outputs
+dist/
+build/
+.next/
+out/
+
+# Dependencies
+node_modules/
+
+# Logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Coverage directory used by tools like istanbul
+coverage/
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Dependency directories
+jspm_packages/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+.venv

package/.code-quality/.prettierrc

@@ -0,0 +1,17 @@
+{
+  "semi": false,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "endOfLine": "lf",
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": true,
+  "proseWrap": "preserve",
+  "htmlWhitespaceSensitivity": "css",
+  "embeddedLanguageFormatting": "auto"
+}

package/.code-quality/README.md

@@ -0,0 +1,32 @@
+# Code Quality Configuration
+
+This directory contains reference configuration files for code quality tools.
+
+## Files
+
+- **eslint.config.mjs** - ESLint flat config with React, TypeScript, and accessibility rules
+- **tsconfig.json** - TypeScript configuration with strict settings
+- **.prettierrc** - Prettier formatting rules
+- **.prettierrcignore** - Files to ignore when formatting
+- **knip.json** - Dead code detection configuration
+
+## Usage
+
+These files are automatically copied to your project's `.code-quality/` directory when you run:
+
+```bash
+code-quality --init
+# or
+code-quality --wizard
+```
+
+## Customization
+
+You can modify these files after copying them to suit your project's needs.
+
+## Notes
+
+- ESLint config uses conditional loading for optional plugins (Next.js, jsx-a11y, prettier)
+- TypeScript config is optimized for React/Next.js projects
+- Prettier config matches ESLint semicolon settings
+- Knip config is set to ignore test files and dependencies

package/.code-quality/config.json

@@ -0,0 +1,34 @@
+{
+  "version": "1.0.0",
+  "packageManager": "npm",
+  "useProjectConfig": false,
+  "loadEnv": true,
+  "generated": "2026-03-11T16:57:59.790Z",
+  "environments": {
+    "development": {
+      "tools": [
+        "ESLint",
+        "TypeScript",
+        "Prettier"
+      ]
+    },
+    "ci": {
+      "tools": [
+        "ESLint",
+        "TypeScript",
+        "Prettier",
+        "Knip",
+        "Snyk"
+      ]
+    },
+    "production": {
+      "tools": [
+        "ESLint",
+        "TypeScript",
+        "Prettier",
+        "Knip",
+        "Snyk"
+      ]
+    }
+  }
+}

package/.code-quality/eslint.config.mjs

@@ -0,0 +1,311 @@
+import js from '@eslint/js'
+import typescript from '@typescript-eslint/eslint-plugin'
+import tsParser from '@typescript-eslint/parser'
+import prettier from 'eslint-config-prettier'
+import importPlugin from 'eslint-plugin-import'
+import react from 'eslint-plugin-react'
+import reactHooks from 'eslint-plugin-react-hooks'
+import sonarjs from 'eslint-plugin-sonarjs'
+import unicorn from 'eslint-plugin-unicorn'
+
+// Import optional plugins - these may or may not be installed
+let nextPlugin
+let jsxA11yPlugin
+let prettierPlugin
+
+try {
+  const nextModule = await import('eslint-plugin-next')
+  nextPlugin = nextModule.default || nextModule
+} catch {
+  // Next.js plugin not installed, skip Next.js rules
+}
+
+try {
+  const jsxA11yModule = await import('eslint-plugin-jsx-a11y')
+  jsxA11yPlugin = jsxA11yModule.default || jsxA11yModule
+} catch {
+  // jsx-a11y plugin not installed, skip accessibility rules
+}
+
+try {
+  const prettierModule = await import('eslint-plugin-prettier')
+  prettierPlugin = prettierModule.default || prettierModule
+} catch {
+  // eslint-plugin-prettier not installed, skip prettier rules
+}
+
+const eslintConfig = [
+  {
+    ignores: [
+      'node_modules/',
+      '.pnp',
+      '.pnp.js',
+      '.next/',
+      'out/',
+      'dist/',
+      'build/',
+      '.env*',
+      '*.log',
+      'pids',
+      '*.pid',
+      '*.seed',
+      '*.pid.lock',
+      'coverage/',
+      '.nyc_output',
+      '.cache/',
+      '.parcel-cache/',
+      '*.tsbuildinfo',
+      '.DS_Store',
+      '.DS_Store?',
+      '._*',
+      '.Spotlight-V100',
+      '.Trashes',
+      'ehthumbs.db',
+      'Thumbs.db',
+      '.vscode/',
+      '.idea/',
+      'tmp/',
+      'temp/',
+      '*.tmp',
+      '*.temp',
+      'public/',
+      '.code-quality/',
+      '**/.code-quality/**', // More specific pattern
+      'eslint.config.mjs',
+      'next.config.ts',
+      '.venv/',
+    ],
+  },
+  js.configs.recommended,
+  {
+    files: ['**/*.{js,jsx,ts,tsx}'],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        ecmaFeatures: {
+          jsx: true,
+        },
+        project: './tsconfig.json',
+        tsconfigRootDir: import.meta.dirname,
+      },
+      globals: {
+        console: 'readonly',
+        process: 'readonly',
+        __dirname: 'readonly',
+        module: 'readonly',
+        require: 'readonly',
+        // Browser globals
+        window: 'readonly',
+        document: 'readonly',
+        fetch: 'readonly',
+        setTimeout: 'readonly',
+        clearTimeout: 'readonly',
+        setInterval: 'readonly',
+        clearInterval: 'readonly',
+        requestAnimationFrame: 'readonly',
+        URL: 'readonly',
+        URLSearchParams: 'readonly',
+        FormData: 'readonly',
+        HeadersInit: 'readonly',
+        RequestInit: 'readonly',
+        TextEncoder: 'readonly',
+        btoa: 'readonly',
+        crypto: 'readonly',
+        sessionStorage: 'readonly',
+        // React globals
+        React: 'readonly',
+        // DOM types
+        HTMLDivElement: 'readonly',
+        // Node.js globals
+        Buffer: 'readonly',
+        // Type globals
+        Item: 'readonly',
+        Bundle: 'readonly',
+        ConstStallCategory: 'readonly',
+      },
+    },
+    settings: {
+      'import/resolver': {
+        typescript: {
+          alwaysTryTypes: true,
+          project: './tsconfig.json',
+        },
+      },
+    },
+    plugins: {
+      '@typescript-eslint': typescript,
+      react,
+      'react-hooks': reactHooks,
+      sonarjs,
+      unicorn,
+      import: importPlugin,
+      ...(nextPlugin ? { '@next/next': nextPlugin } : {}),
+      ...(jsxA11yPlugin ? { 'jsx-a11y': jsxA11yPlugin } : {}),
+      ...(prettierPlugin ? { prettier: prettierPlugin } : {}),
+    },
+    rules: {
+      // React
+      'react/jsx-no-literals': 'off',
+      'react/prop-types': 'off',
+      'react/self-closing-comp': 'warn',
+      'react/jsx-sort-props': [
+        'warn',
+        {
+          callbacksLast: true,
+          shorthandFirst: true,
+          noSortAlphabetically: false,
+          reservedFirst: true,
+        },
+      ],
+      'react/jsx-fragments': ['warn', 'syntax'],
+      'react/jsx-no-useless-fragment': 'warn',
+      'react/jsx-pascal-case': 'warn',
+      'react/no-array-index-key': 'warn',
+      'react/react-in-jsx-scope': 'off',
+      // JSX quotes consistency with Prettier jsxSingleQuote: true
+      'jsx-quotes': ['error', 'prefer-single'],
+
+      // TypeScript
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-require-imports': 'off',
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        {
+          args: 'after-used',
+          ignoreRestSiblings: false,
+          argsIgnorePattern: '^_.*$',
+        },
+      ],
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-empty-interface': 'warn',
+      '@typescript-eslint/no-non-null-assertion': 'warn',
+      '@typescript-eslint/prefer-as-const': 'warn',
+
+      // Next.js (if available)
+      ...(nextPlugin
+        ? {
+            '@next/next/no-html-link-for-pages': 'off',
+            '@next/next/no-img-element': 'warn',
+            '@next/next/no-sync-scripts': 'warn',
+          }
+        : {}),
+
+      // Accessibility (if jsx-a11y plugin available)
+      ...(jsxA11yPlugin
+        ? {
+            'jsx-a11y/alt-text': 'warn',
+            'jsx-a11y/interactive-supports-focus': 'off',
+            'jsx-a11y/click-events-have-key-events': 'warn',
+            'jsx-a11y/no-static-element-interactions': 'warn',
+          }
+        : {}),
+
+      // Import ordering
+      'import/order': [
+        'error',
+        {
+          groups: [
+            'type',
+            'builtin',
+            'external',
+            'internal',
+            'parent',
+            'sibling',
+            'index',
+            'object',
+          ],
+          pathGroups: [
+            {
+              pattern: '~/**',
+              group: 'external',
+              position: 'after',
+            },
+          ],
+          pathGroupsExcludedImportTypes: ['builtin'],
+          'newlines-between': 'always',
+          alphabetize: {
+            order: 'asc',
+            caseInsensitive: true,
+          },
+        },
+      ],
+      'import/no-duplicates': 'error',
+      'import/no-unresolved': 'error',
+      'import/no-cycle': 'error',
+
+      // Code quality
+      'no-console': ['error', { allow: ['warn', 'error'] }],
+      ...(prettierPlugin
+        ? {
+            'prettier/prettier': [
+              'error',
+              {
+                endOfLine: 'auto',
+              },
+            ],
+          }
+        : {}),
+      'padding-line-between-statements': [
+        'warn',
+        { blankLine: 'always', prev: '*', next: 'return' },
+        { blankLine: 'always', prev: ['const', 'let', 'var'], next: '*' },
+        {
+          blankLine: 'any',
+          prev: ['const', 'let', 'var'],
+          next: ['const', 'let', 'var'],
+        },
+      ],
+
+      'react-hooks/exhaustive-deps': 'warn',
+      'react-hooks/rules-of-hooks': 'error',
+      'no-param-reassign': 'warn',
+      'no-return-await': 'warn',
+      'prefer-const': 'warn',
+      'no-var': 'error',
+      eqeqeq: ['error', 'always'],
+      'no-unused-expressions': 'error',
+      // Semicolons consistency with Prettier semi: false
+      semi: ['error', 'never'],
+
+      // SonarJS
+      'sonarjs/cognitive-complexity': ['error', 15],
+      'sonarjs/no-duplicate-string': 'warn',
+
+      // Unicorn
+      'unicorn/no-array-for-each': 'error',
+      'unicorn/prefer-node-protocol': 'error',
+    },
+  },
+  {
+    files: ['**/*.{js,jsx,ts,tsx}'],
+    rules: {
+      'no-restricted-syntax': [
+        'error',
+        {
+          selector:
+            "MemberExpression[object.object.name='process'][object.property.name='env'][property.type='Identifier'][property.name=/^NEXT_PUBLIC_/]",
+          message:
+            'Do not access process.env.NEXT_PUBLIC_* directly. Use src/constants/environment.ts instead.',
+        },
+        {
+          selector:
+            "MemberExpression[object.object.name='process'][object.property.name='env'][property.type='Literal'][property.value=/^NEXT_PUBLIC_/]",
+          message:
+            'Do not access process.env.NEXT_PUBLIC_* directly. Use src/constants/environment.ts instead.',
+        },
+      ],
+    },
+  },
+  {
+    files: ['src/constants/environment.ts'],
+    rules: {
+      'no-restricted-syntax': 'off',
+    },
+  },
+  prettier,
+]
+
+export default eslintConfig

package/.code-quality/knip.json

@@ -0,0 +1,30 @@
+{
+  "entry": ["index.js"],
+  "project": ["*.js"],
+  "ignore": [
+    "node_modules/**",
+    "dist/**",
+    "build/**",
+    "coverage/**",
+    "*.config.js",
+    "*.config.ts",
+    "test/**",
+    "**/*.test.*",
+    "**/*.spec.*",
+    "examples/**",
+    ".code-quality/**",
+    "**/*.d.ts"
+  ],
+  "ignoreBinaries": ["code-quality"],
+  "ignoreDependencies": [
+    "eslint-plugin-*",
+    "@typescript-eslint/*",
+    "@eslint/js",
+    "prettier",
+    "@types/*",
+    "typescript",
+    "knip",
+    "snyk",
+    "dotenv"
+  ]
+}

package/.code-quality/tsconfig.json

@@ -0,0 +1,32 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "useUnknownInCatchVariables": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "react-jsx",
+    "incremental": true,
+    "forceConsistentCasingInFileNames": true,
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    }
+  },
+  "include": [
+    "**/*.ts",
+    "**/*.tsx",
+    "**/*.mts"
+  ],
+  "exclude": ["node_modules", "dist", "build", "coverage", "examples"]
+}