@stencil/cli 5.0.0-alpha.5 → 5.0.0-alpha.7

package/dist/index.d.mts

@@ -1,11 +1,11 @@
-import * as _$_stencil_core_compiler0 from "@stencil/core/compiler";
+import * as d from "@stencil/core/compiler";
 import { LogLevel } from "@stencil/core/compiler";
 
 //#region src/types.d.ts
 /**
  * Supported CLI task commands
  */
-type TaskCommand = 'build' | 'docs' | 'generate' | 'g' | 'help' | 'info' | 'migrate' | 'prerender' | 'serve' | 'telemetry' | 'test' | 'version';
+type TaskCommand = 'build' | 'docs' | 'generate' | 'g' | 'help' | 'info' | 'init' | 'migrate' | 'prerender' | 'serve' | 'telemetry' | 'test' | 'version';
 //#endregion
 //#region src/config-flags.d.ts
 /**
@@ -123,7 +123,7 @@ declare const createConfigFlags: (init?: Partial<ConfigFlags>) => ConfigFlags;
 declare const parseFlags: (args: string[]) => ConfigFlags;
 //#endregion
 //#region src/load-compiler.d.ts
-type CoreCompiler = typeof _$_stencil_core_compiler0;
+type CoreCompiler = typeof import('@stencil/core/compiler');
 //#endregion
 //#region src/run.d.ts
 /**
@@ -136,7 +136,7 @@ type CoreCompiler = typeof _$_stencil_core_compiler0;
  * @param init initial CLI options
  * @returns an empty promise
  */
-declare const run: (init: _$_stencil_core_compiler0.CliInitOptions) => Promise<any>;
+declare const run: (init: d.CliInitOptions) => Promise<any>;
 /**
  * Run a specified task
  *
@@ -148,6 +148,97 @@ declare const run: (init: _$_stencil_core_compiler0.CliInitOptions) => Promise<a
  * @public
  * @returns a void promise
  */
-declare const runTask: (coreCompiler: CoreCompiler, config: _$_stencil_core_compiler0.Config, task: TaskCommand, sys: _$_stencil_core_compiler0.CompilerSystem, flags?: ConfigFlags) => Promise<void>;
+declare const runTask: (coreCompiler: CoreCompiler, config: d.Config, task: TaskCommand, sys: d.CompilerSystem, flags?: ConfigFlags) => Promise<void>;
 //#endregion
-export { BOOLEAN_CLI_FLAGS, type ConfigFlags, type TaskCommand, createConfigFlags, parseFlags, run, runTask };
+//#region src/wizard/types.d.ts
+/**
+ * Context passed to wizard steps at runtime.
+ */
+interface WizardContext {
+  /** Absolute path to the project root directory. */
+  rootDir: string;
+  /** True when `stencil.config.ts` did not previously exist (fresh scaffold). */
+  isNewProject: boolean;
+}
+/**
+ * A single file a plugin can offer during `stencil generate`.
+ */
+interface WizardFileTemplate {
+  /** Label shown in the generate prompt checkbox, e.g. `"Spec Test (.spec.tsx)"`. */
+  label: string;
+  /**
+   * File extension used to derive the filename and deduplicate contributions,
+   * e.g. `"spec.tsx"` or `"e2e.ts"`.
+   */
+  extension: string;
+  /**
+   * Subdirectory within the component directory where the file is placed.
+   * e.g. `'test'` to place alongside other test files. Omit for the component root.
+   */
+  subdirectory?: string;
+  /**
+   * Returns the file content. `className` is the PascalCase form of `tagName`.
+   */
+  template: (tagName: string, className: string) => string;
+  /** Pre-selected in the generate prompt. Defaults to `true`. */
+  selectedByDefault?: boolean;
+}
+/**
+ * Contribution a package can make to `stencil generate`.
+ */
+interface WizardGenerateContribution {
+  /**
+   * Files this plugin can generate alongside the component.
+   * Each entry appears as a checkbox in the generate prompt.
+   * A single plugin may contribute multiple entries (e.g. a vitest setup
+   * with several project configs, each producing a differently-scoped test file).
+   */
+  fileTemplates?: ReadonlyArray<WizardFileTemplate>;
+  /**
+   * Additional style extensions this package supports (e.g. `['sass', 'scss']`
+   * from `@stencil/sass`). The first entry is used as the default.
+   */
+  styleExtensions?: ReadonlyArray<string>;
+}
+/**
+ * Contribution a package can make to `stencil init`.
+ *
+ * The plugin owns its entire setup: prompts, peer dep installs, config file
+ * generation, example files, package.json script updates, etc.
+ */
+interface WizardInitContribution {
+  /** Stable identifier used to deduplicate across re-runs. */
+  id: string;
+  /** Human-readable name shown in the prompt list. */
+  displayName: string;
+  /** One-line description shown alongside the name. */
+  description: string;
+  /**
+   * Called by the CLI after packages are installed. The plugin is responsible
+   * for all further setup: additional prompts, peer dep installs, config file
+   * writes, example tests, `.gitignore` and `package.json` script updates, etc.
+   */
+  run: (context: WizardContext) => Promise<void>;
+}
+/**
+ * Interface a package exports to participate in `stencil init` and/or
+ * `stencil generate`.
+ *
+ * Declare the entry point in `package.json`:
+ * ```json
+ * { "stencil": { "wizard": "./dist/wizard.js" } }
+ * ```
+ *
+ * Export a named `wizard` constant from that module:
+ * ```ts
+ * export const wizard: StencilWizardPlugin = { ... };
+ * ```
+ */
+interface StencilWizardPlugin {
+  /** Contributions to `stencil generate`. */
+  generate?: WizardGenerateContribution;
+  /** Contributions to `stencil init`. */
+  init?: WizardInitContribution;
+}
+//#endregion
+export { BOOLEAN_CLI_FLAGS, type ConfigFlags, type StencilWizardPlugin, type TaskCommand, type WizardContext, type WizardFileTemplate, type WizardGenerateContribution, type WizardInitContribution, createConfigFlags, parseFlags, run, runTask };