@ixo/eslint-config 1.0.0

package/README.md

@@ -0,0 +1,3 @@
+# `@turbo/eslint-config`
+
+Collection of internal eslint configurations.

package/base.js

@@ -0,0 +1,75 @@
+const { resolve } = require('node:path');
+
+const project = resolve(process.cwd(), 'tsconfig.json');
+
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  root: true,
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+    'prettier',
+    'turbo',
+    require.resolve('@vercel/style-guide/eslint/node'),
+    require.resolve('@vercel/style-guide/eslint/typescript'),
+    'eslint-config-turbo',
+  ],
+  rules: {
+    '@typescript-eslint/array-type': 'off',
+    '@typescript-eslint/consistent-type-definitions': 'off',
+    'import/no-extraneous-dependencies': 'off',
+    '@typescript-eslint/consistent-type-imports': [
+      'warn',
+      {
+        prefer: 'type-imports',
+        fixStyle: 'inline-type-imports',
+      },
+    ],
+    '@typescript-eslint/no-unused-vars': [
+      'warn',
+      {
+        argsIgnorePattern: '^_',
+      },
+    ],
+    '@typescript-eslint/require-await': 'off',
+    '@typescript-eslint/no-misused-promises': [
+      'error',
+      {
+        checksVoidReturn: {
+          attributes: false,
+        },
+      },
+    ],
+    'import/order': 'off',
+    'no-console': 'warn',
+    '@typescript-eslint/no-dynamic-delete': 'off',
+    /** no-undef is not useful for typescript already typescript checks and this rule will error on any global interface in any declaration file */
+    'no-undef': 'off',
+    'import/named': 'off',
+    'import/no-default-export': 'off',
+    'object-shorthand': 'error',
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        selector: 'interface',
+        format: ['PascalCase'],
+        custom: {
+          regex: '^I[A-Z]',
+          match: true,
+        },
+      },
+    ],
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  parser: '@typescript-eslint/parser',
+  ignorePatterns: [
+    '.*.js',
+    '*.setup.js',
+    '*.config.js',
+    '.turbo/',
+    'dist/',
+    'coverage/',
+    'node_modules/',
+    '**/gql/generated/**',
+  ],
+};

package/library.js

@@ -0,0 +1,29 @@
+const { resolve } = require('node:path');
+
+const project = resolve(process.cwd(), 'tsconfig.json');
+
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  extends: ['./base.js'],
+  plugins: ['only-warn'],
+  globals: {
+    React: true,
+    JSX: true,
+  },
+  env: {
+    node: true,
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {
+        project,
+      },
+    },
+  },
+  ignorePatterns: ['.*.js', 'node_modules/', 'dist/'],
+  overrides: [
+    {
+      files: ['*.js?(x)', '*.ts?(x)'],
+    },
+  ],
+};

package/nest.js

@@ -0,0 +1,25 @@
+const { resolve } = require('node:path');
+
+const project = resolve(process.cwd(), 'tsconfig.json');
+
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  extends: ['./base.js'],
+  rules: {
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-extraneous-class': 'warn',
+  },
+  overrides: [
+    {
+      files: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'],
+      extends: [require.resolve('@vercel/style-guide/eslint/jest')],
+      rules: {
+        'jest/prefer-lowercase-title': 'off',
+      },
+    },
+  ],
+  env: {
+    node: true,
+    jest: true,
+  },
+};

package/next.js

@@ -0,0 +1,44 @@
+const { resolve } = require('node:path');
+
+const project = resolve(process.cwd(), 'tsconfig.json');
+
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  extends: ['./base.js', require.resolve('@vercel/style-guide/eslint/next')],
+  globals: {
+    React: true,
+    JSX: true,
+  },
+  env: {
+    node: true,
+    browser: true,
+  },
+  plugins: ['only-warn'],
+  settings: {
+    'import/resolver': {
+      typescript: {
+        project,
+      },
+    },
+  },
+  overrides: [
+    {
+      files: ['*.js?(x)', '*.ts?(x)'],
+      rules: {
+        '@typescript-eslint/restrict-template-expressions': [
+          'error',
+          {
+            allowAny: false,
+            allowNullish: false,
+            allowNever: false,
+            allowBoolean: true,
+            allowNumber: true,
+            allowRegExp: true,
+          },
+        ],
+        'unicorn/prefer-node-protocol': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+      },
+    },
+  ],
+};

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@ixo/eslint-config",
+  "version": "1.0.0",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "base.js",
+    "library.js",
+    "nest.js",
+    "next.js",
+    "prettier-base.js",
+    "react-internal.js"
+  ],
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "6.17.0",
+    "@typescript-eslint/parser": "6.17.0",
+    "@vercel/style-guide": "^5.2.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-turbo": "^2.0.0",
+    "eslint-plugin-only-warn": "^1.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "typescript": "^5.3.4"
+  }
+}

package/prettier-base.js

@@ -0,0 +1,8 @@
+/** @type {import("prettier").Config} */
+module.exports = {
+  singleQuote: true,
+  endOfLine: 'lf',
+  tabWidth: 2,
+  printWidth: 80,
+  useTabs: false,
+};

package/react-internal.js

@@ -0,0 +1,34 @@
+const { resolve } = require('node:path');
+
+const project = resolve(process.cwd(), 'tsconfig.json');
+
+/**
+ * This is a custom ESLint configuration for use with
+ * internal (bundled by their consumer) libraries
+ * that utilize React.
+ *
+ * This config extends the Vercel Engineering Style Guide.
+ * For more information, see https://github.com/vercel/style-guide
+ *
+ * @type {import("eslint").Linter.Config}
+ */
+module.exports = {
+  extends: ['./base.js'],
+  plugins: ['only-warn'],
+  globals: {
+    React: true,
+    JSX: true,
+  },
+  env: {
+    browser: true,
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {
+        project,
+      },
+    },
+  },
+  ignorePatterns: ['.*.js', 'node_modules/', 'dist/'],
+  overrides: [{ files: ['*.js?(x)', '*.ts?(x)'] }],
+};