@open-xchange/linter-presets 1.2.34 → 1.2.35

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## `1.2.35` – 2025-May-29
+
+- chore: bump dependencies
+
 ## `1.2.34` – 2025-May-26
 
 - added: (ESLint) disable rule "no-unused-private-class-members" in declaration files

package/docs/eslint/README.md

@@ -0,0 +1,103 @@
+# ESLint Presets
+
+The module `eslint` provides a `configure` function for project-wide ESLint configuration (e.g. TypeScript files, JSON files, license headers, etc.), and a set of environment presets that apply more ESLint plugins and rules to a specific subset of the project (e.g. browser code, unit test code, etc.).
+
+## Functions
+
+### Function `configure`
+
+Generates standard configuration targeting the source files in the entire project. Internally, various ESLint plugins will be included and configured to use their recommended rule sets.
+
+| Target | ESLint Plugin |
+| - | - |
+| JavaScript and TypeScript files (including `.jsx` and `.tsx`) | ESLint core rules |
+| JavaScript files only (including `.jsx`) | ESLint core rules |
+| TypeScript files with type-aware rules (including `.tsx`) | [typescript-eslint](https://typescript-eslint.io/) |
+| [Vue.js](https://vuejs.org) files (`.vue`) | [eslint-plugin-vue](https://eslint.vuejs.org) |
+| JSON files (`.json`) | [eslint-plugin-jsonc](https://ota-meshi.github.io/eslint-plugin-jsonc/) |
+| YAML files (`.yaml`, `.yml`) | [eslint-plugin-yml](https://ota-meshi.github.io/eslint-plugin-yml/) |
+| Markdown files (`.md`) | [@eslint/markdown](https://github.com/eslint/markdown) |
+| License headers | [eslint-plugin-license-header](https://github.com/nikku/eslint-plugin-license-header) |
+| ESLint inline directives | [@eslint-community/eslint-plugin-eslint-comments](https://github.com/eslint-community/eslint-plugin-eslint-comments) |
+| Outdated dependencies | [eslint-plugin-depend](https://github.com/es-tooling/eslint-plugin-depend) |
+| Native ES6 promises | [eslint-plugin-promise](https://github.com/eslint-community/eslint-plugin-promise) |
+| JSDoc source documentation | [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) |
+| Source code formatting | [@stylistic/eslint-plugin](https://eslint.style/packages/default) |
+
+#### `configure` Signature
+
+```ts
+function configure(options?: ConfigureOptions): Linter.Config[]
+```
+
+#### `configure` Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `ignores` | `string[]` | `[]` | Glob patterns with all files and folders to be ignored by ESLint. This package already defines a few standard ignore globs (see below). |
+| `license` | `string` | `""` | Full path to the template file containing the license header to be used in all source files. |
+| `language` | `LanguageOptions` | | Configuration options for language and project setup. |
+| `language.ecmaVersion` | `number\|"latest"` | `latest` | The ECMAScript version to be used in the project (version or year). |
+| `language.sourceType` | `"module"\|"commonjs"` | `"module"` | Specifies how to treat `.js`, `.jsx`, `.ts`, and `.tsx` files. |
+| `packages` | `PackagesOptions` | | Configuration options for external package dependencies. |
+| `packages.allowed` | `string[]` | `[]` | Banned packages to be allowed in the project. |
+| `packages.banned` | `string[]` | `[]` | Additional packages to be banned in the project. |
+| `stylistic` | `StylisticOptions` | | Configuration options for code style. |
+| `stylistic.indent` | `IndentOptions` | `{}` | Indentation size (number of space characters) per file type. |
+| `stylistic.indent.js` | `number` | `4` | JavaScript and TypeScript files (including `.jsx`, `.tsx`). |
+| `stylistic.indent.json` | `number` | `4` | JSON files (`.json`). |
+| `stylistic.indent.yaml` | `number` | `2` | YAML files (`.yaml`, `.yml`). |
+| `stylistic.indent.vue` | `number` | `4` | Vue.js files (`.vue`). |
+| `stylistic.semi` | `"always"\|"never"\|"off"` | `"always"` | Specifies whether to require semicolons following all statements (`"always"`), or to force to omit semicolons if possible according to ASI rules (`"never"`). |
+| `stylistic.quotes` | `"single"\|"double"\|"off"` | `"double"` | The type of the string delimiter character. |
+| `stylistic.dangle` | `"always"\|"never"\|"off"` | `"always"` | Specifies how to treat dangling commas in multiline lists. |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the global configuration. |
+
+#### Built-in Ignore Globs
+
+This package defines ignore globs for the following files and directories:
+
+- `*/.yarn/*` (internal setup files of Yarn v2+)
+- `dist/*` (standard build output directory)
+- `vite.config.ts.*.mjs` (intermediate files of Vite dev server)
+- `gitlab-ci/*` (GitLab CI configuration files)
+- `.gitlab-ci.yml` (GitLab CI configuration files)
+
+#### `configure` Example
+
+```js
+// eslint.config.js
+import { utils, eslint } from "@open-xchange/linter-presets"
+
+const resolve = utils.resolver(import.meta.url)
+
+export default [
+  ...eslint.configure({
+    ignores: ["external/**/*.yaml"],
+    language: { ecmaVersion: 2024, sourceType: "commonjs" },
+    license: resolve("./license.txt"),
+    stylistic: { quotes: "single", semi: "never" },
+  }),
+]
+```
+
+## Environment Presets
+
+Environment presets will be applied to specific subsets of the project. Usually, they import one or more external ESLint plugins, apply their recommended rule set, and add or modify a few of their rules to establish the default setup for the project. All environment presets allow to pass rule records to override the recommended rules.
+
+### Overview
+
+The names of the environment presets are linked to detailed descriptions.
+
+| Name | Description |
+| - | - |
+| [`env.node`](./env/node.md) | Modules running in NodeJS. |
+| [`env.browser`](./env/browser.md) | Modules running in browsers. |
+| [`env.react`](./env/react.md) | Modules using [React](https://react.dev/). |
+| [`env.jest`](./env/jest.md) | Unit tests with [Jest](https://jestjs.io/). |
+| [`env.vitest`](./env/vitest.md) | Unit tests with [Vitest](https://vitest.dev/). |
+| [`env.codecept`](./env/codecept.md) | E2E tests with [CodeceptJS](https://codecept.io/). |
+| [`env.eslint`](./env/eslint.md) | Implementation of custom ESLint rules. |
+| [`env.project`](./env/project.md) | Project setup and module imports. |
+| [`env.tsconfig`](./env/tsconfig.md) | TypeScript project setup (per `tsconfig.json` file). Provided in case VSCode fails to use the new project service correctly. |
+| [`env.decorators`](./env/decorators.md) | Support for native decorators in JavaScript source files. |

package/docs/eslint/env/browser.md

@@ -0,0 +1,84 @@
+# Environment `env.browser`
+
+Creates configuration objects with global symbols and linter rules for modules running in the browser. Adds well-known [browser globals](https://github.com/sindresorhus/globals), and forbids [confusing browser globals](https://github.com/facebook/create-react-app/tree/main/packages/confusing-browser-globals).
+
+## Signature
+
+```ts
+function browser(options: EnvBrowserOptions): Linter.Config[]
+```
+
+## Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
+| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
+| `restricted` | `EnvRestrictedOptions` | `{}` | Settings for banned globals, imports, object properties, and syntax constructs (see below). |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
+
+### Option `restricted`
+
+- Type: `EnvRestrictedOptions`
+- Default: `{}`
+
+This option allows to specify banned globals, imports, object properties, and syntax constructs. These restricted items will be set on top of the built-in restricted items of the environment preset, and will be passed to the ESLint core rules [`no-restricted-globals`](https://eslint.org/docs/latest/rules/no-restricted-globals), [`no-restricted-imports`](https://eslint.org/docs/latest/rules/no-restricted-imports), [`no-restricted-properties`](https://eslint.org/docs/latest/rules/no-restricted-properties), and [`no-restricted-syntax`](https://eslint.org/docs/latest/rules/no-restricted-syntax), respectively.
+
+The option `restricted` is an object with the following properties:
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `globals` | `EnvRestrictedName[]` | `[]` | Banned global symbols. Each entry is an object with string properties `name` and `message`. |
+| `imports` | `EnvRestrictedName[]` | `[]` | Banned modules that must not be imported. Each entry is an object with string properties `name` and `message`. |
+| `properties` | `EnvRestrictedProperty[]` | `[]` | Banned object properties. Each entry is an object with string properties `object`, `property`, and `message`). |
+| `syntax` | `EnvRestrictedSyntax[]` | `[]` | Banned syntax constructs by [AST selectors](https://eslint.org/docs/latest/extend/selectors). Each entry is an object with string properties `selector` and `message`. |
+| `overrides` | `EnvRestrictedOverride[]` | `[]` | Overrides for specific subsets of files in the environment. Each entry is an object with the common properties `files` (required) and `ignores`, and the properties `globals`, `imports`, `properties`, and `syntax` to specify restricted items (see above). All restricted items of overrides will be merged with the common restricted items defined for the entire environment. |
+
+The environment `env.browser` already defines the following built-in restrictions:
+
+| Type | Name | Description |
+| - | - | - |
+| Globals | [`isFinite`](https://devdocs.io/javascript/global_objects/isfinite) | Use [`Number.isFinite`](https://devdocs.io/javascript/global_objects/number/isfinite) instead. |
+| | [`isNaN`](https://devdocs.io/javascript/global_objects/isnan) | Use [`Number.isNaN`](https://devdocs.io/javascript/global_objects/number/isnan) instead. |
+| | [Confusing browser globals](https://github.com/facebook/create-react-app/tree/main/packages/confusing-browser-globals) | Globals such as `name` and `event` should not be used to catch typos in function parameters etc. |
+| Syntax | TypeScript `public` class field modifier | Can be omitted (except for constructors of classes deriving from a class with protected constructor). |
+| | TypeScript `private` class field modifier | Use native `#private` class fields. |
+| | [TypeScript parameter properties](https://www.typescriptlang.org/docs/handbook/2/classes.html#parameter-properties) | Use explicit class properties. |
+| | Module exports of [TypeScript const enumerations](https://devdocs.io/typescript~5.1/enums#enums-at-compile-time) | Not compatible with bundlers running in isolated modules mode (ESBuild). |
+
+## Example
+
+```js
+// eslint.config.js
+import { eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.browser({
+    files: ["src/**/*.{js,ts}"],
+    restricted: {
+      globals: [
+        { name: "$", message: "Explicitly import the 'jquery' package." },
+      ],
+      imports: [
+        { name: "underscore", message: "Use the 'lodash' package." },
+      ],
+      properties: [
+        { object: "_", property: "flatten", message: "Use native 'Array::flat' instead." },
+      ],
+      syntax: [
+        { selector: "ClassBody > StaticBlock", message: "Static blocks not supported in all browsers." },
+      ],
+      overrides: [
+        {
+          files: "src/**/*.ts",
+          properties: [
+            { object: "$", property: "Deferred", message: "Use native promises in TypeScript code." },
+          ],
+        },
+      ],
+    },
+    rules: { /* ... */ },
+  }),
+]
+```

package/docs/eslint/env/codecept.md

@@ -0,0 +1,35 @@
+# Environment `env.codecept`
+
+Creates configuration objects with global symbols and linter rules for E2E tests using CodeceptJS. Adds the following plugins and their recommended rules:
+
+- [eslint-plugin-codeceptjs](https://github.com/poenneby/eslint-plugin-codeceptjs)
+- [eslint-plugin-chai-expect](https://github.com/turbo87/eslint-plugin-chai-expect)
+
+## Signature
+
+```ts
+function codecept(options: EnvCodeceptOptions): Linter.Config[]
+```
+
+## Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
+| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
+
+## Example
+
+```js
+// eslint.config.js
+import { eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.codecept({
+    files: ["e2e/**/*.{js,ts}"],
+    rules: { /* ... */ },
+  }),
+]
+```

package/docs/eslint/env/decorators.md

@@ -0,0 +1,37 @@
+# Environment `env.decorators`
+
+Creates configuration objects to add support for native decorators to JavaScript source files.
+Does not affect TypeScript source files which use an own parser aware of the decorator syntax.
+
+Adds the following plugins:
+
+- [@babel/eslint-parser](https://www.npmjs.com/package/@babel/eslint-parser)
+- [@babel/plugin-proposal-decorators](https://babeljs.io/docs/babel-plugin-proposal-decorators)
+
+## Signature
+
+```ts
+function decorators(options: EnvDecoratorsOptions): Linter.Config[]
+```
+
+## Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
+| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
+
+## Example
+
+```js
+// eslint.config.js
+import { eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.decorators({
+    files: ["src/**/*.js"],
+  }),
+]
+```

package/docs/eslint/env/eslint.md

@@ -0,0 +1,32 @@
+# Environment `env.eslint`
+
+Creates configuration objects with linter rules for implementing custom ESlint plugins. Adds the plugin [eslint-plugin-eslint-plugin](https://github.com/eslint-community/eslint-plugin-eslint-plugin) and its recommended rules.
+
+## Signature
+
+```ts
+function plugin(options: EnvEslintOptions): Linter.Config[]
+```
+
+## Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
+| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
+
+## Example
+
+```js
+// eslint.config.js
+import { eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.eslint({
+    files: ["eslint/rules/*.{js,ts}"],
+    rules: { /* ... */ },
+  }),
+]
+```

package/docs/eslint/env/jest.md

@@ -0,0 +1,41 @@
+# Environment `env.jest`
+
+Creates configuration objects with global symbols and linter rules for unit tests using Jest. Adds the following plugins and their recommended rules:
+
+- [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest)
+- [eslint-plugin-jest-extended](https://github.com/jest-community/eslint-plugin-jest-extended) (optional)
+- [eslint-plugin-jest-dom](https://github.com/testing-library/eslint-plugin-jest-dom) (optional)
+- [eslint-plugin-testing-library](https://github.com/testing-library/eslint-plugin-testing-library) (optional)
+
+## Signature
+
+```ts
+function jest(options: EnvJestOptions): Linter.Config[]
+```
+
+## Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
+| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
+| `jestExtended` | `boolean` | `false` | Activate plugin `eslint-plugin-jest-extended`. |
+| `jestDom` | `boolean` | `false` | Activate plugin `eslint-plugin-jest-dom`. |
+| `testingLib` | `"angular"\|"dom"\|"marko"\|"react"\|"vue"` | _none_ | Activate plugin `eslint-plugin-testing-library` for the specified environment. |
+
+## Example
+
+```js
+// eslint.config.js
+import { eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.jest({
+    files: ["test/**/*.{js,ts}"],
+    testingLib: "react",
+    rules: { /* ... */ },
+  }),
+]
+```

package/docs/eslint/env/node.md

@@ -0,0 +1,51 @@
+# Environment `env.node`
+
+Creates configuration objects with global symbols and linter rules for NodeJS modules. Adds the plugin [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n) and its recommended rules.
+
+## Signature
+
+```ts
+function node(options: EnvNodeOptions): Linter.Config[]
+```
+
+## Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
+| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
+| `sourceType` | `"module"\|"commonjs"` | `"module"` | Specifies how to treat `.js`, `.jsx`, `.ts`, and `.tsx`. |
+| `restricted` | `EnvRestrictedOptions` | `{}` | Settings for banned globals, imports, object properties, and syntax constructs (see below). |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
+
+### Option `restricted`
+
+- Type: `EnvRestrictedOptions`
+- Default: `{}`
+
+This option allows to specify banned globals, imports, object properties, and syntax constructs. See [documentation in `env.browser`](./browser.md#option-restricted) for a detailed description.
+
+The environment `env.node` already defines the following built-in restrictions:
+
+| Type | Name | Description |
+| - | - | - |
+| Globals | [`isFinite`](https://devdocs.io/javascript/global_objects/isfinite) | Use [`Number.isFinite`](https://devdocs.io/javascript/global_objects/number/isfinite) instead. |
+| | [`isNaN`](https://devdocs.io/javascript/global_objects/isnan) | Use [`Number.isNaN`](https://devdocs.io/javascript/global_objects/number/isnan) instead. |
+| Syntax | TypeScript `public` class field modifier | Can be omitted (except for constructors of classes deriving from a class with protected constructor). |
+| | TypeScript `private` class field modifier | Use native `#private` class fields. |
+| | [TypeScript parameter properties](https://www.typescriptlang.org/docs/handbook/2/classes.html#parameter-properties) | Use explicit class properties. |
+
+## Example
+
+```js
+// eslint.config.js
+import { utils, eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.node({
+    files: ["*.config.{js,ts}", "scripts/**/*.js"],
+    rules: { /* ... */ },
+  }),
+]
+```

package/docs/eslint/env/project.md

@@ -0,0 +1,129 @@
+# Environment `env.project`
+
+Creates configuration objects for custom project setup and module imports.
+
+- Source files will be checked for the correct usage of ES modules with static `import` and `export` statements, as well as dynamic `import` expressions. For the latter, only literal strings will be checked, other expressions that build the imported module names dynamically cannot be checked.
+
+- Enforces an hierarchy of internal packages. If a project distributes its source files into multiple installation packages, the dependencies between these packages can be checked to prevent that files from a base package import files from a dependent package (which may not get installed on the target machine).
+
+- Bans the TypeScript compiler directive `<amd-module>`. This directive was used in the past to declare module names when transpiling TypeScript module code to AMD modules.
+
+## Signature
+
+```ts
+function project(options: EnvProjectOptions): Linter.Config[]
+```
+
+## Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
+| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
+| `alias` | `Record<string, string>` | `{}` | Maps all alias prefixes to actual paths in the project (see below). |
+| `external` | `string \| string[]` | `[]` | Specifies glob patterns for external modules (see below). |
+| `hierarchy` | `Record<string, RuleNoInvalidHierarchyPackage>` | `{}` | Allows to separate the source files into virtual packages (see below). |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
+
+### Option `alias`
+
+- Type: `Record<string, string>`
+- Default: `{}`
+
+Maps all alias prefixes to actual paths in the project. All paths must be relative to the project's root directory.
+
+#### `alias` Example
+
+```js
+// eslint.config.js
+import { eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.project({
+    files: ["src/**/*.{js,ts}"],
+    alias: {
+      "@": "src",
+    },
+  }),
+]
+```
+
+- The alias prefix `"@/"` of a module name will be replaced with the path `src/` to check the existence of source files.
+- The module `"@/my/module"` will correspond to the file `src/my/module.js` (relative to the project's root directory).
+
+### Option `external`
+
+- Type: `string[]`
+- Default: `[]`
+
+Specifies glob patterns for modules that can be imported although there is no module file available, e.g. due to build tool configuration.
+
+#### `external` Example
+
+```js
+// eslint.config.js
+import { eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.project({
+    files: ["src/**/*.{js,ts}"],
+    alias: { "@": "src" },
+    external: ["virtual:*", "@/special/lib/**/*.js"],
+  }),
+]
+```
+
+- All imports starting with `"virtual:"` will not be checked.
+- All imports of `.js` files deeply inside `src/special/lib/` will not be checked.
+
+### Option `hierarchy`
+
+- Type: `Record<string, RuleNoInvalidHierarchyPackage>`
+- Default: `{}`
+
+Allows to separate the source files into several virtual packages. This option is completely independent from any actual packaging performed in later steps of the build process. Its solely purpose is to impose dependencies between the source files to prevent importing files between specific packages.
+
+Each key in the `hierarchy` record is the arbitrary unique name of a package. The record values must be objects satisfying the interface `RuleNoInvalidHierarchyPackage`:
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns selecting all source files that are part of the package. |
+| `extends` | `string\|string[]` | `[]` | Specifies the names of all packages (dictionary keys of the option `hierarchy`) this package depends on. |
+| `optional` | `boolean` | `false` | Set to `true` to mark an optional package that may be missing in an installation. Such a package cannot be imported statically (with `import` statement) from a non-optional package, but can only be loaded dynamically at runtime (by calling `import()`). The rule will mark all static imports of optional code as an error. |
+
+Modules that are part of such a package may import any modules from the same package, or from packages it depends on (also recursively from their dependent packages).
+
+Example configuration:
+
+```js
+// eslint.config.js
+import { eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.project({
+    files: ["src/**/*.{js,ts}"],
+    alias: { "@": "src" },
+    hierarchy: {
+      base: {
+        files: ["@/base/**/*", "@/tools/**/*"],
+      },
+      debug: {
+        files: ["@/debug/**/*"],
+        extends: "base",
+        optional: true,
+      },
+      special: {
+        files: ["@/my/special/**/*"],
+        extends: ["base", "debug"],
+      },
+    },
+  }),
+]
+```
+
+- The package `base` contains all modules starting with `@/base/` or `@/tools/`. All modules in the package `base` can import themselves, but they cannot import any other modules from the project.
+- The _optional_ package `debug` contains all modules starting with `@/debug/`. Modules in this package can import other modules from this package, and from the package `base`. Modules in this package can only be imported dynamically from other packages.
+- The package `special` contains all modules starting with `@/my/special/`. Modules in this package can import other modules from this package, and all modules from the packages `base` and `debug`. The latter package can only be imported dynamically.

package/docs/eslint/env/react.md

@@ -0,0 +1,38 @@
+# Environment `env.react`
+
+Creates configuration objects with linter rules for ReactJS. Adds the following plugins and their recommended rules:
+
+- [@eslint-react/eslint-plugin](https://eslint-react.xyz/)
+- [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
+- [eslint-plugin-react-hooks-static-deps](https://github.com/stoikio/eslint-plugin-react-hooks-static-deps)
+- [eslint-plugin-react-refresh](https://github.com/ArnaudBarre/eslint-plugin-react-refresh)
+- [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
+
+## Signature
+
+```ts
+function react(options: EnvReactOptions): Linter.Config[]
+```
+
+## Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
+| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
+
+## Example
+
+```js
+// eslint.config.js
+import { eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.react({
+    files: ["src/**/*.{js,ts}"],
+    rules: { /* ... */ },
+  }),
+]
+```

package/docs/eslint/env/tsconfig.md

@@ -0,0 +1,36 @@
+# Environment `env.tsconfig`
+
+Creates configuration objects for TypeScript projects (registers a `tsconfig.json` file in the project).
+
+Usually, this environment preset should not be necessary, as the new [project service](https://typescript-eslint.io/blog/announcing-typescript-eslint-v8#project-service) of `typescript-eslint` is enabled by default. However, the ESLint plugin of VSCode sometimes fails to lint files in certain subdirectories and complains about the project service not covering the file to be linted. In these cases, manually setting up this environment preset will help.
+
+## Signature
+
+```ts
+function tsconfig(options: EnvTSConfigOptions): Linter.Config[]
+```
+
+## Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
+| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
+| `project` | `string` | _required_ | The absolute path to the TypeScript project configuration file (`tsconfig.json`). |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
+
+## Example
+
+```js
+// eslint.config.js
+import { utils, eslint } from "@open-xchange/linter-presets"
+
+const resolve = utils.resolver(import.meta.url)
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.tsconfig({
+    files: ["src/**/*.ts"],
+    project: resolve("src/tsconfig.json"),
+  }),
+]

package/docs/eslint/env/vitest.md

@@ -0,0 +1,41 @@
+# Environment `env.vitest`
+
+Creates configuration objects with global symbols and linter rules for unit tests using Vitest. Adds the following plugins and their recommended rules:
+
+- [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest)
+- [eslint-plugin-jest-extended](https://github.com/jest-community/eslint-plugin-jest-extended) (optional)
+- [eslint-plugin-jest-dom](https://github.com/testing-library/eslint-plugin-jest-dom) (optional)
+- [eslint-plugin-testing-library](https://github.com/testing-library/eslint-plugin-testing-library) (optional)
+
+## Signature
+
+```ts
+function vitest(options: EnvVitestOptions): Linter.Config[]
+```
+
+## Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
+| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
+| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
+| `jestExtended` | `boolean` | `false` | Activate plugin `eslint-plugin-jest-extended`. |
+| `jestDom` | `boolean` | `false` | Activate plugin `eslint-plugin-jest-dom`. |
+| `testingLib` | `"angular"\|"dom"\|"marko"\|"react"\|"vue"` | _none_ | Add plugin `eslint-plugin-testing-library` for the specified environment. |
+
+## Example
+
+```js
+// eslint.config.js
+import { eslint } from "@open-xchange/linter-presets"
+
+export default [
+  ...eslint.configure({ /* ... */ }),
+  ...eslint.env.vitest({
+    files: ["test/**/*.{js,ts}"],
+    testingLib: "react",
+    rules: { /* ... */ },
+  }),
+]
+```

package/docs/stylelint/README.md

@@ -0,0 +1,52 @@
+# StyleLint Presets
+
+The module `stylelint` provides a `configure` function for project-wide StyleLint configuration.
+
+## Functions
+
+### Function `configure`
+
+Generates standard configuration targeting the source files in the entire project. Internally, various StyleLint plugins will be included and configured to use their recommended rule sets.
+
+| Target | StyleLint Plugin |
+| - | - |
+| Stylesheet files (`.css`, `.less`, `.scss`) | StyleLint core rules |
+| Less files only | [stylelint-config-standard-less](https://github.com/stylelint-less/stylelint-config-standard-less) |
+| Sass files only | [stylelint-config-standard-scss](https://github.com/stylelint-scss/stylelint-config-standard-scss) |
+| Source code formatting | [@stylistic/stylelint-plugin](https://github.com/stylelint-stylistic/stylelint-stylistic) |
+
+#### `configure` Signature
+
+`function configure(options?: ConfigureOptions): Linter.Config[]`
+
+#### `configure` Options
+
+| Name | Type | Default | Description |
+| - | - | - | - |
+| `ignores` | `string[]` | `[]` | Glob patterns with all files and folders to be ignored by StyleLint. |
+| `license` | `string` | `""` | Full path to the template file containing the license header to be used in all source files. |
+| `stylistic` | `StylisticOptions` | | Configuration options for code style. |
+| `stylistic.indent` | `number` | `4` | Default indentation size (number of space characters). |
+| `stylistic.quotes` | `"single"\|"double"\|"off"` | `"double"` | The type of the string delimiter character. |
+| `rules` | `StyleLint.Config["rules"]` | `{}` | Additional linter rules to be added to the global configuration. |
+
+#### Built-in Ignore Globs
+
+This package defines ignore globs for the following files and directories:
+
+- `dist/*` (standard build output directory)
+
+#### `configure` Example
+
+```js
+// stylelint.config.js
+import { utils, stylelint } from "@open-xchange/linter-presets"
+
+const resolve = utils.resolver(import.meta.url)
+
+export default stylelint.configure({
+  ignores: ["external/**/*.scss"],
+  license: resolve("./license.txt"),
+  stylistic: { indent: 2, quotes: "single" },
+})
+```

package/docs/utils/README.md

@@ -0,0 +1,30 @@
+# Utility Functions
+
+The `utils` module provides utility functions for usage in either ESLint or StyleLint configuration files.
+
+## Functions
+
+### Function `resolver`
+
+Creates and returns a function that will convert relative file paths to absolute file paths. Intended to be used with the base URL of the calling script, usually `import.meta.url`.
+
+#### `resolver` Signature
+
+`function resolver(url: string): (file: string) => string`
+
+#### `resolver` Example
+
+```js
+// eslint.config.js
+import { utils, eslint } from "@open-xchange/linter-presets"
+
+const resolve = utils.resolver(import.meta.url)
+
+export default [
+  ...eslint.configure({
+    // ...
+    license: resolve("./license.txt"),
+    // ...
+  }),
+]
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/linter-presets",
-  "version": "1.2.34",
+  "version": "1.2.35",
   "description": "Configuration presets for ESLint and StyleLint",
   "repository": {
     "type": "git",
@@ -27,26 +27,26 @@
     "test": "cd test && eslint . && stylelint \"**/*.{css,scss}\""
   },
   "dependencies": {
-    "@babel/core": "^7.27.1",
+    "@babel/core": "^7.27.3",
     "@babel/eslint-parser": "^7.27.1",
     "@babel/plugin-proposal-decorators": "^7.27.1",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.5.0",
-    "@eslint-react/eslint-plugin": "^1.49.0",
+    "@eslint-react/eslint-plugin": "^1.50.0",
     "@eslint/compat": "^1.2.9",
     "@eslint/js": "^9.27.0",
     "@eslint/markdown": "^6.4.0",
-    "@stylistic/eslint-plugin": "^4.2.0",
-    "@stylistic/eslint-plugin-migrate": "^4.2.0",
+    "@stylistic/eslint-plugin": "^4.4.0",
+    "@stylistic/eslint-plugin-migrate": "^4.4.0",
     "@stylistic/stylelint-config": "^2.0.0",
     "@stylistic/stylelint-plugin": "^3.1.2",
     "@types/picomatch": "^4.0.0",
-    "@vitest/eslint-plugin": "^1.2.0",
+    "@vitest/eslint-plugin": "^1.2.1",
     "confusing-browser-globals": "^1.0.11",
     "eslint-plugin-chai-expect": "^3.1.0",
     "eslint-plugin-codeceptjs": "^1.3.0",
     "eslint-plugin-depend": "^1.2.0",
     "eslint-plugin-eslint-plugin": "^6.4.0",
-    "eslint-plugin-jest": "^28.11.0",
+    "eslint-plugin-jest": "^28.11.1",
     "eslint-plugin-jest-dom": "^5.5.0",
     "eslint-plugin-jest-extended": "^3.0.0",
     "eslint-plugin-jsdoc": "^50.6.17",
@@ -58,11 +58,11 @@
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-hooks-static-deps": "^1.0.7",
     "eslint-plugin-react-refresh": "^0.4.20",
-    "eslint-plugin-testing-library": "^7.2.1",
+    "eslint-plugin-testing-library": "^7.2.2",
     "eslint-plugin-vue": "^10.1.0",
     "eslint-plugin-yml": "^1.18.0",
     "find-up": "^7.0.0",
-    "globals": "^16.1.0",
+    "globals": "^16.2.0",
     "picomatch": "^4.0.2",
     "postcss-html": "^1.8.0",
     "stylelint-config-standard": "^38.0.0",
@@ -70,14 +70,14 @@
     "stylelint-config-standard-scss": "^15.0.1",
     "stylelint-config-standard-vue": "^1.0.0",
     "stylelint-plugin-license-header": "^1.0.3",
-    "typescript-eslint": "^8.32.1",
+    "typescript-eslint": "^8.33.0",
     "vue-eslint-parser": "^10.1.3"
   },
   "devDependencies": {
     "@types/confusing-browser-globals": "^1.0.3",
     "@types/eslint-scope": "^8.3.0",
-    "@types/react": "^19.1.5",
-    "@typescript-eslint/utils": "^8.32.1",
+    "@types/react": "^19.1.6",
+    "@typescript-eslint/utils": "^8.33.0",
     "eslint": "^9.27.0",
     "jest": "^29.7.0",
     "jiti": "^2.4.2",