@ovh-ux/manager-static-analysis-kit 0.2.0 → 0.3.1

package/src/adapters/eslint/rules/eslint-imports.ts

@@ -1,84 +0,0 @@
-import js from '@eslint/js';
-import { Linter } from 'eslint';
-import importPlugin from 'eslint-plugin-import';
-import tsEslint from 'typescript-eslint';
-
-import { jsFiles, tsFiles } from '../../../configs/file-globs-config';
-
-/**
- * Shared import-related ESLint rules applied across both JavaScript and TypeScript.
- *
- * Includes cycle detection, discourages dynamic `require`, and disallows usage of core Node.js modules directly.
- */
-const sharedImportRules: Record<string, Linter.RuleEntry | undefined> = {
-  ...importPlugin.flatConfigs.recommended.rules,
-  'import/no-cycle': [
-    'error',
-    {
-      maxDepth: Infinity,
-      ignoreExternal: false,
-      allowUnsafeDynamicCyclicDependency: false,
-      disableScc: false,
-    },
-  ],
-  'import/no-dynamic-require': 'warn',
-  'import/no-nodejs-modules': 'warn',
-};
-
-/**
- * JavaScript-specific import rules.
- * Enables base `no-unused-vars` since TypeScript version is not in use.
- */
-const jsImportRules: Record<string, Linter.RuleEntry | undefined> = {
-  ...sharedImportRules,
-  'no-unused-vars': 'warn',
-};
-
-/**
- * TypeScript-specific import rules.
- * Disables base `no-unused-vars` in favor of the TypeScript-aware variant from `@typescript-eslint`.
- */
-const tsImportRules: Record<string, Linter.RuleEntry | undefined> = {
-  ...sharedImportRules,
-  'no-unused-vars': 'off',
-  '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
-};
-
-/**
- * ESLint Flat Config for managing import conventions, cycles, and unused rules
- * for both JavaScript and TypeScript environments.
- *
- * - Uses `eslint-plugin-import` for best practices
- * - Applies proper rules per language
- * - Configures import resolver for TS files
- *
- * @see https://github.com/import-js/eslint-plugin-import
- */
-export const importEslintConfig: Linter.FlatConfig[] = [
-  // JavaScript configuration block
-  js.configs.recommended,
-  importPlugin.flatConfigs.recommended,
-  {
-    files: [jsFiles],
-    languageOptions: {
-      ecmaVersion: 'latest',
-      sourceType: 'module',
-    },
-    rules: jsImportRules,
-  },
-
-  // TypeScript configuration block
-  ...tsEslint.config({
-    files: [tsFiles],
-    extends: [importPlugin.flatConfigs.recommended, importPlugin.flatConfigs.typescript],
-    rules: tsImportRules,
-    settings: {
-      'import/resolver': {
-        typescript: {
-          alwaysTryTypes: true,
-        },
-        node: true,
-      },
-    },
-  }),
-];

package/src/adapters/eslint/rules/eslint-javascript.ts

@@ -1,27 +0,0 @@
-import js from '@eslint/js';
-import { Linter } from 'eslint';
-
-import { jsFilesLoose } from '../../../configs/file-globs-config';
-
-/**
- * ESLint Flat Config for standard JavaScript files.
- *
- * Applies:
- * - ESLint's built-in recommended rules via `@eslint/js`
- * - Supports both `.js` and `.jsx` files (loose JS pattern)
- * - Configured for ECMAScript Modules (`sourceType: 'module'`)
- *
- * @see https://eslint.org/docs/latest/rules/
- */
-export const javascriptEslintConfig: Linter.FlatConfig = {
-  files: [jsFilesLoose],
-  ignores: [],
-  languageOptions: {
-    ...js.languageOptions,
-    sourceType: 'module',
-  },
-  plugins: js.plugins,
-  rules: {
-    ...js.configs.recommended.rules,
-  },
-};

package/src/adapters/eslint/rules/eslint-naming-conventions.ts

@@ -1,49 +0,0 @@
-import { Linter } from 'eslint';
-import checkFile from 'eslint-plugin-check-file';
-
-import {
-  filenameBlocklist,
-  filenameNamingConvention,
-  folderMatchWithFex,
-  folderNamingConvention,
-} from '../../../configs/naming-conventions-config';
-
-export const checkFileEslintConfig: Linter.FlatConfig[] = [
-  {
-    plugins: {
-      'check-file': checkFile,
-    },
-    rules: {
-      'check-file/no-index': 'error',
-      'check-file/filename-blocklist': ['error', filenameBlocklist],
-
-      'check-file/folder-match-with-fex': [
-        'error',
-        folderMatchWithFex,
-        {
-          errorMessage:
-            'The folder of the file "{{ target }}" does not match the expected pattern "{{ pattern }}". See µ-app structure guidelines.',
-        },
-      ],
-
-      'check-file/filename-naming-convention': [
-        'error',
-        filenameNamingConvention,
-        {
-          ignoreMiddleExtensions: true,
-          errorMessage:
-            'The filename "{{ target }}" does not match the naming convention "{{ pattern }}". Please check contribute.md.',
-        },
-      ],
-
-      'check-file/folder-naming-convention': [
-        'error',
-        folderNamingConvention,
-        {
-          errorMessage:
-            'Folder "{{ target }}" must follow the "{{ pattern }}" naming convention. See µ-app guidelines.',
-        },
-      ],
-    },
-  },
-];

package/src/adapters/eslint/rules/eslint-prettier.ts

@@ -1,29 +0,0 @@
-import { Linter } from 'eslint';
-import prettier from 'eslint-plugin-prettier';
-
-import { commonTextFiles } from '../../../configs/file-globs-config';
-import { prettierConfig, prettierIgnorePatterns } from '../../../configs/prettier-config';
-
-/**
- * ESLint Flat Config for Prettier integration.
- *
- * This configuration applies Prettier formatting rules via `eslint-plugin-prettier`
- * and ensures formatting violations are reported as ESLint errors.
- *
- * - Uses custom Prettier options from `prettierConfig`
- * - Ignores defined file patterns (e.g., build output, loaders, etc.)
- * - Applies to common text-based files such as JS/TS, JSON, YAML, Markdown
- *
- * @see https://github.com/prettier/eslint-plugin-prettier
- */
-export const prettierEslintConfig: Linter.FlatConfig = {
-  files: [commonTextFiles],
-  ignores: prettierIgnorePatterns,
-  plugins: {
-    prettier,
-  },
-  rules: {
-    /** Ensures Prettier formatting is enforced via ESLint */
-    'prettier/prettier': ['error', prettierConfig, { usePrettierrc: false }],
-  },
-};

package/src/adapters/eslint/rules/eslint-react.ts

@@ -1,50 +0,0 @@
-import { ESLint, Linter } from 'eslint';
-import reactPlugin from 'eslint-plugin-react';
-import reactHooksPlugin from 'eslint-plugin-react-hooks';
-import globals from 'globals';
-
-import { jsTsFiles } from '../../../configs/file-globs-config';
-
-/**
- * ESLint Flat Config for React and React Hooks.
- *
- * This configuration applies:
- * - Recommended React rules from `eslint-plugin-react`
- * - Recommended rules for hooks from `eslint-plugin-react-hooks`
- * - JSX support via `parserOptions.ecmaFeatures.jsx`
- * - Browser global variables (e.g., `window`, `document`)
- * - Auto-detect React version for compatibility
- *
- * @see https://www.npmjs.com/package/eslint-plugin-react
- * @see https://www.npmjs.com/package/eslint-plugin-react-hooks
- */
-export const reactEslintConfig: Linter.FlatConfig = {
-  files: [jsTsFiles],
-  plugins: {
-    react: reactPlugin as unknown as ESLint.Plugin,
-    'react-hooks': reactHooksPlugin as unknown as ESLint.Plugin,
-  },
-  languageOptions: {
-    parserOptions: {
-      ecmaFeatures: {
-        jsx: true,
-      },
-    },
-    globals: {
-      ...globals.browser,
-    },
-  },
-  settings: {
-    react: {
-      version: 'detect',
-    },
-  },
-  rules: {
-    ...reactPlugin.configs.recommended.rules,
-    ...reactHooksPlugin.configs.recommended.rules,
-
-    // Enforce only one component per file (stateless included)
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-multi-comp.md
-    'react/no-multi-comp': ['error', { ignoreStateless: false }],
-  },
-};

package/src/adapters/eslint/rules/eslint-storybook.ts

@@ -1,29 +0,0 @@
-import { Linter } from 'eslint';
-import storybook from 'eslint-plugin-storybook';
-
-import { storyFiles } from '../../../configs/file-globs-config';
-
-/**
- * Additional Storybook-specific rule overrides.
- *
- * Applies only to `.stories` files to enforce consistency in Storybook metadata.
- *
- * @see https://github.com/storybookjs/eslint-plugin-storybook
- */
-const overrides: Linter.FlatConfig = {
-  files: [storyFiles],
-  rules: {
-    'storybook/hierarchy-separator': 'error',
-  },
-};
-
-/**
- * ESLint Flat Config for Storybook.
- *
- * Combines the official `flat/recommended` config from `eslint-plugin-storybook`
- * with additional overrides for enforcing hierarchy separator style.
- */
-export const storybookEslintConfig: Linter.FlatConfig[] = [
-  ...(storybook.configs['flat/recommended'] as Linter.FlatConfig[]),
-  overrides,
-];

package/src/adapters/eslint/rules/eslint-tailwind-jsx.ts

@@ -1,21 +0,0 @@
-import { Linter } from 'eslint';
-import tailwindcss from 'eslint-plugin-tailwindcss';
-
-import { jsxTsxFiles } from '../../../configs/file-globs-config';
-
-/**
- * ESLint Flat Config for Tailwind CSS in JSX/TSX files.
- *
- * Applies `eslint-plugin-tailwindcss` recommended rules to React components using Tailwind.
- *
- * @see https://www.npmjs.com/package/eslint-plugin-tailwindcss
- */
-export const tailwindJsxConfig: Linter.FlatConfig = {
-  files: [jsxTsxFiles],
-  plugins: {
-    tailwindcss,
-  },
-  rules: {
-    ...tailwindcss.configs['flat/recommended'].rules,
-  },
-};

package/src/adapters/eslint/rules/eslint-tanstack.ts

@@ -1,25 +0,0 @@
-import pluginQuery from '@tanstack/eslint-plugin-query';
-import { Linter } from 'eslint';
-
-import { jsTsFiles } from '../../../configs/file-globs-config';
-
-/**
- * ESLint Flat Config for TanStack Query (React Query).
- *
- * Provides structure for applying TanStack's ruleset to JS/TS files using TanStack Query.
- * Extend this config by explicitly enabling the desired rules.
- *
- * @see https://github.com/TanStack/query/blob/main/docs/eslint/eslint-plugin-query.md
- */
-export const tanStackQueryEslintConfig: Linter.FlatConfig = {
-  files: [jsTsFiles],
-  plugins: {
-    '@tanstack/query': pluginQuery,
-  },
-  rules: {
-    ...pluginQuery.configs.recommended.rules,
-    // Add rules here as needed, e.g.:
-    // '@tanstack/query/exhaustive-deps': 'warn',
-    // '@tanstack/query/prefer-query-object-syntax': 'error',
-  },
-};

package/src/adapters/eslint/rules/eslint-tests.ts

@@ -1,35 +0,0 @@
-import vitest from '@vitest/eslint-plugin';
-import { ESLint, Linter } from 'eslint';
-
-import { testFiles } from '../../../configs/file-globs-config';
-
-/**
- * ESLint Flat Config for Vitest testing files.
- *
- * Applies recommended linting rules for Vitest test environments. This includes:
- * - Type-aware linting (when enabled),
- * - Test environment globals (e.g., `describe`, `it`, `expect`),
- * - Best practices and anti-patterns specific to testing.
- *
- * @see https://github.com/vitest-dev/eslint-plugin-vitest#rules
- */
-export const vitestEslintConfig: Linter.FlatConfig = {
-  files: testFiles,
-  plugins: {
-    vitest: vitest as unknown as ESLint.Plugin,
-  },
-  settings: {
-    vitest: {
-      typecheck: true, // enable type-aware test linting if applicable
-    },
-  },
-  languageOptions: {
-    globals: {
-      ...vitest.environments.env.globals,
-    },
-  },
-  rules: {
-    ...vitest.configs.recommended.rules,
-    // You can add specific overrides here as needed
-  },
-};

package/src/adapters/eslint/rules/eslint-typescript.ts

@@ -1,33 +0,0 @@
-import tsPlugin from '@typescript-eslint/eslint-plugin';
-import tsParser from '@typescript-eslint/parser';
-import { Linter } from 'eslint';
-
-import { tsFiles } from '../../../configs/file-globs-config';
-
-/**
- * ESLint Flat Config for TypeScript source files.
- *
- * This configuration enables type-aware linting using the `@typescript-eslint` plugin.
- * It loads `recommended-type-checked` rules and uses the project's `tsconfig.json`
- * for type resolution, allowing deeper semantic analysis.
- *
- * @see https://typescript-eslint.io/rules/
- */
-export const typescriptEslintConfig: Linter.FlatConfig = {
-  files: [tsFiles],
-  ignores: [],
-  languageOptions: {
-    parser: tsParser,
-    parserOptions: {
-      project: './tsconfig.json',
-      sourceType: 'module',
-    },
-  },
-  plugins: {
-    '@typescript-eslint': tsPlugin,
-  },
-  rules: {
-    ...tsPlugin.configs['recommended-type-checked'].rules,
-    // Add custom or stricter rules below if needed
-  },
-};

package/src/adapters/eslint/types/eslint-js.d.ts

@@ -1,4 +0,0 @@
-declare module '@eslint/js' {
-  const value: any;
-  export = value;
-}

package/src/adapters/eslint/types/eslint-plugin-jsx-a11y.d.ts

@@ -1,16 +0,0 @@
-declare module 'eslint-plugin-jsx-a11y' {
-  import type { Linter } from 'eslint';
-  const plugin: Linter.Plugin & {
-    flatConfigs?: {
-      recommended?: {
-        rules: Linter.RulesRecord;
-        languageOptions?: Linter.FlatConfig['languageOptions'];
-      };
-      strict?: {
-        rules: Linter.RulesRecord;
-        languageOptions?: Linter.FlatConfig['languageOptions'];
-      };
-    };
-  };
-  export default plugin;
-}

package/src/adapters/eslint/types/eslint-plugin-react-hooks.d.ts

@@ -1,9 +0,0 @@
-declare module 'eslint-plugin-react-hooks' {
-  import { ESLint } from 'eslint';
-
-  const plugin: ESLint.Plugin & {
-    configs: Record<string, any>;
-  };
-
-  export default plugin;
-}

package/src/adapters/eslint/types/eslint-plugin-react.d.ts

@@ -1,9 +0,0 @@
-declare module 'eslint-plugin-react' {
-  import { ESLint } from 'eslint';
-
-  const plugin: ESLint.Plugin & {
-    configs: Record<string, any>;
-  };
-
-  export default plugin;
-}

package/src/adapters/eslint/types/eslint-plugin-tailwindcss.d.ts

@@ -1,6 +0,0 @@
-declare module 'eslint-plugin-tailwindcss' {
-  const plugin: import('eslint').Linter.Plugin & {
-    configs: Record<string, { rules: import('eslint').Linter.RulesRecord }>;
-  };
-  export = plugin;
-}

package/src/adapters/eslint/types/eslint-shared-config.d.ts

@@ -1,3 +0,0 @@
-declare module 'eslint/config' {
-  export function defineConfig(config: any): any;
-}

package/src/adapters/ts-config/README.md

@@ -1,153 +0,0 @@
-# TypeScript Config — `@ovh-ux/manager-static-analysis-kit`
-
-This guide describes the TypeScript configuration layers provided by the `@ovh-ux/manager-static-analysis-kit`, supporting both standard and strict type safety modes for Node, React, and Testing environments.
-
----
-
-## 📦 Package Structure
-
-```
-ts-config/
-├── config/
-│   ├── standard/
-│   │   ├── tsconfig.node.ts
-│   │   ├── tsconfig.react.ts
-│   │   └── tsconfig.test.ts
-│   └── strict/
-│       ├── tsconfig.node.ts
-│       ├── tsconfig.react.ts
-│       └── tsconfig.test.ts
-├── rules/
-│   ├── tsconfig.base.ts
-│   └── tsconfig.base.strict.ts
-└── README.md
-```
-
----
-
-## 🧩 Base Rule Sets
-
-### `tsconfig.base.ts`
-
-A relaxed, default TypeScript ruleset including:
-
-- `strict: false`
-- `skipLibCheck: true`
-- `esModuleInterop: true`
-- `resolveJsonModule: true`
-- `jsx: preserve`
-- Includes DOM/ESNext lib targets
-
-### `tsconfig.base.strict.ts`
-
-A stricter variant enabling full type-safety:
-
-- `strict: true`
-- `noUncheckedIndexedAccess: true`
-- `noImplicitOverride: true`
-- `exactOptionalPropertyTypes: true`
-
----
-
-## 🔧 Config Variants
-
-Each environment has two variants: `standard` (base rules) and `strict` (stricter rules).
-
-| Purpose     | Standard Config                          | Strict Config                          |
-|-------------|-------------------------------------------|-----------------------------------------|
-| React App   | `tsconfig/react`                         | `tsconfig/react-strict`                |
-| Node Scripts| `tsconfig/node`                          | `tsconfig/node-strict`                 |
-| Unit Tests  | `tsconfig/test`                          | `tsconfig/test-strict`                 |
-
-These extend the appropriate base config and add contextual settings (e.g. `dom` lib for React, `node` lib for backend).
-
----
-
-## 🚀 Usage in µ-Applications
-
-### Example: Zimbra App
-
-```jsonc
-{
-  "extends": "@ovh-ux/manager-static-analysis-kit/tsconfig/react-strict",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "@/public/*": ["./public/*"],
-      "@/*": ["./src/*"]
-    },
-    "outDir": "dist",
-    "allowJs": true
-  },
-  "include": [
-    "src",
-    "public/**/*.json"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist",
-    "types"
-  ]
-}
-```
-
----
-
-## ✍️ Extend & Compose Configs
-
-Each base or strict config can be used as-is or composed via `extends` in your app-level `tsconfig.json`.
-
-For example:
-
-```json
-{
-  "extends": "@ovh-ux/manager-static-analysis-kit/tsconfig/node-strict"
-}
-```
-
----
-
-## 🛠 Compiler Features in Use
-
-All configurations benefit from:
-
-- Native ES Module support (`module: nodenext`)
-- JSX + TSX support (for React configs)
-- JSON module resolution
-- Local path mapping (`@/*`, `@/public/*`)
-- Out-of-the-box support for Vite
-
-
----
-
-## ⚙️ Per-App Customization
-
-To ensure consistency while enabling per-app customization, applications may override the following:
-
-- `compilerOptions.paths`
-- `compilerOptions.outDir`
-- `compilerOptions.allowImportingTsExtensions` (only if required)
-- `compilerOptions.allowJs` (only if required)
-- `compilerOptions.resolveJsonModule` (only if required)
-- `compilerOptions.noImplicitAny` (only if required)
-- `include`
-- `exclude`
-
----
-
-## ✅ Allowed Overrides for µ-Apps
-
-To ensure consistency while enabling per-app customization, applications may override the following:
-
-- `compilerOptions.paths`
-- `compilerOptions.outDir`
-- `compilerOptions.allowImportingTsExtensions` (only if required)
-- `include`
-- `exclude`
-
-Apps **must not** redefine:
-
-- `target`, `module`, `jsx`, `strict`, `lib`, etc.
-- Any `strict`-level rules overridden by the base config
-
-This policy ensures a reliable shared base while supporting edge-case requirements per project.

package/src/adapters/ts-config/config/standard/tsconfig.node.ts

@@ -1,13 +0,0 @@
-import { tsBaseConfig } from '../../rules/tsconfig.base';
-
-export default {
-  ...tsBaseConfig,
-  compilerOptions: {
-    ...tsBaseConfig.compilerOptions,
-    target: 'ES2022',
-    module: 'NodeNext',
-    moduleResolution: 'NodeNext',
-    lib: ['ES2022'],
-    types: ['node'],
-  },
-};

package/src/adapters/ts-config/config/standard/tsconfig.react.ts

@@ -1,15 +0,0 @@
-import { tsBaseConfig } from '../../rules/tsconfig.base';
-
-export default {
-  ...tsBaseConfig,
-  compilerOptions: {
-    ...tsBaseConfig.compilerOptions,
-    module: 'ESNext',
-    moduleResolution: 'bundler',
-    lib: ['DOM', 'DOM.Iterable', 'ES2021'],
-    jsx: 'react-jsx',
-    isolatedModules: true,
-    noEmit: true,
-    types: ['vite/client'],
-  },
-};

package/src/adapters/ts-config/config/standard/tsconfig.test.ts

@@ -1,13 +0,0 @@
-import { tsBaseConfig } from '../../rules/tsconfig.base';
-
-export default {
-  ...tsBaseConfig,
-  compilerOptions: {
-    ...tsBaseConfig.compilerOptions,
-    module: 'ESNext',
-    moduleResolution: 'NodeNext',
-    types: ['vitest/globals', 'vite/client', 'node', '@testing-library/jest-dom'],
-    jsx: 'react-jsx',
-  },
-  include: ['**/*.test.ts', '**/*.test.tsx', '**/*.spec.ts', '**/*.spec.tsx', 'vitest.setup.ts'],
-};

package/src/adapters/ts-config/config/strict/tsconfig.node.ts

@@ -1,13 +0,0 @@
-import { tsStrictBaseConfig } from '../../rules/tsconfig.base.strict';
-
-export default {
-  ...tsStrictBaseConfig,
-  compilerOptions: {
-    ...tsStrictBaseConfig.compilerOptions,
-    target: 'ES2022',
-    module: 'NodeNext',
-    moduleResolution: 'NodeNext',
-    lib: ['ES2022'],
-    types: ['node'],
-  },
-};