@isentinel/eslint-config 6.0.1 → 6.2.0

package/dist/oxfmt.d.mts

@@ -0,0 +1,132 @@
+import { FormatConfig, JsdocConfig, OxfmtConfig, OxfmtConfig as OxfmtConfig$1 } from "oxfmt";
+import "@stylistic/eslint-plugin";
+import "eslint";
+import { Options } from "prettier";
+import "@typescript-eslint/parser";
+import "eslint-config-flat-gitignore";
+import "type-fest";
+import "eslint-flat-config-utils";
+//#region src/utils.d.ts
+/**
+ * Oxfmt's generated types widen `jsdoc.commentLineStrategy` and
+ * `jsdoc.lineWrappingStyle` to `string`, but its JSON schema (and therefore the
+ * generated `oxfmt/oxfmt` rule type) keep them as literal enums. Re-narrow them
+ * so option objects remain assignable to the rule.
+ */
+type OxfmtOptions = Omit<FormatConfig, "jsdoc"> & {
+  jsdoc?: boolean | (Omit<JsdocConfig, "commentLineStrategy" | "lineWrappingStyle"> & {
+    commentLineStrategy?: "keep" | "multiline" | "singleLine";
+    lineWrappingStyle?: "balance" | "greedy";
+  });
+};
+//#endregion
+//#region src/types.d.ts
+interface OptionsFormatters {
+  /**
+   * Enable formatting support for CSS, Less, Sass, and SCSS.
+   *
+   * @default true
+   */
+  css?: boolean;
+  /**
+   * Enable formatting support for GraphQL.
+   *
+   * @default true
+   */
+  graphql?: boolean;
+  /**
+   * Enable formatting support for HTML.
+   *
+   * @default true
+   */
+  html?: boolean;
+  /**
+   * Enable formatting support for JSON(C|5).
+   *
+   * @default true
+   */
+  json?: boolean;
+  /**
+   * Enable formatting support for Lua files (powered by stylua).
+   *
+   * @default true
+   */
+  lua?: boolean;
+  /**
+   * Enable formatting support for Markdown.
+   *
+   * @default true
+   */
+  markdown?: boolean;
+  /**
+   * Custom options for oxfmt. Takes precedence over options migrated from
+   * prettier.
+   */
+  oxfmtOptions?: OxfmtOptions;
+  /**
+   * Custom options for Prettier.
+   *
+   * Used for flawless/arrow-return-style and as a migration source for oxfmt
+   * options.
+   */
+  prettierOptions?: Options;
+  /**
+   * Enable formatting support for YAML.
+   *
+   * @default true
+   */
+  yaml?: boolean;
+}
+//#endregion
+//#region src/formatted-files.d.ts
+/** The languages `formatters` turns on and off. */
+type FormattedLanguages = Pick<OptionsFormatters, "css" | "graphql" | "html" | "json" | "markdown" | "yaml">;
+/** Which files are formatted. */
+interface FormattedFilesOptions {
+  /** Component extensions formatted with TypeScript, without the dot. */
+  componentExts?: Array<string>;
+  /**
+   * Languages to format besides JS and TS; `false` formats JS and TS only.
+   * Default `true`.
+   */
+  formatters?: boolean | FormattedLanguages;
+}
+//#endregion
+//#region src/oxfmt/index.d.ts
+/**
+ * Options for {@link isentinelOxfmt}: an oxfmt config, plus the preset's own.
+ */
+type IsentinelOxfmtOptions = FormattedFilesOptions & OxfmtConfig$1 & {
+  /** Directory to resolve `.prettierrc` and `.editorconfig` from. */
+  cwd?: string;
+};
+/**
+ * Build the preset's oxfmt config.
+ *
+ * Root format options start from the same defaults the ESLint and oxlint
+ * factories use (preset defaults < `.editorconfig` < `.prettierrc`), and every
+ * key in `config` replaces its base value. `ignorePatterns` and `overrides`
+ * are the exception: the user's entries are appended to the preset's, so a
+ * user override wins over the preset's Markdown, YAML and JSON5 overrides.
+ * The `.prettierrc` overrides come last, as in ESLint mode. Slash-less
+ * override globs are anchored to the config directory (`*.json` becomes
+ * `./*.json`), so they match the files the ESLint rule matches.
+ *
+ * Oxfmt formats the files ESLint mode formats, and no others: TOML, `.mdx` and
+ * the like stay as they are.
+ *
+ * @param config - Options that replace the preset's, plus extra ignore
+ *   patterns and overrides.
+ * @param config.componentExts - Component extensions to format, as the
+ *   factories' `componentExts`.
+ * @param config.cwd - Directory to resolve `.prettierrc` and `.editorconfig`
+ *   from (default `process.cwd()`).
+ * @param config.formatters - Languages to format besides JS and TS, as the
+ *   factories' `formatters`.
+ * @param config.ignorePatterns - Appended to the preset's ignore patterns.
+ * @param config.overrides - Appended to the preset's overrides.
+ * @returns The oxfmt config.
+ */
+declare function isentinelOxfmt({ componentExts, cwd, formatters, ignorePatterns, overrides, ...rest }?: IsentinelOxfmtOptions): OxfmtConfig$1;
+//#endregion
+export { IsentinelOxfmtOptions, type OxfmtConfig, isentinelOxfmt };