@open-xchange/linter-presets 0.0.6 → 0.1.0

package/lib/eslint/env/project.d.ts

@@ -1,21 +0,0 @@
-
-import { FlatConfigArray } from "../shared/types";
-import { EnvBaseOptions } from "../shared/env-utils";
-
-// types ======================================================================
-
-/**
- * Configuration options for the environment preset "env.project".
- */
-export interface EnvProjectOptions extends EnvBaseOptions {
-
-    /**
-     * Maps all alias prefixes to actual paths in the project. All paths must
-     * be relative to the project's root directory.
-     */
-    alias?: Record<string, string>;
-}
-
-// functions ==================================================================
-
-export default function project(options: EnvProjectOptions): FlatConfigArray;

package/lib/eslint/env/react.d.ts

@@ -1,20 +0,0 @@
-
-import { FlatConfigArray } from "../shared/types";
-import { EnvBaseOptions } from "../shared/env-utils";
-
-// types ======================================================================
-
-/**
- * Configuration options for the environment preset "env.react".
- */
-export interface EnvReactOptions extends EnvBaseOptions {
-
-    /**
-     * Configuration for the rule "react-hooks-static-deps/exhaustive-deps".
-     */
-    staticHooks?: Record<string, boolean | readonly boolean[] | Record<string, boolean>>;
-}
-
-// functions ==================================================================
-
-export default function react(options: EnvReactOptions): FlatConfigArray;

package/lib/eslint/env/tsconfig.d.ts

@@ -1,20 +0,0 @@
-
-import { FlatConfigArray } from "../shared/types";
-import { EnvBaseOptions } from "../shared/env-utils";
-
-// types ======================================================================
-
-/**
- * Configuration options for the environment preset "env.tsconfig".
- */
-export interface EnvTSConfigOptions extends EnvBaseOptions {
-
-    /**
-     * The path to the TypeScript project configuration file (`tsconfig.json`).
-     */
-    project: string;
-}
-
-// functions ==================================================================
-
-export default function tsconfig(options: EnvTSConfigOptions): FlatConfigArray;

package/lib/eslint/env/vitest.d.ts

@@ -1,14 +0,0 @@
-
-import { FlatConfigArray } from "../shared/types";
-import { EnvBaseOptions } from "../shared/env-utils";
-
-// types ======================================================================
-
-/**
- * Configuration options for the environment preset "env.vitest".
- */
-export interface EnvVitestOptions extends EnvBaseOptions { }
-
-// functions ==================================================================
-
-export default function vitest(options: EnvVitestOptions): FlatConfigArray;

package/lib/eslint/index.d.ts

@@ -1,43 +0,0 @@
-
-import { FlatConfigArray, ConfigureOptions } from "./shared/types";
-
-import tsconfig from "./env/tsconfig";
-import node from "./env/node";
-import browser from "./env/browser";
-import jest from "./env/jest";
-import vitest from "./env/vitest";
-import codecept from "./env/codecept";
-import react from "./env/react";
-import project from "./env/project";
-import eslint from "./env/eslint";
-
-// environments ===============================================================
-
-/**
- * A collection with all available environment presets.
- */
-export const env: {
-    tsconfig: typeof tsconfig;
-    node: typeof node;
-    browser: typeof browser;
-    jest: typeof jest;
-    vitest: typeof vitest;
-    codecept: typeof codecept;
-    react: typeof react;
-    project: typeof project;
-    eslint: typeof eslint;
-};
-
-// functions ==================================================================
-
-/**
- * Defines standard configuration objects targeting the source files in the
- * entire project.
- *
- * @param options
- *  Plugin configuration options.
- *
- * @returns
- *  An array of configuration objects to be added to the flat configuration.
- */
-export function configure(options?: ConfigureOptions): FlatConfigArray;

package/lib/eslint/shared/env-utils.d.ts

@@ -1,95 +0,0 @@
-
-import { Linter } from "eslint";
-
-import { FlatConfigArray } from "./types";
-
-// types ======================================================================
-
-/**
- * Shared options for an environment preset with included and excluded files.
- */
-export interface EnvFilesOptions {
-
-    /**
-     * 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[];
-}
-
-// ----------------------------------------------------------------------------
-
-/**
- * Shared options for an environment preset: include and exclude files, and add
- * more linter rules.
- */
-export interface EnvBaseOptions extends EnvFilesOptions {
-
-    /**
-     * Additional linter rules to be added to the configuration.
-     */
-    rules?: Linter.RulesRecord;
-}
-
-// ----------------------------------------------------------------------------
-
-/**
- * Configuration for a single banned global or import.
- */
-export interface EnvRestrictedName {
-    name: string;
-    message: string;
-}
-
-/**
- * Configuration for a single banned object property.
- */
-export interface EnvRestrictedProperty {
-    object: string;
-    property: string;
-    message: string;
-}
-
-/**
- * Configuration for a single banned syntax construct.
- */
-export interface EnvRestrictedSyntax {
-    selector: string;
-    message: string;
-}
-
-/**
- * Collection of banned globals, imports, properties, and syntax constructs.
- */
-export interface EnvRestrictedItems {
-    /** The global symbols to be banned. */
-    globals?: readonly EnvRestrictedName[];
-    /** The module imports to be banned. */
-    imports?: readonly EnvRestrictedName[];
-    /** The global object properties to be banned. */
-    properties?: readonly EnvRestrictedProperty[];
-    /** The syntax constructs to be banned. */
-    syntax?: readonly EnvRestrictedSyntax[];
-}
-
-/**
- * Collection of banned globals, imports, properties, and syntax constructs,
- * for a specific subset of the files included in an environment.
- */
-export interface EnvRestrictedOverride extends EnvFilesOptions, EnvRestrictedItems { }
-
-/**
- * Configuration options for restricted imports and globals.
- */
-export interface EnvRestrictedOptions extends EnvRestrictedItems {
-    overrides?: readonly EnvRestrictedOverride[];
-}
-
-export interface EnvRestrictedRulesResult {
-    rules: Linter.RulesRecord;
-    overrides: FlatConfigArray;
-}

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

@@ -1,107 +0,0 @@
-
-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";
-}
-
-// ----------------------------------------------------------------------------
-
-/**
- * Configuration options for linting the entire project with ESLint.
- */
-export interface ConfigureOptions {
-
-    /**
-     * Glob patterns with all files and folders to be ignored by ESLint.
-     */
-    ignores?: readonly string[];
-
-    /**
-     * Full path to the template file containing the license header to be used
-     * in all source files. The function `resolver` helps to to convert a local
-     * path to an absolute path.
-     */
-    license?: string;
-
-    /**
-     * Configuration options for language and project setup.
-     */
-    language?: LanguageOptions;
-
-    /**
-     * Configuration options for code style.
-     */
-    stylistic?: StylisticOptions;
-
-    /**
-     * Additional linter rules to be added to the global configuration.
-     */
-    rules?: Linter.RulesRecord;
-}

package/lib/index.d.ts

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

package/lib/stylelint/index.d.ts

@@ -1,18 +0,0 @@
-
-import { Config } from "stylelint";
-
-import { ConfigureOptions } from "./types";
-
-// functions ==================================================================
-
-/**
- * Defines standard configuration objects targeting the source files in the
- * entire project.
- *
- * @param config
- *  Plugin configuration.
- *
- * @returns
- *  An array of configuration objects to be added to the flat configuration.
- */
-export function configure(config?: ConfigureOptions): Config;

package/lib/stylelint/types.d.ts

@@ -1,44 +0,0 @@
-
-import { Config } from "stylelint";
-
-// types ======================================================================
-
-/**
- * Configuration options for code style.
- */
-export interface StylisticOptions {
-
-    /**
-     * Default indentation size (number of space characters). Default value is
-     * `2`.
-     */
-    indent?: number;
-
-    /**
-     * The type of the string delimiter character. Default value is "single".
-     */
-    quotes?: "single" | "double" | "off";
-}
-
-// ----------------------------------------------------------------------------
-
-/**
- * Configuration options for linting the entire project.
- */
-export interface ConfigureOptions {
-
-    /**
-     * Glob patterns with all files and folders to be ignored by StyleLint.
-     */
-    ignores?: readonly string[];
-
-    /**
-     * Configuration options for code style.
-     */
-    stylistic?: StylisticOptions;
-
-    /**
-     * Additional linter rules to be added to the global configuration.
-     */
-    rules?: Config["rules"];
-}

package/lib/utils/index.d.ts

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