prettier-config-nick2bad4u 1.0.14 → 1.0.16

package/README.md

@@ -276,11 +276,14 @@ export default {
 - Default export: the shared Prettier config object
 - Named export: `config`
 - Named exports: `createConfig`, `defaultExtensionlessJsonFiles`, `defaultExtensionlessIniFiles`, `extensionlessJsonOptions`, `extensionlessIniOptions`, `typescriptOverrideOptions`, `jsonOverrideOptions`, `packageJsonOverrideOptions`, `htmlOverrideOptions`, `userJavaScriptOverrideOptions`, `markdownOverrideOptions`, `mdxOverrideOptions`, `astroOverrideOptions`, `yamlOverrideOptions`, `tomlOverrideOptions`, `xmlOverrideOptions`, `phpOverrideOptions`, `sqlOverrideOptions`, `powershellOverrideOptions`, `codeownersOverrideOptions`, `shellOverrideOptions`, `propertiesOverrideOptions`, `iniOverrideOptions`
-- Published files: `prettier.config.mjs`, `preset.mjs`, and `index.d.ts`
+- TypeScript source: `src/prettier.config.mts` and `src/preset.mts`
+- Root shims: `prettier.config.mjs`, `preset.mjs`, `index.d.ts`, and `prettier.config.d.mts`
+- Generated package implementation: `dist/`
 
 ## Development checks
 
 ```sh
+npm run build
 npm run lint:all
 npm run coverage
 npm run release:verify

package/dist/preset.d.mts

@@ -0,0 +1,66 @@
+import type { Config } from "prettier";
+import { type CreateConfigOptions as InternalCreateConfigOptions, type InheritedOverrideConfig as InternalInheritedOverrideConfig } from "./prettier.config.mjs";
+/** Options for building a customized shared Prettier configuration. */
+export type CreateConfigOptions = InternalCreateConfigOptions;
+/**
+ * Configuration for appending an override that inherits from an existing base
+ * override.
+ */
+export type InheritedOverrideConfig = InternalInheritedOverrideConfig;
+type PublicPrettierOptions = Readonly<Partial<Config>>;
+/** Named export — use when you want to spread or inspect individual options. */
+export declare const config: Readonly<Config>;
+/**
+ * Build a config with merged/replaced extensionless JSON/INI override globs.
+ */
+export declare const createConfig: (options?: Readonly<CreateConfigOptions>) => Config;
+/** Default extensionless INI-like globs used by this shared configuration. */
+export declare const defaultExtensionlessIniFiles: readonly string[];
+/** Default extensionless JSON-like globs used by this shared configuration. */
+export declare const defaultExtensionlessJsonFiles: readonly string[];
+/** Shared option preset used for extensionless INI-like override blocks. */
+export declare const extensionlessIniOptions: PublicPrettierOptions;
+/** Shared option preset used for extensionless JSON-like override blocks. */
+export declare const extensionlessJsonOptions: PublicPrettierOptions;
+/** Shared option preset used by the primary JS/TS override block. */
+export declare const typescriptOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by the generic JSON override block. */
+export declare const jsonOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by the package.json/package-lock override block. */
+export declare const packageJsonOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by HTML override blocks. */
+export declare const htmlOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by *.user.js override blocks. */
+export declare const userJavaScriptOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by Markdown override blocks. */
+export declare const markdownOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by MDX override blocks. */
+export declare const mdxOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by Astro override blocks. */
+export declare const astroOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by YAML override blocks. */
+export declare const yamlOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by TOML override blocks. */
+export declare const tomlOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by XML-family override blocks. */
+export declare const xmlOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by PHP override blocks. */
+export declare const phpOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by SQL override blocks. */
+export declare const sqlOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by PowerShell override blocks. */
+export declare const powershellOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by CODEOWNERS override blocks. */
+export declare const codeownersOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by shell script override blocks. */
+export declare const shellOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by .properties override blocks. */
+export declare const propertiesOverrideOptions: PublicPrettierOptions;
+/** Shared option preset used by .ini override blocks. */
+export declare const iniOverrideOptions: PublicPrettierOptions;
+/**
+ * Default export — distinct binding so consuming projects don't trigger
+ * import/default lint noise when consumers import the package default.
+ */
+declare const prettierConfig: Readonly<Config>;
+export default prettierConfig;

package/dist/preset.mjs

@@ -0,0 +1,101 @@
+import sharedPrettierConfig, { astroOverrideOptions as astroOverrideOptionsInternal, codeownersOverrideOptions as codeownersOverrideOptionsInternal, createConfig as createConfigInternal, defaultExtensionlessIniFiles as defaultExtensionlessIniFilesInternal, defaultExtensionlessJsonFiles as defaultExtensionlessJsonFilesInternal, extensionlessIniOptions as extensionlessIniOptionsInternal, extensionlessJsonOptions as extensionlessJsonOptionsInternal, htmlOverrideOptions as htmlOverrideOptionsInternal, iniOverrideOptions as iniOverrideOptionsInternal, jsonOverrideOptions as jsonOverrideOptionsInternal, markdownOverrideOptions as markdownOverrideOptionsInternal, mdxOverrideOptions as mdxOverrideOptionsInternal, packageJsonOverrideOptions as packageJsonOverrideOptionsInternal, phpOverrideOptions as phpOverrideOptionsInternal, powershellOverrideOptions as powershellOverrideOptionsInternal, propertiesOverrideOptions as propertiesOverrideOptionsInternal, shellOverrideOptions as shellOverrideOptionsInternal, sqlOverrideOptions as sqlOverrideOptionsInternal, tomlOverrideOptions as tomlOverrideOptionsInternal, typescriptOverrideOptions as typescriptOverrideOptionsInternal, userJavaScriptOverrideOptions as userJavaScriptOverrideOptionsInternal, xmlOverrideOptions as xmlOverrideOptionsInternal, yamlOverrideOptions as yamlOverrideOptionsInternal, } from "./prettier.config.mjs";
+/** Named export — use when you want to spread or inspect individual options. */
+export const config = Object.freeze(sharedPrettierConfig);
+/**
+ * Build a config with merged/replaced extensionless JSON/INI override globs.
+ */
+export const createConfig = (options = {}) => createConfigInternal(options);
+/** Default extensionless INI-like globs used by this shared configuration. */
+export const defaultExtensionlessIniFiles = Object.freeze([
+    ...defaultExtensionlessIniFilesInternal,
+]);
+/** Default extensionless JSON-like globs used by this shared configuration. */
+export const defaultExtensionlessJsonFiles = Object.freeze([
+    ...defaultExtensionlessJsonFilesInternal,
+]);
+/** Shared option preset used for extensionless INI-like override blocks. */
+export const extensionlessIniOptions = Object.freeze({
+    ...extensionlessIniOptionsInternal,
+});
+/** Shared option preset used for extensionless JSON-like override blocks. */
+export const extensionlessJsonOptions = Object.freeze({
+    ...extensionlessJsonOptionsInternal,
+});
+/** Shared option preset used by the primary JS/TS override block. */
+export const typescriptOverrideOptions = Object.freeze({
+    ...typescriptOverrideOptionsInternal,
+});
+/** Shared option preset used by the generic JSON override block. */
+export const jsonOverrideOptions = Object.freeze({
+    ...jsonOverrideOptionsInternal,
+});
+/** Shared option preset used by the package.json/package-lock override block. */
+export const packageJsonOverrideOptions = Object.freeze({
+    ...packageJsonOverrideOptionsInternal,
+});
+/** Shared option preset used by HTML override blocks. */
+export const htmlOverrideOptions = Object.freeze({
+    ...htmlOverrideOptionsInternal,
+});
+/** Shared option preset used by *.user.js override blocks. */
+export const userJavaScriptOverrideOptions = Object.freeze({
+    ...userJavaScriptOverrideOptionsInternal,
+});
+/** Shared option preset used by Markdown override blocks. */
+export const markdownOverrideOptions = Object.freeze({
+    ...markdownOverrideOptionsInternal,
+});
+/** Shared option preset used by MDX override blocks. */
+export const mdxOverrideOptions = Object.freeze({
+    ...mdxOverrideOptionsInternal,
+});
+/** Shared option preset used by Astro override blocks. */
+export const astroOverrideOptions = Object.freeze({
+    ...astroOverrideOptionsInternal,
+});
+/** Shared option preset used by YAML override blocks. */
+export const yamlOverrideOptions = Object.freeze({
+    ...yamlOverrideOptionsInternal,
+});
+/** Shared option preset used by TOML override blocks. */
+export const tomlOverrideOptions = Object.freeze({
+    ...tomlOverrideOptionsInternal,
+});
+/** Shared option preset used by XML-family override blocks. */
+export const xmlOverrideOptions = Object.freeze({
+    ...xmlOverrideOptionsInternal,
+});
+/** Shared option preset used by PHP override blocks. */
+export const phpOverrideOptions = Object.freeze({
+    ...phpOverrideOptionsInternal,
+});
+/** Shared option preset used by SQL override blocks. */
+export const sqlOverrideOptions = Object.freeze({
+    ...sqlOverrideOptionsInternal,
+});
+/** Shared option preset used by PowerShell override blocks. */
+export const powershellOverrideOptions = Object.freeze({
+    ...powershellOverrideOptionsInternal,
+});
+/** Shared option preset used by CODEOWNERS override blocks. */
+export const codeownersOverrideOptions = Object.freeze({
+    ...codeownersOverrideOptionsInternal,
+});
+/** Shared option preset used by shell script override blocks. */
+export const shellOverrideOptions = Object.freeze({
+    ...shellOverrideOptionsInternal,
+});
+/** Shared option preset used by .properties override blocks. */
+export const propertiesOverrideOptions = Object.freeze({
+    ...propertiesOverrideOptionsInternal,
+});
+/** Shared option preset used by .ini override blocks. */
+export const iniOverrideOptions = Object.freeze({
+    ...iniOverrideOptionsInternal,
+});
+/**
+ * Default export — distinct binding so consuming projects don't trigger
+ * import/default lint noise when consumers import the package default.
+ */
+const prettierConfig = config;
+export default prettierConfig;

package/dist/prettier.config.d.mts

@@ -0,0 +1,99 @@
+/**
+ * Prettier configuration for Nick2Bad4U's projects
+ *
+ * @see https://prettier.io/docs/en/configuration.html
+ * @see https://www.schemastore.org/prettierrc/
+ */
+import type { Config } from "prettier";
+/** Options for building a customized shared Prettier configuration. */
+export interface CreateConfigOptions {
+    /** Additional extensionless INI-like file globs to include. */
+    extensionlessIniFiles?: readonly string[];
+    /** Additional extensionless JSON-like file globs to include. */
+    extensionlessJsonFiles?: readonly string[];
+    /**
+     * Additional file-targeted overrides that inherit options from existing
+     * base overrides.
+     */
+    inheritedOverrides?: readonly InheritedOverrideConfig[];
+    /** Replace default INI-like globs instead of merging with them. */
+    replaceDefaultExtensionlessIniFiles?: boolean;
+    /** Replace default JSON-like globs instead of merging with them. */
+    replaceDefaultExtensionlessJsonFiles?: boolean;
+}
+/**
+ * Configuration for appending an override that inherits from an existing base
+ * override.
+ */
+export interface InheritedOverrideConfig {
+    /** Optional file pattern(s) to exclude from the inherited override. */
+    excludeFiles?: OverrideFiles;
+    /** File pattern(s) for the new inherited override to target. */
+    files: OverrideFiles;
+    /**
+     * Existing base override file pattern(s) to inherit options from (for
+     * example "*.ts").
+     */
+    inheritFrom: OverrideFiles;
+    /**
+     * Additional override options merged on top of the inherited source
+     * options.
+     */
+    options?: Readonly<PluginAwarePrettierOptions>;
+}
+type ConfigOverride = ConfigOverrides extends readonly (infer Override)[] ? Override : never;
+type ConfigOverrides = NonNullable<Config["overrides"]>;
+type OverrideFiles = ConfigOverride["files"];
+type PluginAwarePrettierOptions = Partial<Config>;
+/** Default extensionless JSON-like globs used by this shared configuration. */
+export declare const defaultExtensionlessJsonFiles: readonly string[];
+/** Default extensionless INI-like globs used by this shared configuration. */
+export declare const defaultExtensionlessIniFiles: readonly string[];
+/** Shared option preset used for extensionless JSON-like override blocks. */
+export declare const extensionlessJsonOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used for extensionless INI-like override blocks. */
+export declare const extensionlessIniOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by the primary JS/TS override block. */
+export declare const typescriptOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by the generic JSON override block. */
+export declare const jsonOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by the package.json/package-lock override block. */
+export declare const packageJsonOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by HTML override blocks. */
+export declare const htmlOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by *.user.js override blocks. */
+export declare const userJavaScriptOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by Markdown override blocks. */
+export declare const markdownOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by MDX override blocks. */
+export declare const mdxOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by Astro override blocks. */
+export declare const astroOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by YAML override blocks. */
+export declare const yamlOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by TOML override blocks. */
+export declare const tomlOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by XML-family override blocks. */
+export declare const xmlOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by PHP override blocks. */
+export declare const phpOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by SQL override blocks. */
+export declare const sqlOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by PowerShell override blocks. */
+export declare const powershellOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by CODEOWNERS override blocks. */
+export declare const codeownersOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by shell script override blocks. */
+export declare const shellOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by .properties override blocks. */
+export declare const propertiesOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/** Shared option preset used by .ini override blocks. */
+export declare const iniOverrideOptions: Readonly<PluginAwarePrettierOptions>;
+/**
+ * Build a Prettier config with optional extensionless JSON and INI file
+ * overrides.
+ */
+export declare const createConfig: (options?: Readonly<CreateConfigOptions>) => Config;
+/** Shared Prettier configuration exported by default for package consumers. */
+declare const sharedPrettierConfig: Config;
+export default sharedPrettierConfig;