@sidebase/base-config 0.1.0

package/dist/config.d.mts

@@ -0,0 +1,189 @@
+import { C as CreateSidebaseEslintOptions } from './shared/base-config.CuUhyvQo.mjs';
+
+/**
+ * Version-baseline profile, named for the framework AND its major so two majors can
+ * coexist during a migration: the manifest declares one profile per major with its own
+ * `detect.majorIs`, and each repo detects the one matching its own Nuxt version.
+ *
+ * The name MUST match a `versionProfiles` key in the preset chain. The CLI resolves the
+ * baseline with `versionProfiles?.[profile] ?? {}`, so a name nothing declares reconciles
+ * NOTHING, silently. `scripts/validate-presets.mjs` fails the build on that mismatch.
+ */
+type Profile = "nuxt-4";
+/**
+ * Optional CI knobs (`config.ci.*`) the nuxt-app preset understands: the job
+ * toggles. Keys mirror the manifest's `ci.*` `configKeys`; the consistency test
+ * in `test/config.test.ts` proves they stay in lockstep.
+ */
+interface NuxtBaseCiConfig {
+    /** Include the `pnpm test` job. */
+    unitTests?: boolean;
+    /** Include the e2e job + postgres service. */
+    e2e?: boolean;
+}
+/**
+ * Optional runtime version pins (`config.versions.*`). `node` feeds every
+ * render (`ci.yml`, the Dockerfile, the upgrade-PR workflow); `pnpm` feeds the
+ * Dockerfile only. CI takes its pnpm from `package.json#packageManager`, the
+ * single reconciled source, so it is never passed to `pnpm/action-setup`.
+ * Defaults come from the version baseline (node 24.13.0, pnpm 10.28.1).
+ */
+interface NuxtBaseVersionsConfig {
+    /** Node version for CI jobs, the Docker base image, and the upgrade workflow. */
+    node?: string;
+    /**
+     * pnpm version for the Docker global pnpm install only. CI pins pnpm through
+     * `package.json#packageManager` instead, so this does not affect any workflow.
+     */
+    pnpm?: string;
+}
+/**
+ * Optional Dockerfile knobs (`config.docker.*`) the nuxt-app preset understands.
+ */
+interface NuxtBaseDockerConfig {
+    /**
+     * Project-owned apt packages for the production stage, ON TOP of the baked-in
+     * baseline (`openssl`: the Prisma query engine generated in the build stage
+     * dynamically links libssl3, which slim images do not ship).
+     */
+    aptPackages?: string[];
+    /**
+     * Raw Dockerfile text injected in the build stage BEFORE `pnpm install`, e.g.
+     * a `COPY ./vendor ./vendor` a repo needs present at install time. Lands
+     * verbatim; see the trust note below. Global installs must use `npm i -g`
+     * (`PNPM_HOME` is not set, so `pnpm add -g` fails to find its bin dir).
+     */
+    preInstall?: string;
+    /**
+     * Raw Dockerfile text injected in the build stage BEFORE `COPY . .`, e.g.
+     * project `ARG`/`ENV` build-flag pairs. Lands verbatim.
+     */
+    buildArgs?: string;
+    /**
+     * The build-stage command block (`RUN pnpm nuxi prepare` / `prisma generate`
+     * / `run build`). Defaults to all three; a repo with no Prisma overrides it to
+     * drop `prisma generate`. Order-preserving, lands verbatim.
+     */
+    buildSteps?: string;
+    /**
+     * Raw Dockerfile text injected in the final stage BEFORE `CMD`, e.g. extra
+     * `ENV`, `COPY --from`, or `RUN`. Lands verbatim. Cannot drop the fixed
+     * `USER node` switch, which sits below it.
+     */
+    finalStage?: string;
+    /**
+     * The final-stage Prisma runtime block (copy the schema, install the CLI for
+     * `migrate deploy`). Defaults to that block; set `""` for a repo with no
+     * Prisma. The `USER node` switch and the `.output` ownership are FIXED outside
+     * this knob, so an override cannot re-root the container. Lands verbatim.
+     */
+    prismaRuntime?: string;
+    /**
+     * The `sh -c` argument of the final `CMD`. Defaults to
+     * `prisma migrate deploy` then the node server; override e.g. for `db push`
+     * or a repo with no Prisma. Lands verbatim.
+     */
+    startCommand?: string;
+}
+/**
+ * Optional automation knobs (`config.automation.*`) the base preset understands:
+ * the opt-in upgrade-PR workflow and its runtime version pins. Keys mirror the
+ * manifest's `automation.*` `configKeys`; the consistency test in
+ * `test/config.test.ts` proves they stay in lockstep.
+ */
+interface NuxtBaseAutomationConfig {
+    /** Sync the weekly streamctl upgrade-PR workflow (default: off, no workflow lands). */
+    upgradePr?: boolean;
+}
+/**
+ * Optional supply-chain knobs (`config.security.*`) the base preset understands:
+ * the pnpm install cooldown rendered into the managed `pnpm-workspace.yaml`.
+ */
+interface NuxtBaseSecurityConfig {
+    /**
+     * Minutes a version must have been published before pnpm resolves it
+     * (`minimumReleaseAge`). Default `"10080"` (7 days); `"0"` disables the cooldown.
+     * A STRING because the manifest's `configKeys` has no number type, same as the
+     * `versions.*` pins.
+     */
+    minimumReleaseAge?: string;
+}
+/**
+ * Optional pnpm knobs (`config.pnpm.*`) rendered into the managed
+ * `pnpm-workspace.yaml`.
+ */
+interface NuxtBasePnpmConfig {
+    /**
+     * Packages allowed to run install lifecycle scripts, ON TOP of the baked-in
+     * baseline (`@prisma/client`, `esbuild`, `prisma`). Use this instead of
+     * `pnpm approve-builds`, which writes to the managed file and is reverted on
+     * the next sync.
+     */
+    onlyBuiltDependencies?: string[];
+}
+/**
+ * The typed `streamctl.config.ts` shape for the `@sidebase/base-config` payload:
+ * the CLI-universal fields plus this payload's declared knobs (`ci`, `versions`,
+ * `docker`, `automation`, `eslint`) with their real option types. The generic CLI only
+ * shape-checks these against the manifest's `configKeys`, so the precise types live
+ * here, next to the payload that owns them, and consumers keep a fully typed config.
+ */
+interface NuxtBaseConfig {
+    /** The payload package this repo syncs from. */
+    package: string;
+    /** Preset to derive from (validated against the payload's presets). */
+    base: string;
+    /** Pinned streamctl release the repo tracks (semver). */
+    version: string;
+    /** Version-allow-list profile. */
+    profile: Profile;
+    /** Master opt-out for `package.json` version reconciliation. */
+    versionSync?: boolean;
+    /** Specific allow-list keys this repo opts out of. */
+    versionSyncExclude?: string[];
+    /** Per-file opt-out from sync. */
+    files?: Record<string, "managed" | "off">;
+    /** Optional CI job knobs. */
+    ci?: NuxtBaseCiConfig;
+    /** Optional runtime version pins shared by every render (ci, docker, automation). */
+    versions?: NuxtBaseVersionsConfig;
+    /** Optional Dockerfile knobs (extra apt packages on top of the baked-in baseline). */
+    docker?: NuxtBaseDockerConfig;
+    /** Optional automation knobs (opt-in upgrade-PR workflow). */
+    automation?: NuxtBaseAutomationConfig;
+    /** Optional supply-chain knobs (the pnpm install cooldown). */
+    security?: NuxtBaseSecurityConfig;
+    /** Optional pnpm knobs (extra build-script allowances). */
+    pnpm?: NuxtBasePnpmConfig;
+    /** ESLint factory options, typed with the payload's own option surface. */
+    eslint?: CreateSidebaseEslintOptions;
+}
+/**
+ * Identity helper for a typed `streamctl.config.ts`, the payload analog of the
+ * CLI's `defineStreamctlConfig`, adding editor inference for this payload's knobs.
+ * Returns the config unchanged; the CLI validates it at load.
+ */
+declare function defineNuxtBaseConfig(config: NuxtBaseConfig): NuxtBaseConfig;
+/** Runtime list of every {@link NuxtBaseCiConfig} key. */
+declare const NUXT_BASE_CI_KEYS: string[];
+/** Runtime list of every {@link NuxtBaseVersionsConfig} key. */
+declare const NUXT_BASE_VERSIONS_KEYS: string[];
+/** Runtime list of every {@link NuxtBaseDockerConfig} key. */
+declare const NUXT_BASE_DOCKER_KEYS: string[];
+/** Runtime list of every {@link NuxtBaseAutomationConfig} key. */
+declare const NUXT_BASE_AUTOMATION_KEYS: string[];
+/** Runtime list of every {@link NuxtBaseSecurityConfig} key. */
+declare const NUXT_BASE_SECURITY_KEYS: string[];
+/** Runtime list of every {@link NuxtBasePnpmConfig} key. */
+declare const NUXT_BASE_PNPM_KEYS: string[];
+/**
+ * Every payload KNOB dot-path {@link NuxtBaseConfig} declares (the `ci.*` and
+ * `automation.*` leaves plus the top-level knobs); excludes the CLI-universal
+ * fields. The consistency test asserts this set equals the RESOLVED preset chain's
+ * declared `configKeys` (base + nuxt-app), catching drift between the type and the
+ * manifest in either direction.
+ */
+declare const NUXT_BASE_CONFIG_KEYS: string[];
+
+export { NUXT_BASE_AUTOMATION_KEYS, NUXT_BASE_CI_KEYS, NUXT_BASE_CONFIG_KEYS, NUXT_BASE_DOCKER_KEYS, NUXT_BASE_PNPM_KEYS, NUXT_BASE_SECURITY_KEYS, NUXT_BASE_VERSIONS_KEYS, defineNuxtBaseConfig };
+export type { NuxtBaseAutomationConfig, NuxtBaseCiConfig, NuxtBaseConfig, NuxtBaseDockerConfig, NuxtBasePnpmConfig, NuxtBaseSecurityConfig, NuxtBaseVersionsConfig, Profile };

package/dist/config.d.ts

@@ -0,0 +1,189 @@
+import { C as CreateSidebaseEslintOptions } from './shared/base-config.CuUhyvQo.js';
+
+/**
+ * Version-baseline profile, named for the framework AND its major so two majors can
+ * coexist during a migration: the manifest declares one profile per major with its own
+ * `detect.majorIs`, and each repo detects the one matching its own Nuxt version.
+ *
+ * The name MUST match a `versionProfiles` key in the preset chain. The CLI resolves the
+ * baseline with `versionProfiles?.[profile] ?? {}`, so a name nothing declares reconciles
+ * NOTHING, silently. `scripts/validate-presets.mjs` fails the build on that mismatch.
+ */
+type Profile = "nuxt-4";
+/**
+ * Optional CI knobs (`config.ci.*`) the nuxt-app preset understands: the job
+ * toggles. Keys mirror the manifest's `ci.*` `configKeys`; the consistency test
+ * in `test/config.test.ts` proves they stay in lockstep.
+ */
+interface NuxtBaseCiConfig {
+    /** Include the `pnpm test` job. */
+    unitTests?: boolean;
+    /** Include the e2e job + postgres service. */
+    e2e?: boolean;
+}
+/**
+ * Optional runtime version pins (`config.versions.*`). `node` feeds every
+ * render (`ci.yml`, the Dockerfile, the upgrade-PR workflow); `pnpm` feeds the
+ * Dockerfile only. CI takes its pnpm from `package.json#packageManager`, the
+ * single reconciled source, so it is never passed to `pnpm/action-setup`.
+ * Defaults come from the version baseline (node 24.13.0, pnpm 10.28.1).
+ */
+interface NuxtBaseVersionsConfig {
+    /** Node version for CI jobs, the Docker base image, and the upgrade workflow. */
+    node?: string;
+    /**
+     * pnpm version for the Docker global pnpm install only. CI pins pnpm through
+     * `package.json#packageManager` instead, so this does not affect any workflow.
+     */
+    pnpm?: string;
+}
+/**
+ * Optional Dockerfile knobs (`config.docker.*`) the nuxt-app preset understands.
+ */
+interface NuxtBaseDockerConfig {
+    /**
+     * Project-owned apt packages for the production stage, ON TOP of the baked-in
+     * baseline (`openssl`: the Prisma query engine generated in the build stage
+     * dynamically links libssl3, which slim images do not ship).
+     */
+    aptPackages?: string[];
+    /**
+     * Raw Dockerfile text injected in the build stage BEFORE `pnpm install`, e.g.
+     * a `COPY ./vendor ./vendor` a repo needs present at install time. Lands
+     * verbatim; see the trust note below. Global installs must use `npm i -g`
+     * (`PNPM_HOME` is not set, so `pnpm add -g` fails to find its bin dir).
+     */
+    preInstall?: string;
+    /**
+     * Raw Dockerfile text injected in the build stage BEFORE `COPY . .`, e.g.
+     * project `ARG`/`ENV` build-flag pairs. Lands verbatim.
+     */
+    buildArgs?: string;
+    /**
+     * The build-stage command block (`RUN pnpm nuxi prepare` / `prisma generate`
+     * / `run build`). Defaults to all three; a repo with no Prisma overrides it to
+     * drop `prisma generate`. Order-preserving, lands verbatim.
+     */
+    buildSteps?: string;
+    /**
+     * Raw Dockerfile text injected in the final stage BEFORE `CMD`, e.g. extra
+     * `ENV`, `COPY --from`, or `RUN`. Lands verbatim. Cannot drop the fixed
+     * `USER node` switch, which sits below it.
+     */
+    finalStage?: string;
+    /**
+     * The final-stage Prisma runtime block (copy the schema, install the CLI for
+     * `migrate deploy`). Defaults to that block; set `""` for a repo with no
+     * Prisma. The `USER node` switch and the `.output` ownership are FIXED outside
+     * this knob, so an override cannot re-root the container. Lands verbatim.
+     */
+    prismaRuntime?: string;
+    /**
+     * The `sh -c` argument of the final `CMD`. Defaults to
+     * `prisma migrate deploy` then the node server; override e.g. for `db push`
+     * or a repo with no Prisma. Lands verbatim.
+     */
+    startCommand?: string;
+}
+/**
+ * Optional automation knobs (`config.automation.*`) the base preset understands:
+ * the opt-in upgrade-PR workflow and its runtime version pins. Keys mirror the
+ * manifest's `automation.*` `configKeys`; the consistency test in
+ * `test/config.test.ts` proves they stay in lockstep.
+ */
+interface NuxtBaseAutomationConfig {
+    /** Sync the weekly streamctl upgrade-PR workflow (default: off, no workflow lands). */
+    upgradePr?: boolean;
+}
+/**
+ * Optional supply-chain knobs (`config.security.*`) the base preset understands:
+ * the pnpm install cooldown rendered into the managed `pnpm-workspace.yaml`.
+ */
+interface NuxtBaseSecurityConfig {
+    /**
+     * Minutes a version must have been published before pnpm resolves it
+     * (`minimumReleaseAge`). Default `"10080"` (7 days); `"0"` disables the cooldown.
+     * A STRING because the manifest's `configKeys` has no number type, same as the
+     * `versions.*` pins.
+     */
+    minimumReleaseAge?: string;
+}
+/**
+ * Optional pnpm knobs (`config.pnpm.*`) rendered into the managed
+ * `pnpm-workspace.yaml`.
+ */
+interface NuxtBasePnpmConfig {
+    /**
+     * Packages allowed to run install lifecycle scripts, ON TOP of the baked-in
+     * baseline (`@prisma/client`, `esbuild`, `prisma`). Use this instead of
+     * `pnpm approve-builds`, which writes to the managed file and is reverted on
+     * the next sync.
+     */
+    onlyBuiltDependencies?: string[];
+}
+/**
+ * The typed `streamctl.config.ts` shape for the `@sidebase/base-config` payload:
+ * the CLI-universal fields plus this payload's declared knobs (`ci`, `versions`,
+ * `docker`, `automation`, `eslint`) with their real option types. The generic CLI only
+ * shape-checks these against the manifest's `configKeys`, so the precise types live
+ * here, next to the payload that owns them, and consumers keep a fully typed config.
+ */
+interface NuxtBaseConfig {
+    /** The payload package this repo syncs from. */
+    package: string;
+    /** Preset to derive from (validated against the payload's presets). */
+    base: string;
+    /** Pinned streamctl release the repo tracks (semver). */
+    version: string;
+    /** Version-allow-list profile. */
+    profile: Profile;
+    /** Master opt-out for `package.json` version reconciliation. */
+    versionSync?: boolean;
+    /** Specific allow-list keys this repo opts out of. */
+    versionSyncExclude?: string[];
+    /** Per-file opt-out from sync. */
+    files?: Record<string, "managed" | "off">;
+    /** Optional CI job knobs. */
+    ci?: NuxtBaseCiConfig;
+    /** Optional runtime version pins shared by every render (ci, docker, automation). */
+    versions?: NuxtBaseVersionsConfig;
+    /** Optional Dockerfile knobs (extra apt packages on top of the baked-in baseline). */
+    docker?: NuxtBaseDockerConfig;
+    /** Optional automation knobs (opt-in upgrade-PR workflow). */
+    automation?: NuxtBaseAutomationConfig;
+    /** Optional supply-chain knobs (the pnpm install cooldown). */
+    security?: NuxtBaseSecurityConfig;
+    /** Optional pnpm knobs (extra build-script allowances). */
+    pnpm?: NuxtBasePnpmConfig;
+    /** ESLint factory options, typed with the payload's own option surface. */
+    eslint?: CreateSidebaseEslintOptions;
+}
+/**
+ * Identity helper for a typed `streamctl.config.ts`, the payload analog of the
+ * CLI's `defineStreamctlConfig`, adding editor inference for this payload's knobs.
+ * Returns the config unchanged; the CLI validates it at load.
+ */
+declare function defineNuxtBaseConfig(config: NuxtBaseConfig): NuxtBaseConfig;
+/** Runtime list of every {@link NuxtBaseCiConfig} key. */
+declare const NUXT_BASE_CI_KEYS: string[];
+/** Runtime list of every {@link NuxtBaseVersionsConfig} key. */
+declare const NUXT_BASE_VERSIONS_KEYS: string[];
+/** Runtime list of every {@link NuxtBaseDockerConfig} key. */
+declare const NUXT_BASE_DOCKER_KEYS: string[];
+/** Runtime list of every {@link NuxtBaseAutomationConfig} key. */
+declare const NUXT_BASE_AUTOMATION_KEYS: string[];
+/** Runtime list of every {@link NuxtBaseSecurityConfig} key. */
+declare const NUXT_BASE_SECURITY_KEYS: string[];
+/** Runtime list of every {@link NuxtBasePnpmConfig} key. */
+declare const NUXT_BASE_PNPM_KEYS: string[];
+/**
+ * Every payload KNOB dot-path {@link NuxtBaseConfig} declares (the `ci.*` and
+ * `automation.*` leaves plus the top-level knobs); excludes the CLI-universal
+ * fields. The consistency test asserts this set equals the RESOLVED preset chain's
+ * declared `configKeys` (base + nuxt-app), catching drift between the type and the
+ * manifest in either direction.
+ */
+declare const NUXT_BASE_CONFIG_KEYS: string[];
+
+export { NUXT_BASE_AUTOMATION_KEYS, NUXT_BASE_CI_KEYS, NUXT_BASE_CONFIG_KEYS, NUXT_BASE_DOCKER_KEYS, NUXT_BASE_PNPM_KEYS, NUXT_BASE_SECURITY_KEYS, NUXT_BASE_VERSIONS_KEYS, defineNuxtBaseConfig };
+export type { NuxtBaseAutomationConfig, NuxtBaseCiConfig, NuxtBaseConfig, NuxtBaseDockerConfig, NuxtBasePnpmConfig, NuxtBaseSecurityConfig, NuxtBaseVersionsConfig, Profile };

package/dist/config.mjs

@@ -0,0 +1,46 @@
+function defineNuxtBaseConfig(config) {
+  return config;
+}
+function knobKeys(shape) {
+  return Object.keys(shape);
+}
+const NUXT_BASE_CI_KEYS = knobKeys({
+  unitTests: 0,
+  e2e: 0
+});
+const NUXT_BASE_VERSIONS_KEYS = knobKeys({
+  node: 0,
+  pnpm: 0
+});
+const NUXT_BASE_DOCKER_KEYS = knobKeys({
+  aptPackages: 0,
+  preInstall: 0,
+  buildArgs: 0,
+  buildSteps: 0,
+  finalStage: 0,
+  prismaRuntime: 0,
+  startCommand: 0
+});
+const NUXT_BASE_AUTOMATION_KEYS = knobKeys({
+  upgradePr: 0
+});
+const NUXT_BASE_SECURITY_KEYS = knobKeys({
+  minimumReleaseAge: 0
+});
+const NUXT_BASE_PNPM_KEYS = knobKeys({
+  onlyBuiltDependencies: 0
+});
+const NUXT_BASE_TOP_LEVEL_KNOBS = knobKeys({
+  eslint: 0
+});
+const NUXT_BASE_CONFIG_KEYS = [
+  ...NUXT_BASE_CI_KEYS.map((key) => `ci.${key}`),
+  ...NUXT_BASE_VERSIONS_KEYS.map((key) => `versions.${key}`),
+  ...NUXT_BASE_DOCKER_KEYS.map((key) => `docker.${key}`),
+  ...NUXT_BASE_AUTOMATION_KEYS.map((key) => `automation.${key}`),
+  ...NUXT_BASE_SECURITY_KEYS.map((key) => `security.${key}`),
+  ...NUXT_BASE_PNPM_KEYS.map((key) => `pnpm.${key}`),
+  ...NUXT_BASE_TOP_LEVEL_KNOBS
+];
+
+export { NUXT_BASE_AUTOMATION_KEYS, NUXT_BASE_CI_KEYS, NUXT_BASE_CONFIG_KEYS, NUXT_BASE_DOCKER_KEYS, NUXT_BASE_PNPM_KEYS, NUXT_BASE_SECURITY_KEYS, NUXT_BASE_VERSIONS_KEYS, defineNuxtBaseConfig };

package/dist/eslint/index.d.mts

@@ -0,0 +1,55 @@
+import { C as CreateSidebaseEslintOptions } from '../shared/base-config.CuUhyvQo.mjs';
+export { E as ESLINT_OPTION_KEYS } from '../shared/base-config.CuUhyvQo.mjs';
+import antfu, { TypedFlatConfigItem } from '@antfu/eslint-config';
+
+/** {@link CreateSidebaseEslintOptions} with all defaults applied + the computed type-aware gate. */
+interface ResolvedEslintOptions {
+    zod: "full" | "import-style" | "none";
+    /**
+     * A non-empty allow-list, or `"error"` (hard ban). An empty allow-list is
+     * normalized to `"error"` at resolution, so the rule builder never has to
+     * emit `{ allow: [] }`, which no-console's schema rejects.
+     */
+    console: [string, ...string[]] | "error";
+    trpcGuard: boolean;
+    prismaImportGuard: boolean;
+    typeDefStyle: "interface" | "type";
+    autoImportPaths: string[];
+    autoImportTypeOnly: string[];
+    ignoresTypeAware: string[];
+    testFilePattern: string[];
+    typeAware: boolean;
+}
+/**
+ * Whether type-aware linting is on: gated behind `LINT_TYPEAWARE=true` so the
+ * slower type-aware pass stays opt-in (CI/local override).
+ */
+declare function isTypeAware(): boolean;
+/** Apply the documented option defaults and resolve the type-aware gate. */
+declare function resolveEslintOptions(options?: CreateSidebaseEslintOptions): ResolvedEslintOptions;
+
+/**
+ * Build the streamctl custom-rule flat-config layers from resolved options.
+ * Returned items are appended to the `@antfu/eslint-config` core by
+ * {@link createSidebaseEslint}; exported separately so the option matrix is
+ * unit-testable without resolving the full antfu config.
+ */
+declare function buildEslintLayers(options: ResolvedEslintOptions): TypedFlatConfigItem[];
+
+/**
+ * Build the shared `@sidebase` ESLint flat-config: the `@antfu/eslint-config`
+ * core (Vue + TypeScript, type-aware gated by `LINT_TYPEAWARE`) plus the
+ * org's custom rule layers. Returns the antfu `FlatConfigComposer`, so consumers
+ * chain `.append()`/`.override()`:
+ *
+ * ```ts
+ * // eslint.config.ts
+ * import { createSidebaseEslint } from "@sidebase/base-config/eslint";
+ * export default createSidebaseEslint({ trpcGuard: true })
+ *   .append({ rules: { "vue/multi-word-component-names": "off" } });
+ * ```
+ */
+declare function createSidebaseEslint(options?: CreateSidebaseEslintOptions): ReturnType<typeof antfu>;
+
+export { CreateSidebaseEslintOptions, buildEslintLayers, createSidebaseEslint, isTypeAware, resolveEslintOptions };
+export type { ResolvedEslintOptions };

package/dist/eslint/index.d.ts

@@ -0,0 +1,55 @@
+import { C as CreateSidebaseEslintOptions } from '../shared/base-config.CuUhyvQo.js';
+export { E as ESLINT_OPTION_KEYS } from '../shared/base-config.CuUhyvQo.js';
+import antfu, { TypedFlatConfigItem } from '@antfu/eslint-config';
+
+/** {@link CreateSidebaseEslintOptions} with all defaults applied + the computed type-aware gate. */
+interface ResolvedEslintOptions {
+    zod: "full" | "import-style" | "none";
+    /**
+     * A non-empty allow-list, or `"error"` (hard ban). An empty allow-list is
+     * normalized to `"error"` at resolution, so the rule builder never has to
+     * emit `{ allow: [] }`, which no-console's schema rejects.
+     */
+    console: [string, ...string[]] | "error";
+    trpcGuard: boolean;
+    prismaImportGuard: boolean;
+    typeDefStyle: "interface" | "type";
+    autoImportPaths: string[];
+    autoImportTypeOnly: string[];
+    ignoresTypeAware: string[];
+    testFilePattern: string[];
+    typeAware: boolean;
+}
+/**
+ * Whether type-aware linting is on: gated behind `LINT_TYPEAWARE=true` so the
+ * slower type-aware pass stays opt-in (CI/local override).
+ */
+declare function isTypeAware(): boolean;
+/** Apply the documented option defaults and resolve the type-aware gate. */
+declare function resolveEslintOptions(options?: CreateSidebaseEslintOptions): ResolvedEslintOptions;
+
+/**
+ * Build the streamctl custom-rule flat-config layers from resolved options.
+ * Returned items are appended to the `@antfu/eslint-config` core by
+ * {@link createSidebaseEslint}; exported separately so the option matrix is
+ * unit-testable without resolving the full antfu config.
+ */
+declare function buildEslintLayers(options: ResolvedEslintOptions): TypedFlatConfigItem[];
+
+/**
+ * Build the shared `@sidebase` ESLint flat-config: the `@antfu/eslint-config`
+ * core (Vue + TypeScript, type-aware gated by `LINT_TYPEAWARE`) plus the
+ * org's custom rule layers. Returns the antfu `FlatConfigComposer`, so consumers
+ * chain `.append()`/`.override()`:
+ *
+ * ```ts
+ * // eslint.config.ts
+ * import { createSidebaseEslint } from "@sidebase/base-config/eslint";
+ * export default createSidebaseEslint({ trpcGuard: true })
+ *   .append({ rules: { "vue/multi-word-component-names": "off" } });
+ * ```
+ */
+declare function createSidebaseEslint(options?: CreateSidebaseEslintOptions): ReturnType<typeof antfu>;
+
+export { CreateSidebaseEslintOptions, buildEslintLayers, createSidebaseEslint, isTypeAware, resolveEslintOptions };
+export type { ResolvedEslintOptions };