@xylabs/eslint-config-flat 3.9.1

package/src/import/index.ts

@@ -0,0 +1,35 @@
+import { ESLint } from 'eslint'
+
+export const importConfig: ESLint.ConfigData = {
+  extends: ['plugin:import/errors', 'plugin:import/warnings', 'plugin:import/typescript'],
+  plugins: ['import', 'simple-import-sort'],
+  rules: {
+    'import/default': ['off'],
+    'import/named': ['off'],
+    'import/namespace': ['off'],
+    'import/no-absolute-path': ['warn'],
+    'import/no-cycle': [
+      'warn',
+      {
+        maxDepth: 2,
+      },
+    ],
+    'import/no-default-export': ['warn'],
+    'import/no-deprecated': ['warn'],
+    'import/no-internal-modules': ['warn'],
+    'import/no-named-as-default': ['warn'],
+    'import/no-named-as-default-member': ['off'],
+    'import/no-restricted-paths': ['warn'],
+    'import/no-self-import': ['warn'],
+    'import/no-useless-path-segments': ['warn'],
+    'simple-import-sort/exports': ['warn'],
+    'simple-import-sort/imports': ['warn'],
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {
+        alwaysTryTypes: true,
+      },
+    },
+  },
+}

package/src/index.ts

@@ -0,0 +1,82 @@
+import { ESLint } from 'eslint'
+// eslint-disable-next-line import/no-internal-modules
+import compact from 'lodash/compact'
+
+import { importConfig } from './import'
+//import { jsonConfig } from './json'
+//import { markdownConfig } from './markdown'
+import { prettierConfig } from './prettier'
+import { rulesConfig } from './rules'
+import { typescriptConfig } from './typescript'
+import { unicornConfig } from './unicorn'
+import { workspacesConfig } from './workspaces'
+
+const toArray = <T>(value: T | (T | undefined)[] | undefined): T[] => {
+  if (value === undefined) {
+    return []
+  }
+  return Array.isArray(value) ? compact(value) : compact([value])
+}
+
+const config: ESLint.ConfigData = {
+  extends: [
+    ...toArray(typescriptConfig.extends),
+    ...toArray(workspacesConfig.extends),
+    ...toArray(rulesConfig.extends),
+    //...toArray(markdownConfig.extends),
+    ...toArray(importConfig.extends),
+    //...toArray(jsonConfig.extends),
+    ...toArray(prettierConfig.extends),
+    ...toArray(unicornConfig.extends),
+  ],
+  ignorePatterns: ['node_modules', 'dist', 'bin', 'storybook-static', '.github', '.vscode', '.yarn', 'package.json'],
+  overrides: [
+    ...toArray(typescriptConfig.overrides),
+    ...toArray(workspacesConfig.overrides),
+    ...toArray(rulesConfig.overrides),
+    //...toArray(markdownConfig.overrides),
+    ...toArray(importConfig.overrides),
+    //...toArray(jsonConfig.overrides),
+    ...toArray(prettierConfig.overrides),
+    ...toArray(unicornConfig.overrides),
+  ],
+  plugins: [
+    ...toArray(typescriptConfig.plugins),
+    ...toArray(workspacesConfig.plugins),
+    ...toArray(rulesConfig.plugins),
+    //...toArray(markdownConfig.plugins),
+    ...toArray(importConfig.plugins),
+    //...toArray(jsonConfig.plugins),
+    ...toArray(prettierConfig.plugins),
+    ...toArray(unicornConfig.plugins),
+  ],
+  rules: {
+    ...typescriptConfig.rules,
+    ...workspacesConfig.rules,
+    ...rulesConfig.rules,
+    //...markdownConfig.rules,
+    ...importConfig.rules,
+    //...jsonConfig.rules,
+    ...prettierConfig.rules,
+    ...unicornConfig.rules,
+  },
+  settings: {
+    ...typescriptConfig.settings,
+    ...workspacesConfig.settings,
+    ...rulesConfig.settings,
+    //...markdownConfig.settings,
+    ...importConfig.settings,
+    //...jsonConfig.settings,
+    ...prettierConfig.settings,
+    ...unicornConfig.settings,
+  },
+}
+
+/* We use export default to make the type generation correct */
+
+// eslint-disable-next-line import/no-default-export
+export default config
+
+/* We use module.exports to make the plugin load work */
+
+module.exports = config

package/src/json/index.ts

@@ -0,0 +1,11 @@
+import { ESLint } from 'eslint'
+
+export const jsonConfig: ESLint.ConfigData = {
+  overrides: [
+    {
+      extends: 'plugin:jsonc/recommended-with-jsonc',
+      files: ['*.json'],
+      parser: 'jsonc-eslint-parser',
+    },
+  ],
+}

package/src/markdown/index.ts

@@ -0,0 +1,26 @@
+import { ESLint } from 'eslint'
+
+export const markdownConfig: ESLint.ConfigData = {
+  extends: ['plugin:md/recommended'],
+  overrides: [
+    {
+      files: ['*.md'],
+      parser: 'markdown-eslint-parser',
+      rules: {
+        'md/remark': [
+          'warn',
+          {
+            plugins: ['preset-lint-markdown-style-guide', 'frontmatter', ['lint-list-item-indent', 'tab-size']],
+          },
+        ],
+        'prettier/prettier': [
+          'off',
+          // Important to force prettier to use "markdown" parser - otherwise it wouldn't be able to parse *.md files.
+          // You also can configure other options supported by prettier here - "prose-wrap" is
+          // particularly useful for *.md files
+          { parser: 'markdown' },
+        ],
+      },
+    },
+  ],
+}

package/src/prettier/index.ts

@@ -0,0 +1,22 @@
+import { ESLint } from 'eslint'
+
+export const prettierConfig: ESLint.ConfigData = {
+  extends: ['plugin:prettier/recommended'],
+  plugins: ['prettier'],
+  rules: {
+    'prettier/prettier': [
+      'warn',
+      {
+        bracketSpacing: true,
+        endOfLine: 'lf',
+        experimentalTernaries: true,
+        printWidth: 150,
+        semi: false,
+        singleQuote: true,
+        tabWidth: 2,
+        trailingComma: 'all',
+        useTabs: false,
+      },
+    ],
+  },
+}

package/src/rules/index.ts

@@ -0,0 +1,48 @@
+import { ESLint } from 'eslint'
+
+export const rulesConfig: ESLint.ConfigData = {
+  extends: ['plugin:deprecation/recommended'],
+  plugins: ['sort-keys-fix', 'no-secrets'],
+  rules: {
+    complexity: ['error', 18],
+    'deprecation/deprecation': ['warn'],
+    'max-depth': ['error', 6],
+    'max-lines': [
+      'error',
+      {
+        max: 512,
+        skipBlankLines: true,
+      },
+    ],
+    'max-nested-callbacks': ['error', 6],
+    'max-statements': ['error', 32],
+    'no-restricted-imports': [
+      'warn',
+      {
+        paths: [
+          'lodash',
+          'react-player',
+          'filepond',
+          'aos',
+          'react-icons',
+          '.',
+          '..',
+          '../..',
+          '../../..',
+          '../../../..',
+          '../../../../..',
+          '../../../../../..',
+          '../../../../../../..',
+        ],
+      },
+    ],
+    'no-secrets/no-secrets': ['off'],
+    'no-tabs': ['error'],
+    'no-unused-vars': 'off',
+    'no-useless-escape': 'off',
+    quotes: [2, 'single', 'avoid-escape'],
+    'require-await': 'error',
+    semi: ['warn', 'never'],
+    'sort-keys-fix/sort-keys-fix': 'warn',
+  },
+}

package/src/typescript/index.ts

@@ -0,0 +1,113 @@
+import { ESLint } from 'eslint'
+
+export const typescriptConfig: ESLint.ConfigData = {
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  overrides: [
+    {
+      files: ['*.ts*', '*.d.ts*'],
+      parser: '@typescript-eslint/parser',
+      parserOptions: { ecmaVersion: 'latest', project: ['./tsconfig.json'], tsconfigRootDir: __dirname },
+      plugins: ['@typescript-eslint'],
+      rules: {
+        '@typescript-eslint/explicit-member-accessibility': ['warn', { accessibility: 'no-public' }],
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/member-delimiter-style': [
+          'error',
+          {
+            multiline: {
+              delimiter: 'none',
+              requireLast: true,
+            },
+            singleline: {
+              delimiter: 'semi',
+              requireLast: false,
+            },
+          },
+        ],
+        '@typescript-eslint/member-ordering': [
+          'warn',
+          {
+            default: {
+              memberTypes: [
+                'signature',
+                'call-signature',
+                'public-static-field',
+                'protected-static-field',
+                'private-static-field',
+                'public-decorated-field',
+                'protected-decorated-field',
+                'private-decorated-field',
+                'public-instance-field',
+                'protected-instance-field',
+                'private-instance-field',
+                'public-abstract-field',
+                'protected-abstract-field',
+                'public-field',
+                'protected-field',
+                'private-field',
+                'static-field',
+                'instance-field',
+                'abstract-field',
+                'decorated-field',
+                'field',
+                'public-constructor',
+                'protected-constructor',
+                'private-constructor',
+                'constructor',
+                ['public-static-get', 'public-static-set'],
+                ['protected-static-get', 'protected-static-set'],
+                ['private-static-get', 'private-static-set'],
+                ['public-decorated-get', 'public-decorated-set'],
+                ['protected-decorated-get', 'protected-decorated-set'],
+                ['private-decorated-get', 'private-decorated-set'],
+                ['public-instance-get', 'public-instance-set'],
+                ['protected-instance-get', 'protected-instance-set'],
+                ['private-instance-get', 'private-instance-set'],
+                ['public-abstract-get', 'public-abstract-set'],
+                ['protected-abstract-get', 'protected-abstract-set'],
+                ['public-get', 'public-set'],
+                ['protected-get', 'protected-set'],
+                ['private-get', 'private-set'],
+                ['static-get', 'static-set'],
+                ['instance-get', 'instance-set'],
+                ['abstract-get', 'abstract-set'],
+                ['decorated-get', 'decorated-set'],
+                'get',
+                'set',
+                'public-static-method',
+                'protected-static-method',
+                'private-static-method',
+                'public-decorated-method',
+                'protected-decorated-method',
+                'private-decorated-method',
+                'public-instance-method',
+                'protected-instance-method',
+                'private-instance-method',
+                'public-abstract-method',
+                'protected-abstract-method',
+                'public-method',
+                'protected-method',
+                'private-method',
+                'static-method',
+                'instance-method',
+                'abstract-method',
+                'decorated-method',
+                'method',
+              ],
+              order: 'alphabetically',
+            },
+          },
+        ],
+        '@typescript-eslint/no-floating-promises': 'error',
+        '@typescript-eslint/no-misused-promises': 'error',
+        '@typescript-eslint/no-unused-vars': [
+          'warn',
+          {
+            argsIgnorePattern: '^_',
+          },
+        ],
+        '@typescript-eslint/semi': ['warn', 'never'],
+      },
+    },
+  ],
+}

package/src/unicorn/index.ts

@@ -0,0 +1,22 @@
+import { ESLint } from 'eslint'
+
+export const unicornConfig: ESLint.ConfigData = {
+  env: {
+    es2024: true,
+  },
+  extends: ['plugin:unicorn/recommended'],
+  rules: {
+    'unicorn/catch-error-name': ['off'],
+    'unicorn/consistent-function-scoping': ['off'],
+    'unicorn/filename-case': ['off'],
+    'unicorn/new-for-builtins': ['off'],
+    'unicorn/no-array-callback-reference': ['off'],
+    'unicorn/no-await-expression-member': ['off'],
+    'unicorn/no-nested-ternary': ['off'],
+    'unicorn/no-null': ['off'],
+    'unicorn/number-literal-case': ['off'],
+    'unicorn/prefer-module': ['off'],
+    'unicorn/prefer-top-level-await': ['off'],
+    'unicorn/prevent-abbreviations': ['off'],
+  },
+}

package/src/workspaces/index.ts

@@ -0,0 +1,10 @@
+import { ESLint } from 'eslint'
+
+export const workspacesConfig: ESLint.ConfigData = {
+  extends: ['plugin:workspaces/recommended'],
+  plugins: ['workspaces'],
+  rules: {
+    'workspaces/no-relative-imports': ['off'],
+    'workspaces/require-dependency': ['off'],
+  },
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "exclude": ["dist", "docs", "node_modules"],
+  "extends": "@xylabs/tsconfig"
+}

package/tsconfig.test.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["**/*.spec.ts"]
+}

package/xy.config.ts

@@ -0,0 +1,9 @@
+import { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    browser: {},
+  },
+}
+
+// eslint-disable-next-line import/no-default-export
+export default config