@pantoken/scaffold 1.1.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,9 +1,5 @@
1
- import { Preset } from "@pantoken/scaffold-base";
2
- //#region generated/preset-ledger.d.ts
3
- /**
4
- * Registry of all available pantoken scaffold presets, keyed by platform name.
5
- */
6
- declare const PRESET_LEDGER: Record<string, Preset>;
1
+ //#region generated/scaffolds.d.ts
2
+ declare const SCAFFOLDS: Record<string, Record<string, string>>;
7
3
  //#endregion
8
4
  //#region src/theme.d.ts
9
5
  /** A pantoken token theme variant. */
@@ -26,11 +22,19 @@ declare function validateThemeVariant(value: string): ThemeVariant;
26
22
  declare function validateThemeMode(value: string): ThemeMode;
27
23
  //#endregion
28
24
  //#region src/index.d.ts
25
+ /** Package managers whose commands can be reflected in scaffolded project files. */
26
+ type ScaffoldPackageManager = "npm" | "pnpm" | "yarn" | "bun" | "deno" | "vp";
27
+ interface ScaffoldProjectOptions {
28
+ theme?: ThemeVariant;
29
+ mode?: ThemeMode;
30
+ cdn?: string;
31
+ locale?: string;
32
+ packageManager?: ScaffoldPackageManager;
33
+ }
29
34
  /**
30
- * A platform pantoken can scaffold a starter project for — either preset-ledger-backed (Bingo)
31
- * or a legacy template-only entry (e.g. `canvas-theme-editor`) with no preset yet.
35
+ * A platform pantoken can scaffold a starter project for.
32
36
  */
33
- type ScaffoldPlatform = keyof typeof PRESET_LEDGER;
37
+ type ScaffoldPlatform = keyof typeof SCAFFOLDS;
34
38
  /**
35
39
  * Every scaffoldable platform key (discovered from available presets, plus any legacy
36
40
  * template-only platforms not yet backed by a preset).
@@ -62,7 +66,8 @@ declare function resolveScaffoldPlatform(platform: string): ScaffoldPlatform;
62
66
  * @param options - `theme`/`mode` select which `@pantoken/css` token sheet scaffolded files
63
67
  * import (default `"rebrand"`/`"light"`), applied across every platform. `cdn` selects the CDN
64
68
  * provider `canvas-theme-editor`'s `theme.css`/`theme.js` are built for (default jsDelivr);
65
- * ignored by every other platform.
69
+ * ignored by every other platform. `locale` (default `"en"`) sets the generated markup's
70
+ * `lang`/`dir` attributes.
66
71
  * @returns The paths written.
67
72
  *
68
73
  * @example Scaffold a React starter
@@ -70,13 +75,9 @@ declare function resolveScaffoldPlatform(platform: string): ScaffoldPlatform;
70
75
  * import { scaffoldProject } from "@pantoken/scaffold";
71
76
  *
72
77
  * scaffoldProject("react", "./my-app");
73
- * scaffoldProject("vue", "./my-vue-app", { theme: "canvas" });
78
+ * scaffoldProject("vue", "./my-vue-app", { theme: "canvas", locale: "hu" });
74
79
  * ```
75
80
  */
76
- declare function scaffoldProject(platform: string, dir?: string, options?: {
77
- theme?: ThemeVariant;
78
- mode?: ThemeMode;
79
- cdn?: string;
80
- }): Promise<string[]>;
81
+ declare function scaffoldProject(platform: string, dir?: string, options?: ScaffoldProjectOptions): Promise<string[]>;
81
82
  //#endregion
82
- export { scaffoldProject as a, themeStylesheetImport as c, resolveScaffoldPlatform as i, validateThemeMode as l, ScaffoldPlatform as n, ThemeMode as o, isScaffoldPlatform as r, ThemeVariant as s, SCAFFOLD_PLATFORMS as t, validateThemeVariant as u };
83
+ export { resolveScaffoldPlatform as a, ThemeVariant as c, validateThemeVariant as d, isScaffoldPlatform as i, themeStylesheetImport as l, ScaffoldPackageManager as n, scaffoldProject as o, ScaffoldPlatform as r, ThemeMode as s, SCAFFOLD_PLATFORMS as t, validateThemeMode as u };
package/dist/index.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- import { a as scaffoldProject, c as themeStylesheetImport, i as resolveScaffoldPlatform, l as validateThemeMode, n as ScaffoldPlatform, o as ThemeMode, r as isScaffoldPlatform, s as ThemeVariant, t as SCAFFOLD_PLATFORMS, u as validateThemeVariant } from "./index-CyolWk0E.mjs";
2
- export { SCAFFOLD_PLATFORMS, ScaffoldPlatform, type ThemeMode, type ThemeVariant, isScaffoldPlatform, resolveScaffoldPlatform, scaffoldProject, themeStylesheetImport, validateThemeMode, validateThemeVariant };
1
+ import { a as resolveScaffoldPlatform, c as ThemeVariant, d as validateThemeVariant, i as isScaffoldPlatform, l as themeStylesheetImport, n as ScaffoldPackageManager, o as scaffoldProject, r as ScaffoldPlatform, s as ThemeMode, t as SCAFFOLD_PLATFORMS, u as validateThemeMode } from "./index-BloHpRKt.mjs";
2
+ export { SCAFFOLD_PLATFORMS, ScaffoldPackageManager, ScaffoldPlatform, type ThemeMode, type ThemeVariant, isScaffoldPlatform, resolveScaffoldPlatform, scaffoldProject, themeStylesheetImport, validateThemeMode, validateThemeVariant };
package/dist/index.mjs CHANGED
@@ -1,2 +1,2 @@
1
- import { a as themeStylesheetImport, i as scaffoldProject, n as isScaffoldPlatform, o as validateThemeMode, r as resolveScaffoldPlatform, s as validateThemeVariant, t as SCAFFOLD_PLATFORMS } from "./src-CdZxIoo2.mjs";
1
+ import { a as themeStylesheetImport, i as scaffoldProject, n as isScaffoldPlatform, o as validateThemeMode, r as resolveScaffoldPlatform, s as validateThemeVariant, t as SCAFFOLD_PLATFORMS } from "./src-BTDVd_Xe.mjs";
2
2
  export { SCAFFOLD_PLATFORMS, isScaffoldPlatform, resolveScaffoldPlatform, scaffoldProject, themeStylesheetImport, validateThemeMode, validateThemeVariant };