@open-xchange/linter-presets 0.0.1

package/lib/eslint/index.js

@@ -0,0 +1,106 @@
+
+import base from "./config/base.js";
+import js from "./config/js.js";
+import ts from "./config/ts.js";
+import json from "./config/json.js";
+import yaml from "./config/yaml.js";
+import license from "./config/license.js";
+import directives from "./config/directives.js";
+import promises from "./config/promises.js";
+import jsdoc from "./config/jsdoc.js";
+import stylistic from "./config/stylistic.js";
+
+import tsconfig from "./env/tsconfig.js";
+import node from "./env/node.js";
+import browser from "./env/browser.js";
+import jest from "./env/jest.js";
+import vitest from "./env/vitest.js";
+import codecept from "./env/codecept.js";
+import react from "./env/react.js";
+import plugin from "./env/plugin.js";
+
+// environment presets ========================================================
+
+/**
+ * A collection with all available environment presets.
+ */
+export const env = {
+    tsconfig,
+    node,
+    browser,
+    jest,
+    vitest,
+    codecept,
+    react,
+    plugin,
+};
+
+// functions ==================================================================
+
+/**
+ * Generates standard configuration objects targeting the source files in the
+ * entire project.
+ *
+ * @param {import("./shared/types.js").ESLintPresetsOptions} [options]
+ *  Plugin configuration options.
+ *
+ * @returns {import("./shared/types.js").FlatConfigArray}
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export function configure(options) {
+
+    // resolve language configuration options
+    const languageConfig = {
+        ecmaVersion: 2022,
+        sourceType: "module",
+        ...options?.language,
+    };
+
+    // resolve stylistic configuration options
+    const stylisticConfig = {
+        indent: 2,
+        semi: false,
+        quotes: "single",
+        dangle: "always",
+        ...options?.stylistic,
+    };
+
+    return [
+
+        // ignore certain files and folders
+        ...(options?.ignores?.length ? [{ ignores: options.ignores }] : []),
+
+        // module types and standard rules for all JS/TS source files
+        ...base(languageConfig),
+
+        // default configuration for JavaScript files
+        ...js(),
+
+        // default configuration for TypeScript files
+        ...ts(),
+
+        // default configuration for JSON files
+        ...json(stylisticConfig),
+
+        // default configuration for YAML files
+        ...yaml(stylisticConfig),
+
+        // check for correct license headers
+        ...(options?.license ? license(options.license) : []),
+
+        // default configuration for ESLint inline directives
+        ...directives(),
+
+        // default configuration for native promises
+        ...promises(),
+
+        // default configuration for JSDoc
+        ...jsdoc(),
+
+        // default configuration for code style checks
+        ...stylistic(stylisticConfig),
+
+        // custom rules
+        ...(options?.rules ? [{ rules: options.rules }] : []),
+    ];
+}

package/lib/eslint/shared/constants.js

@@ -0,0 +1,33 @@
+
+// constants ==================================================================
+
+/**
+ * Shared options for the core rule `no-unused-vars`, and the plugin rule
+ * `@typescript-eslint/no-unused-vars`.
+ */
+export const NO_UNUSED_VARS_OPTIONS = {
+    varsIgnorePattern: "^_",
+    argsIgnorePattern: "^_",
+    destructuredArrayIgnorePattern: "^_",
+    caughtErrors: "all",
+    ignoreRestSiblings: true,
+};
+
+/**
+ * Global symbols to be banned in all source code files, to be used in the core
+ * rule "no-restricted-globals".
+ */
+export const RESTRICTED_GLOBALS = [
+    { name: "isFinite", message: "Use 'Number.isFinite' instead." },
+    { name: "isNaN", message: "Use 'Number.isNaN' instead." },
+];
+
+/**
+ * Syntax constructs to be banned in all source code files, to be used in the
+ * core rule "no-restricted-syntax".
+ */
+export const RESTRICTED_SYNTAX = [
+    { selector: ":matches(PropertyDefinition, MethodDefinition[kind!='constructor'])[accessibility='public']", message: "Remove 'public' keyword." },
+    { selector: ":matches(PropertyDefinition, MethodDefinition[kind!='constructor'])[accessibility='private']", message: "Use #private syntax instead." },
+    { selector: "MethodDefinition[kind='constructor'] TSParameterProperty[accessibility]", message: "Use explicit class properties." },
+];

package/lib/eslint/shared/types.d.ts

@@ -0,0 +1,90 @@
+
+import { Linter } from "eslint";
+
+// types ======================================================================
+
+/**
+ * An array of ESLint configuration entries in flat-config format.
+ */
+export type FlatConfigArray = Linter.FlatConfig[];
+
+/**
+ * Configuration options for language and project setup.
+ */
+export interface LanguageOptions {
+
+    /**
+     * The ECMAScript version to be used in the project (version or year).
+     * Default value is `2022`.
+     */
+    ecmaVersion?: number;
+
+    /**
+     * Specifies how to treat `.js`, `.jsx`, `.ts`, and `.tsx` files.
+     *
+     * - "module": The files will be considered being ES modules.
+     * - "commonjs": The files will be considered being CommonJS modules.
+     *
+     * Default value is "module".
+     */
+    sourceType?: "module" | "commonjs";
+}
+
+/**
+ * Configuration options for code style.
+ */
+export interface StylisticOptions {
+
+    /**
+     * Default indentation size (number of space characters). Will be applied
+     * to JavaScript, TypeScript, JSON, and YAML files, as well as JSX markup.
+     * Default value is `2`.
+     */
+    indent?: number;
+
+    /**
+     * Specifies whether to require semicolons following all statements. By
+     * default, semicolons must be omitted if possible according to ASI rules.
+     */
+    semi?: boolean;
+
+    /**
+     * The type of the string delimiter character. Default value is "single".
+     */
+    quotes?: "single" | "double" | "off";
+
+    /**
+     * Specifies how to treat dangling commas in multiline lists.
+     *
+     * - "always": Dangling commas will be required in all multi-line array
+     *   literals, object literals, function parameters, template parameters,
+     *   imports, and exports.
+     * - "never": Dangling commas will be forbidden.
+     * - "off": Dangling commas will not be checked.
+     *
+     * Default value is "always".
+     */
+    dangle?: "always" | "never" | "off";
+}
+
+/**
+ * Shared options for an environment preset: include and exclude files, and add
+ * more linter rules.
+ */
+export interface EnvBaseOptions {
+
+    /**
+     * Glob patterns for source files to be included into the environment.
+     */
+    files: readonly string[];
+
+    /**
+     * Glob patterns for source files matching `files` to be ignored.
+     */
+    ignores?: readonly string[];
+
+    /**
+     * Additional linter rules to be added to the configuration.
+     */
+    rules?: Linter.RulesRecord;
+}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+
+export * as utils from "./utils/index";
+export * as eslint from "./eslint/index";

package/lib/index.js

@@ -0,0 +1,3 @@
+
+export * as utils from "./utils/index.js";
+export * as eslint from "./eslint/index.js";

package/lib/utils/index.d.ts

@@ -0,0 +1,4 @@
+
+// functions ==================================================================
+
+export function resolver(url: string): (file: string) => string;

package/lib/utils/index.js

@@ -0,0 +1,18 @@
+
+import { URL, fileURLToPath } from "node:url";
+
+// functions ==================================================================
+
+/**
+ * Creates and returns a resolver function for file paths relative to the given
+ * base URL of a script file.
+ *
+ * @param {string} url
+ *  The base URL of the calling script, usually `import.meta.url`.
+ *
+ * @returns {(file: string) => string}
+ *  A function that converts relative file paths to absolute file paths.
+ */
+export function resolver(url) {
+    return file => fileURLToPath(new URL(file, url));
+}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@open-xchange/linter-presets",
+  "version": "0.0.1",
+  "description": "Configuration presets for ESLint and StyleLint",
+  "repository": "https://gitlab.open-xchange.com/fspd/npm-packages/linter-presets",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "packageManager": "yarn@4.3.1",
+  "type": "module",
+  "exports": "./lib/index.js",
+  "scripts": {
+    "prepare": "husky",
+    "lint": "eslint ."
+  },
+  "lint-staged": {
+    "*.{js,ts,json}": "yarn lint"
+  },
+  "dependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "4.3.0",
+    "@eslint/compat": "1.1.0",
+    "@eslint/js": "9.6.0",
+    "@stylistic/eslint-plugin": "2.3.0",
+    "@stylistic/eslint-plugin-migrate": "2.3.0",
+    "confusing-browser-globals": "1.0.11",
+    "eslint-plugin-chai-expect": "3.1.0",
+    "eslint-plugin-codeceptjs": "1.3.0",
+    "eslint-plugin-eslint-plugin": "6.2.0",
+    "eslint-plugin-jest": "28.6.0",
+    "eslint-plugin-jest-dom": "5.4.0",
+    "eslint-plugin-jsdoc": "48.5.0",
+    "eslint-plugin-jsonc": "2.16.0",
+    "eslint-plugin-jsx-a11y": "6.9.0",
+    "eslint-plugin-jsx-expressions": "1.3.2",
+    "eslint-plugin-license-header": "0.6.1",
+    "eslint-plugin-n": "17.9.0",
+    "eslint-plugin-promise": "6.4.0",
+    "eslint-plugin-react": "7.34.3",
+    "eslint-plugin-react-hooks": "4.6.2",
+    "eslint-plugin-react-hooks-static-deps": "1.0.7",
+    "eslint-plugin-react-refresh": "0.4.7",
+    "eslint-plugin-testing-library": "6.2.2",
+    "eslint-plugin-vitest": "0.5.4",
+    "eslint-plugin-yml": "1.14.0",
+    "globals": "15.8.0",
+    "typescript-eslint": "7.15.0"
+  },
+  "devDependencies": {
+    "eslint": "9.6.0",
+    "husky": "9.0.11",
+    "typescript": "5.5.3"
+  },
+  "peerDependencies": {
+    "eslint": "^9.6.0",
+    "typescript": "^5.5.3"
+  },
+  "resolutions": {
+    "semver": "^7.6.2"
+  }
+}