eslint-config-vylda-typescript 5.0.0

package/index.d.ts

@@ -0,0 +1,55 @@
+import type { ESLint, Linter } from 'eslint';
+
+export type TConfig = Array<Linter.Config>;
+export type TGetConfigOptions = TGetImportConfigOptions & {
+  barrelsFiles?: Array<string>;
+  files?: Array<string>;
+  plugins?: Record<string, ESLint.Plugin>;
+};
+export type TGetImportConfigOptions = {
+  barrelsFiles?: Array<string>;
+  files?: Array<string>;
+  importExtensions?: Array<string>;
+  importExtensionsRuleGranularOption?: Record<string, unknown>;
+  importNoExtraneousDependenciesDevDependencies?: Array<string>;
+  importResolverNodeExtensions?: Array<string>;
+  plugins?: Record<string, ESLint.Plugin>;
+};
+
+export function getConfig(options?: TGetConfigOptions): TConfig;
+export function getImportConfig(options?: TGetImportConfigOptions): TConfig;
+export function getLanguageOptions(dir: string): TConfig;
+export function mapFiles(defaults: TConfig, customFiles: Array<string>): TConfig;
+
+export const barrels: TConfig;
+export const barrelsFiles: Array<string>;
+export const bestPractices: TConfig;
+export const constants: Record<string, number>;
+export const customs: TConfig;
+export const defaultImportExtensions: Array<string>;
+export const defaultImportExtensionsRuleGranularOption: Record<string, string>;
+export const defaultImportNoExtraneousDependenciesDevDependencies: Array<string>;
+export const defaultImportResolverNodeExtensions: Array<string>;
+export const defaultTs: TConfig;
+export const errors: TConfig;
+export const es6: TConfig;
+export const files: Array<string>;
+export const ignores: TConfig;
+export const node: TConfig;
+export const off: TConfig;
+export const perfectionist: TConfig;
+export const plugins: Record<string, ESLint.Plugin>;
+export const plus: TConfig;
+export const strict: TConfig;
+export const stylistic: TConfig;
+export const tsConfig: TConfig;
+export const tsFiles: Array<string>;
+export const tsPlugins: Record<string, ESLint.Plugin>;
+export const tsStrict: TConfig;
+export const tsStylistic: TConfig;
+export const vanillaConfigs: TConfig;
+export const tsVariables: TConfig;
+export const vanillaPlugins: Record<string, ESLint.Plugin>;
+export const variables: TConfig;
+
+export default TConfig;

package/index.js

@@ -0,0 +1,176 @@
+// @ts-check
+import { resolve } from 'node:path';
+import {
+  barrels, bestPractices, constants, customs, errors, es6, ignores, mapFiles, node,
+  perfectionist, strict, stylistic, plugins as vanillaPlugins, variables,
+} from 'eslint-config-vylda-vanilla';
+import {
+  barrelsFiles, files, getLanguageOptions, nonTsConfigFiles,
+  nonTsConfigFilesRule, plugins, tsFiles, tsPlugins,
+} from './eslint.config.mjs';
+import {
+  defaultImportExtensions,
+  defaultImportExtensionsRuleGranularOption,
+  defaultImportNoExtraneousDependenciesDevDependencies,
+  defaultImportResolverNodeExtensions,
+} from './rules/imports.mjs';
+import {
+  defaultTs, getImportConfig, off, plus,
+  tsConfig, tsStrict, tsStylistic, tsVariables,
+} from './rules/index.mjs';
+
+const dineddd = defaultImportNoExtraneousDependenciesDevDependencies;
+const diergo = defaultImportExtensionsRuleGranularOption;
+
+const defaultOptions = {
+  files,
+  importExtensions: defaultImportExtensions,
+  importExtensionsRuleGranularOption: diergo,
+  importNoExtraneousDependenciesDevDependencies: dineddd,
+  importResolverNodeExtensions: defaultImportResolverNodeExtensions,
+  plugins,
+  tsFiles,
+};
+
+/**
+ * Create Vanilla ESLint configs
+ * @param {Array.<Object>} importConfigs - Array of import configs
+ * @returns {Array.<Object>} - ESLint Flat config
+ */
+const createVanillaConfigs = (importConfigs) => [
+  ...importConfigs,
+  ...es6,
+  ...strict,
+  ...stylistic,
+  ...bestPractices,
+  ...errors,
+  ...node,
+  ...perfectionist,
+  ...variables,
+  ...customs,
+];
+
+/**
+ *
+ * @param {Array.<Object>} configs
+ * @returns {Array.<Object>}
+ */
+const deleteLanguageOptions = (configs) => {
+  const configsWithoutLanguageOptions = configs.map((config) => {
+    if ('languageOptions' in config) {
+      const { languageOptions, ...rest } = config;
+
+      return rest;
+    }
+
+    return config;
+  });
+
+  return configsWithoutLanguageOptions;
+};
+
+/**
+ * returns eslint config for typescript
+ * @param {string} baseDir - base directory for tsconfig.json
+ * @param {object} [options={}] - options
+ * @param {Array.<string>} [options.barrelsFiles=['**\/*.{js,mjs,mts,ts}']] - file patterns for barrels files
+ * @param {Array.<string>} [options.files=['**\/*.{cjs,cts,js,mjs,mts,ts}']] - file patterns for files to lint
+ * @param {Array.<string>} [options.importExtensions=[".js", ".mjs", ".mts", ".ts"]] - extensions for module settings import/extensions
+ * @param {Object.<string, string>} [options.importExtensionsRuleGranularOption] - granural oprions for import/extensions rule; for default values see Readme.md
+ * @param {Array.<string>} [options.importNoExtraneousDependenciesDevDependencies=['see Readme.md']] - devDependencies for import/no-extraneous-dependencies rule
+ * @param {Array.<string>} [options.importResolverNodeExtensions=['.js', '.json', '.mjs', '.mts', '.ts']] - extensions for module settings import/resolver.node.extensions
+* @param {Object.<string, Object | undefined>} [options.plugins] - default plugins; for default values see Readme.md
+ * @param {Array.<string>} [options.tsFiles=['**\/*.{cts,mts,ts}']] - ts files to lint
+ * @returns {Array.<Object>} - ESLint Flat config
+ */
+const getConfig = (
+  baseDir,
+  options = defaultOptions,
+) => {
+  const {
+    barrelsFiles: customBarrelsFiles = barrelsFiles,
+    files: customFiles = files,
+    importExtensions: ie = defaultImportExtensions,
+    importExtensionsRuleGranularOption: iergo = diergo,
+    importNoExtraneousDependenciesDevDependencies: ineddd = dineddd,
+    importResolverNodeExtensions: irne = defaultImportResolverNodeExtensions,
+    plugins: customPlugins = plugins,
+    tsFiles: customTsFiles = tsFiles,
+  } = options;
+
+  const baseImportConfigs = getImportConfig(
+    resolve(baseDir, 'tsconfig.json'),
+    {
+      importExtensions: ie,
+      importExtensionsRuleGranularOption: iergo,
+      importNoExtraneousDependenciesDevDependencies: ineddd,
+      importResolverNodeExtensions: irne,
+    },
+  );
+
+  const languageOptions = getLanguageOptions(baseDir);
+
+  const importConfigs = deleteLanguageOptions(baseImportConfigs);
+
+  const vanillaConfigs = createVanillaConfigs(importConfigs);
+
+  const configsWithFiles = mapFiles(vanillaConfigs, customFiles);
+  const tsConfigsWithFiles = mapFiles(tsConfig, customTsFiles);
+  const barrelsConfigsWithFiles = mapFiles(barrels, customBarrelsFiles);
+
+  const eslintConfig = [
+    {
+      languageOptions,
+      name: 'typescript-eslint/base',
+      plugins: customPlugins,
+    },
+    ...configsWithFiles,
+    ...tsConfigsWithFiles,
+    ...barrelsConfigsWithFiles,
+    ...ignores,
+  ];
+
+  return eslintConfig;
+};
+
+const vanillaConfigs = createVanillaConfigs([]);
+
+export {
+  barrels,
+  barrelsFiles,
+  bestPractices,
+  constants,
+  customs,
+  defaultImportExtensions,
+  defaultImportExtensionsRuleGranularOption,
+  defaultImportNoExtraneousDependenciesDevDependencies,
+  defaultImportResolverNodeExtensions,
+  defaultTs,
+  errors,
+  es6,
+  files,
+  getImportConfig,
+  getLanguageOptions,
+  ignores,
+  mapFiles,
+  node,
+  nonTsConfigFiles,
+  nonTsConfigFilesRule,
+  off,
+  perfectionist,
+  plugins,
+  plus,
+  strict,
+  stylistic,
+  tsConfig,
+  tsFiles,
+  tsPlugins,
+  tsStrict,
+  tsStylistic,
+  tsVariables,
+  vanillaConfigs,
+  vanillaPlugins,
+  variables,
+};
+
+export default getConfig;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "eslint-config-vylda-typescript",
+  "version": "5.0.0",
+  "description": "Eslint Typescript rules for JS and TS vanilla projects",
+  "main": "index.js",
+  "type": "module",
+  "keywords": [
+    "eslint"
+  ],
+  "scripts": {
+    "inspect": "npx @eslint/config-inspector",
+    "lint": "eslint .",
+    "test": "eslint .",
+    "prepare": "husky"
+  },
+  "author": "Vilem Lipold, vilem.lipold@seznam.cz",
+  "bugs": {
+    "url": "https://gitlab.com/Vylda/eslint-config-vylda-typescript/-/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/Vylda/eslint-config-vylda-typescript.git"
+  },
+  "homepage": "https://gitlab.com/Vylda/eslint-config-vylda-typescript",
+  "license": "MIT",
+  "devDependencies": {
+    "@eslint/config-inspector": "^1.2.0",
+    "@types/espree": "^10.1.0",
+    "@types/node": "^24.3.0",
+    "espree": "^10.4.0",
+    "husky": "^9.1.7",
+    "typescript": "^5.9.2"
+  },
+  "dependencies": {
+    "eslint": "^9.34.0",
+    "eslint-config-vylda-vanilla": "^4.0.5",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "tslib": "^2.8.1",
+    "typescript-eslint": "^8.41.0"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}