@elliemae/pui-cli 9.0.0-alpha.1 → 9.0.0-alpha.11

package/lib/lint-config/commitlint.config.cjs

@@ -0,0 +1 @@
+exports.commitlintConfig = { extends: ['@commitlint/config-conventional'] };

package/lib/lint-config/eslint/common.cjs

@@ -0,0 +1,164 @@
+ 
+const prettierOptions = require("../prettier.config.cjs");
+// const webpackConfig = require('../../webpack/webpack.prod.babel');
+
+exports.baseExtends = [
+  "plugin:eslint-comments/recommended",
+  "plugin:import/recommended",
+  "plugin:prettier/recommended",
+  "plugin:jest/recommended",
+  "plugin:jsdoc/recommended",
+  "plugin:wdio/recommended",
+  "plugin:testing-library/dom",
+  "plugin:storybook/recommended",
+];
+
+const basePlugins = ["testing-library", "jest", "jsdoc", "wdio", "import"];
+exports.basePlugins = basePlugins;
+
+exports.baseOverrides = [
+  {
+    files: ["*.func.spec.js", "*.visual.spec.js"],
+    rules: {
+      "jest/valid-expect": "off",
+    },
+  },
+];
+
+const baseRules = {
+  "prettier/prettier": ["error", prettierOptions],
+  "arrow-body-style": [2, "as-needed"],
+  "class-methods-use-this": 0,
+  "import/imports-first": 0,
+  "import/newline-after-import": 0,
+  "import/no-dynamic-require": 0,
+  "import/no-extraneous-dependencies": 0,
+  "import/no-named-as-default": 0,
+  "import/no-unresolved": [
+    2,
+    { caseSensitive: true, caseSensitiveStrict: true },
+  ], // Tip: https://github.com/import-js/eslint-plugin-import/issues/1868
+  "import/no-webpack-loader-syntax": 0,
+  "import/prefer-default-export": 0,
+  "import/extensions": [
+    2,
+    "never",
+    {
+      json: "ignorePackages",
+      js: "ignorePackages",
+    },
+  ],
+  indent: [
+    2,
+    2,
+    {
+      SwitchCase: 1,
+    },
+  ],
+  "max-lines": ["error", { max: 120, skipComments: true }],
+  complexity: ["error", { max: 10 }],
+  "max-depth": ["error", { max: 4 }],
+  "max-lines-per-function": 0,
+  "max-nested-callbacks": ["error", { max: 3 }],
+  "max-params": ["error", { max: 3 }],
+  "max-statements": ["error", { max: 20 }],
+  "max-len": 0,
+  "newline-per-chained-call": 0,
+  "no-confusing-arrow": 0,
+  "no-console": 1,
+  "no-param-reassign": ["error", { props: false }],
+  "no-unused-vars": 2,
+  "no-use-before-define": 0,
+  "prefer-template": 2,
+  "require-yield": 0,
+  "jsdoc/require-jsdoc": 0,
+  "eslint-comments/disable-enable-pair": 0,
+};
+
+exports.baseRules = baseRules;
+
+const reactRules = {
+  "jsx-a11y/aria-props": 2,
+  "jsx-a11y/heading-has-content": 0,
+  "jsx-a11y/label-has-associated-control": [
+    2,
+    {
+      // NOTE: If this error triggers, either disable it or add
+      // your custom components, labels and attributes via these options
+      // See https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/label-has-associated-control.md
+      controlComponents: ["Input"],
+    },
+  ],
+  "jsx-a11y/label-has-for": 0,
+  "jsx-a11y/mouse-events-have-key-events": 2,
+  "jsx-a11y/role-has-required-aria-props": 2,
+  "jsx-a11y/role-supports-aria-props": 2,
+  "react/destructuring-assignment": 0,
+  "react-hooks/rules-of-hooks": "error",
+  "react/jsx-closing-tag-location": 0,
+  "react/forbid-prop-types": 0,
+  "react/jsx-first-prop-new-line": [2, "multiline"],
+  "react/jsx-no-target-blank": 0,
+  "react/jsx-props-no-spreading": 0,
+  "react/jsx-uses-vars": 2,
+  "react/require-default-props": 0,
+  "react/require-extension": 0,
+  "react/self-closing-comp": 0,
+  "react/sort-comp": 0,
+  "react/react-in-jsx-scope": 0,
+  "react/jsx-filename-extension": [
+    1,
+    { extensions: [".js", ".jsx", ".tsx", ".mdx"] },
+  ],
+  "react/function-component-definition": [
+    2,
+    { namedComponents: "arrow-function" },
+  ],
+  "redux-saga/no-yield-in-race": 2,
+  "redux-saga/yield-effects": 2,
+};
+exports.reactRules = reactRules;
+
+exports.baseConfig = {
+  parser: "@babel/eslint-parser",
+  plugins: basePlugins,
+  env: {
+    jest: true,
+    browser: true,
+    node: true,
+    es2021: true,
+  },
+  parserOptions: {
+    sourceType: "module",
+    ecmaFeatures: {
+      jsx: true,
+    },
+    babelOptions: {
+      plugins: ["@babel/plugin-syntax-import-assertions"],
+    },
+  },
+  settings: {
+    react: {
+      version: "detect",
+    },
+    jest: {
+      version: 28,
+    },
+    "import/resolver": {
+      node: {
+        extensions: [".js", ".jsx", ".ts", ".tsx"],
+      },
+    },
+  },
+  ignorePatterns: [
+    "/build/**/*",
+    "/node_modules/**/*",
+    "/dist/**/*",
+    "/reports/**/*",
+    "/coverage/**/*",
+    "/demo/**/*",
+    "/docs/**/*",
+    "/temp/**/*",
+    "**/vendor/*.js",
+  ],
+};

package/lib/lint-config/eslint/flat/common.mjs

@@ -0,0 +1,169 @@
+import eslint from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import importX from 'eslint-plugin-import-x';
+import jest from 'eslint-plugin-jest';
+import testingLibrary from 'eslint-plugin-testing-library';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+import {
+  jestRecommendedRules,
+  sharedCoreRules,
+  testFiles,
+  testFixtureFiles,
+  testJsxFiles,
+  testingLibraryDomRules,
+  testingLibraryReactRules,
+  wdioGlobals,
+  wdioPlugin,
+  wdioRecommendedRules,
+  wdioSpecFiles,
+} from './presets.mjs';
+import {
+  ignorePatterns,
+  jsRules,
+  typescriptRules,
+  typescriptStrictRules,
+  testFixtureRelaxedRules,
+  typescriptTestRelaxedRules,
+} from './rules.mjs';
+
+const tsconfigRootDir = process.cwd();
+
+const typescriptParserOptions = {
+  projectService: true,
+  tsconfigRootDir,
+};
+
+/** Cached flat config arrays (only two variants: default + strict). */
+const configCache = new Map();
+
+/** @param {Record<string, unknown>} tsRules - `typescriptRules` or `typescriptStrictRules` */
+export function createBaseFlatConfigs(tsRules) {
+  if (configCache.has(tsRules)) {
+    return configCache.get(tsRules);
+  }
+
+  const config = defineConfig(
+    { ignores: ignorePatterns },
+    eslint.configs.recommended,
+    eslintConfigPrettier,
+    {
+      plugins: {
+        'import-x': importX,
+      },
+      languageOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        parserOptions: {
+          ecmaFeatures: { jsx: true },
+        },
+        globals: {
+          ...globals.browser,
+          ...globals.node,
+          ...globals.es2021,
+        },
+      },
+      settings: {
+        'import-x/resolver': {
+          node: { extensions: ['.js', '.jsx', '.ts', '.tsx'] },
+          typescript: { alwaysTryTypes: true },
+        },
+      },
+      rules: sharedCoreRules,
+    },
+    {
+      files: ['**/*.{js,jsx,mjs,cjs}'],
+      rules: jsRules,
+    },
+    ...tseslint.configs.recommendedTypeChecked.map((config) => ({
+      ...config,
+      files: ['**/*.{ts,tsx}'],
+    })),
+    {
+      files: ['**/*.{ts,tsx}'],
+      rules: tsRules,
+      languageOptions: {
+        parserOptions: typescriptParserOptions,
+      },
+    },
+    {
+      files: testFiles,
+      plugins: {
+        jest,
+        'testing-library': testingLibrary,
+      },
+      languageOptions: {
+        globals: globals.jest,
+      },
+      settings: {
+        jest: { version: 'detect' },
+      },
+      rules: {
+        ...jestRecommendedRules,
+        ...testingLibraryDomRules,
+        'testing-library/no-node-access': 'off',
+        ...typescriptTestRelaxedRules,
+      },
+    },
+    {
+      files: testJsxFiles,
+      rules: {
+        ...testingLibraryReactRules,
+        'testing-library/no-node-access': 'off',
+      },
+    },
+    {
+      files: testFixtureFiles,
+      rules: testFixtureRelaxedRules,
+    },
+    {
+      files: wdioSpecFiles,
+      plugins: { wdio: wdioPlugin, jest },
+      languageOptions: { globals: wdioGlobals },
+      rules: {
+        ...wdioRecommendedRules,
+        // JS e2e specs are not type-checked; use await-expect instead of no-floating-promise.
+        'wdio/await-expect': 'error',
+        'wdio/no-floating-promise': 'off',
+        'jest/valid-expect': 'off',
+      },
+    },
+    {
+      files: ['**/eslint.config.{mjs,cjs,js}'],
+      rules: { 'import-x/no-unresolved': 'off' },
+    },
+    {
+      files: ['**/scripts/**', '**/ci_cd/**'],
+      rules: {
+        'no-console': 'off',
+        'max-lines': 'off',
+        complexity: 'off',
+      },
+    },
+    {
+      files: ['**/lint-config/**'],
+      rules: {
+        'max-lines': 'off',
+        'import-x/no-named-as-default-member': 'off',
+        'import-x/default': 'off',
+      },
+    },
+    {
+      files: ['**/*.d.ts'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-empty-object-type': 'off',
+      },
+    },
+  );
+
+  configCache.set(tsRules, config);
+  return config;
+}
+
+/** Default flat base — `no-unsafe-*` as warn in application TypeScript. */
+export const baseFlatConfigs = createBaseFlatConfigs(typescriptRules);
+
+/** Strict flat base — `no-unsafe-*` as error in application TypeScript. */
+export const baseFlatConfigsStrict = createBaseFlatConfigs(typescriptStrictRules);

package/lib/lint-config/eslint/flat/compat.mjs

@@ -0,0 +1,27 @@
+/**
+ * ESLint 10 removed deprecated context APIs (e.g. getSourceCode, getScope, getFilename).
+ * Wrap legacy plugins via @eslint/compat v2 (ESLint 10–aware fixupPluginRules).
+ */
+import { fixupConfigRules, fixupPluginRules } from '@eslint/compat';
+import react from 'eslint-plugin-react';
+import reduxSaga from 'eslint-plugin-redux-saga';
+import storybook from 'eslint-plugin-storybook';
+
+const storybookFlat =
+  storybook.configs['flat/recommended'] ??
+  storybook.configs.recommended ??
+  [];
+
+/** React — uses context.getFilename / getScope (eslint-plugin-react@7). */
+/** @type {import('eslint').ESLint.Plugin} */
+export const reactPlugin = fixupPluginRules(react);
+
+/** Redux-saga — uses context.getScope in no-yield-in-race. */
+/** @type {import('eslint').ESLint.Plugin} */
+export const reduxSagaPlugin = fixupPluginRules(reduxSaga);
+
+/** Storybook flat presets — uses legacy context APIs (eslint-plugin-storybook@0.12). */
+/** @type {import('eslint').Linter.Config[]} */
+export const storybookFlatConfigs = fixupConfigRules(
+  Array.isArray(storybookFlat) ? storybookFlat : [storybookFlat],
+);

package/lib/lint-config/eslint/flat/index.mjs

@@ -0,0 +1,21 @@
+export { eslintFlatConfig, eslintFlatConfigStrict } from './react-export.mjs';
+export {
+  eslintFlatBaseConfig,
+  eslintFlatBaseConfigStrict,
+} from './non-react-export.mjs';
+export { reactFlatConfigs, reactFlatConfigsStrict } from './react.mjs';
+export {
+  nonReactFlatConfigs,
+  nonReactFlatConfigsStrict,
+} from './non-react.mjs';
+export {
+  baseFlatConfigs,
+  baseFlatConfigsStrict,
+  createBaseFlatConfigs,
+} from './common.mjs';
+export {
+  storybookFiles,
+  testFiles,
+  testFixtureFiles,
+  testJsxFiles,
+} from './presets.mjs';

package/lib/lint-config/eslint/flat/non-react-export.mjs

@@ -0,0 +1,10 @@
+import {
+  nonReactFlatConfigs,
+  nonReactFlatConfigsStrict,
+} from './non-react.mjs';
+
+/** Flat ESLint config for non-React TypeScript libraries and services. */
+export const eslintFlatBaseConfig = nonReactFlatConfigs;
+
+/** Strict flat ESLint config for non-React TypeScript (`no-unsafe-*` as error). */
+export const eslintFlatBaseConfigStrict = nonReactFlatConfigsStrict;

package/lib/lint-config/eslint/flat/non-react.mjs

@@ -0,0 +1,6 @@
+import { baseFlatConfigs, baseFlatConfigsStrict } from './common.mjs';
+
+/** `defineConfig` already applied in `createBaseFlatConfigs`. */
+export const nonReactFlatConfigs = baseFlatConfigs;
+
+export const nonReactFlatConfigsStrict = baseFlatConfigsStrict;

package/lib/lint-config/eslint/flat/presets.mjs

@@ -0,0 +1,96 @@
+/**
+ * Preset rule bundles and file globs computed once at module load (not per config factory call).
+ */
+import importX from 'eslint-plugin-import-x';
+import jest from 'eslint-plugin-jest';
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+import react from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import reduxSaga from 'eslint-plugin-redux-saga';
+import testingLibrary from 'eslint-plugin-testing-library';
+import wdio from 'eslint-plugin-wdio';
+import { storybookFlatConfigs } from './compat.mjs';
+
+/** Application and integration tests (Jest + relaxed type-checked rules). */
+export const testFiles = [
+  '**/*.{test,spec}.{js,jsx,ts,tsx}',
+  '**/__tests__/**',
+  '**/lib/testing/**',
+  '**/mocks/**',
+  // PUI libs/apps co-locate tests under lib/ (e.g. pui-app-sdk, pui-app-loader).
+  'lib/**/tests/**',
+  'app/**/tests/**',
+];
+
+/**
+ * Generated or vendored JS under test trees (checksum bundles, MSW endpoints, pinned assets).
+ * Not maintained source — relax structural rules only.
+ */
+export const testFixtureFiles = [
+  '**/*.checksum*.js',
+  '**/*.endpoint.js',
+  '**/tests/**/latest/*.{js,cjs,mjs}',
+  '**/tests/**/[0-9]*.[0-9]*/*.{js,cjs,mjs}',
+];
+
+export const testJsxFiles = ['**/*.{test,spec}.{jsx,tsx}'];
+
+export const wdioSpecFiles = [
+  '**/*.func.spec.js',
+  '**/*.visual.spec.js',
+  '**/*e2e*.{js,ts}',
+  '**/e2e/**',
+];
+
+export const storybookFiles = [
+  '**/*.stories.{js,jsx,ts,tsx}',
+  '**/.storybook/**',
+];
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const sharedCoreRules = {
+  ...importX.configs.recommended.rules,
+  'import-x/named': 'off',
+};
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const jestRecommendedRules = jest.configs.recommended.rules;
+
+const testingLibraryDom =
+  testingLibrary.configs['flat/dom'] ?? testingLibrary.configs.dom;
+const testingLibraryReact =
+  testingLibrary.configs['flat/react'] ?? testingLibrary.configs.react;
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const testingLibraryDomRules = testingLibraryDom?.rules ?? {};
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const testingLibraryReactRules = testingLibraryReact?.rules ?? {};
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const reactPresetRules = {
+  ...react.configs.recommended.rules,
+  ...reactHooks.configs.recommended.rules,
+  ...jsxA11y.flatConfigs.recommended.rules,
+  ...reduxSaga.configs.recommended.rules,
+};
+
+/**
+ * eslint-plugin-wdio v9 default export exposes config severities as `rules` when
+ * typescript-eslint is installed. Use flat/recommended's nested plugin instead.
+ */
+const wdioFlatRecommended =
+  wdio.configs['flat/recommended'] ?? wdio.configs.recommended;
+
+export const wdioPlugin = wdioFlatRecommended.plugins?.wdio ?? wdio;
+
+/** @type {import('eslint').Linter.RulesRecord} */
+export const wdioRecommendedRules = wdioFlatRecommended.rules ?? {};
+
+/** @type {Record<string, boolean>} */
+export const wdioGlobals =
+  wdioFlatRecommended.languageOptions?.globals ??
+  wdio.configs.recommended.globals ??
+  {};
+
+export { storybookFlatConfigs };

package/lib/lint-config/eslint/flat/react-export.mjs

@@ -0,0 +1,7 @@
+import { reactFlatConfigs, reactFlatConfigsStrict } from './react.mjs';
+
+/** Flat ESLint config for React + TypeScript PUI apps. */
+export const eslintFlatConfig = reactFlatConfigs;
+
+/** Strict flat ESLint config for React + TypeScript (errors on `no-unsafe-*` and `exhaustive-deps`). */
+export const eslintFlatConfigStrict = reactFlatConfigsStrict;

package/lib/lint-config/eslint/flat/react.mjs

@@ -0,0 +1,59 @@
+import { defineConfig } from 'eslint/config';
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+import reactHooks from 'eslint-plugin-react-hooks';
+import { baseFlatConfigs, baseFlatConfigsStrict } from './common.mjs';
+import { reactPlugin, reduxSagaPlugin } from './compat.mjs';
+import {
+  reactPresetRules,
+  storybookFiles,
+  storybookFlatConfigs,
+} from './presets.mjs';
+import { reactRules, reactStrictRules } from './rules.mjs';
+
+const reactPluginBlock = {
+  plugins: {
+    react: reactPlugin,
+    'react-hooks': reactHooks,
+    'jsx-a11y': jsxA11y,
+    'redux-saga': reduxSagaPlugin,
+  },
+  settings: {
+    react: { version: 'detect' },
+  },
+};
+
+/**
+ * @param {import('eslint').Linter.Config[]} baseConfigs
+ * @param {typeof reactRules} puiReactRules
+ */
+function createReactFlatConfigs(baseConfigs, puiReactRules) {
+  return defineConfig(
+    ...baseConfigs,
+    {
+      ...reactPluginBlock,
+      rules: {
+        ...reactPresetRules,
+        ...puiReactRules,
+      },
+    },
+    ...storybookFlatConfigs,
+    {
+      files: storybookFiles,
+      rules: {
+        'react/jsx-props-no-spreading': 'off',
+      },
+    },
+  );
+}
+
+/** Default React flat config — migration-friendly type-safety warnings. */
+export const reactFlatConfigs = createReactFlatConfigs(
+  baseFlatConfigs,
+  reactRules,
+);
+
+/** Strict React flat config — `no-unsafe-*` and `exhaustive-deps` as error. */
+export const reactFlatConfigsStrict = createReactFlatConfigs(
+  baseFlatConfigsStrict,
+  reactStrictRules,
+);