@zhama/tego-plugin-sdk 1.36.2 → 1.37.0

package/dist/scaffold.d.cts

@@ -1,17 +1,3 @@
-/**
- * The files a new plugin starts with (`pnpm plugin:new` in this repository,
- * `tego-plugin create` anywhere else), as pure data.
- *
- * Kept apart from the interactive generator (`turbo/generators/config.ts`) so
- * the same builder can be exercised without a TTY: a test — or a one-off
- * script — calls `buildPluginFiles(answers)` and asserts on the tree, where the
- * interactive generator can only be driven by a real terminal.
- *
- * Everything here is faithful to what the upload validator (`@tego/plugin-sdk`
- * manifest schema + the server's `prepare-plugin-package`) accepts, because a
- * scaffold that produces a package the platform then rejects is worse than no
- * scaffold: the author learns the rules by hitting them one at a time.
- */
 type PluginPart = 'frontend' | 'backend' | 'claw';
 interface PluginAnswers {
     /** kebab-case id, e.g. `tego-notes`. */
@@ -25,7 +11,17 @@ interface PluginAnswers {
     scope: 'avatar' | 'tenant';
     /** Caret range for the current host, e.g. `^1.5.0`. */
     hostApiRange: string;
+    /**
+     * `standard` (what `tego-plugin create` writes): the patterns the mature
+     * plugins use — access catalog with one policy per route, Tailwind scoping,
+     * API errors with codes, an error boundary, live updates, locale and route
+     * tests. `minimal`: one page and one route, for starting from nothing.
+     * Omitted means `minimal`, so existing callers keep their output.
+     */
+    template?: PluginTemplate;
 }
+type PluginTemplate = 'standard' | 'minimal';
+declare const PLUGIN_TEMPLATES: readonly PluginTemplate[];
 /**
  * Where the SDK packages come from.
  *
@@ -45,6 +41,27 @@ interface BuildPluginFilesOptions {
  * `plugin-files.test.ts` fails if the two disagree.
  */
 declare const PUBLISHED_SDK_PACKAGES: Record<string, string>;
+/**
+ * The repository's Prettier settings (root `.prettierrc`), which the lint
+ * config enforces through `prettier/prettier`. A standalone
+ * repository has no root to inherit them from. The Tailwind class-sorting
+ * plugin is left out: it is one more dependency, and only reorders classes.
+ */
+declare const STANDALONE_PRETTIER: {
+    readonly semi: true;
+    readonly trailingComma: "es5";
+    readonly singleQuote: true;
+    readonly printWidth: 80;
+    readonly tabWidth: 2;
+    readonly useTabs: false;
+    readonly bracketSpacing: true;
+    readonly bracketSameLine: false;
+    readonly arrowParens: "avoid";
+    readonly endOfLine: "lf";
+    readonly quoteProps: "as-needed";
+    readonly jsxSingleQuote: true;
+    readonly proseWrap: "preserve";
+};
 /**
  * The TypeScript presets of `@tego/tsconfig` (packages/tsconfig), copied into a
  * standalone plugin's root instead of published as a package: they only drive
@@ -158,10 +175,17 @@ declare function writePlugin(repoRoot: string, answers: PluginAnswers): {
  * packages come from npm instead of this workspace. Same refusal rule as
  * {@link writePlugin}.
  */
-declare function writeStandalonePlugin(parentDirectory: string, answers: PluginAnswers): {
+declare function writeStandalonePlugin(parentDirectory: string, answers: PluginAnswers): Promise<{
     directory: string;
     files: string[];
-};
+}>;
+/**
+ * The files as Prettier writes them with the plugin's own settings, so a new
+ * plugin passes its `lint` gate (which enforces Prettier) from the first run.
+ * Done here rather than in the templates: where Prettier breaks a line depends
+ * on the plugin id's length.
+ */
+declare function formatPluginFiles(files: GeneratedFile[]): Promise<GeneratedFile[]>;
 /** What `tego-plugin create` prints on success. */
 interface CreatePluginResult {
     directory: string;
@@ -177,6 +201,6 @@ interface CreatePluginResult {
 declare function createStandalonePlugin(input: string, options: {
     parent: string;
     cwd: string;
-}): CreatePluginResult;
+}): Promise<CreatePluginResult>;
 
-export { type BuildPluginFilesOptions, type CreatePluginResult, type DependencySource, type GeneratedFile, PLUGIN_ID_HINT, PLUGIN_ID_PATTERN, PLUGIN_PARTS, PLUGIN_SCOPES, PUBLISHED_SDK_PACKAGES, type PluginAnswers, type PluginPart, STANDALONE_TSCONFIG_FILES, buildPluginFiles, createStandalonePlugin, packageNameFor, validatePluginAnswers, writePlugin, writeStandalonePlugin };
+export { type BuildPluginFilesOptions, type CreatePluginResult, type DependencySource, type GeneratedFile, PLUGIN_ID_HINT, PLUGIN_ID_PATTERN, PLUGIN_PARTS, PLUGIN_SCOPES, PLUGIN_TEMPLATES, PUBLISHED_SDK_PACKAGES, type PluginAnswers, type PluginPart, type PluginTemplate, STANDALONE_PRETTIER, STANDALONE_TSCONFIG_FILES, buildPluginFiles, createStandalonePlugin, formatPluginFiles, packageNameFor, validatePluginAnswers, writePlugin, writeStandalonePlugin };

package/dist/scaffold.d.ts

@@ -1,17 +1,3 @@
-/**
- * The files a new plugin starts with (`pnpm plugin:new` in this repository,
- * `tego-plugin create` anywhere else), as pure data.
- *
- * Kept apart from the interactive generator (`turbo/generators/config.ts`) so
- * the same builder can be exercised without a TTY: a test — or a one-off
- * script — calls `buildPluginFiles(answers)` and asserts on the tree, where the
- * interactive generator can only be driven by a real terminal.
- *
- * Everything here is faithful to what the upload validator (`@tego/plugin-sdk`
- * manifest schema + the server's `prepare-plugin-package`) accepts, because a
- * scaffold that produces a package the platform then rejects is worse than no
- * scaffold: the author learns the rules by hitting them one at a time.
- */
 type PluginPart = 'frontend' | 'backend' | 'claw';
 interface PluginAnswers {
     /** kebab-case id, e.g. `tego-notes`. */
@@ -25,7 +11,17 @@ interface PluginAnswers {
     scope: 'avatar' | 'tenant';
     /** Caret range for the current host, e.g. `^1.5.0`. */
     hostApiRange: string;
+    /**
+     * `standard` (what `tego-plugin create` writes): the patterns the mature
+     * plugins use — access catalog with one policy per route, Tailwind scoping,
+     * API errors with codes, an error boundary, live updates, locale and route
+     * tests. `minimal`: one page and one route, for starting from nothing.
+     * Omitted means `minimal`, so existing callers keep their output.
+     */
+    template?: PluginTemplate;
 }
+type PluginTemplate = 'standard' | 'minimal';
+declare const PLUGIN_TEMPLATES: readonly PluginTemplate[];
 /**
  * Where the SDK packages come from.
  *
@@ -45,6 +41,27 @@ interface BuildPluginFilesOptions {
  * `plugin-files.test.ts` fails if the two disagree.
  */
 declare const PUBLISHED_SDK_PACKAGES: Record<string, string>;
+/**
+ * The repository's Prettier settings (root `.prettierrc`), which the lint
+ * config enforces through `prettier/prettier`. A standalone
+ * repository has no root to inherit them from. The Tailwind class-sorting
+ * plugin is left out: it is one more dependency, and only reorders classes.
+ */
+declare const STANDALONE_PRETTIER: {
+    readonly semi: true;
+    readonly trailingComma: "es5";
+    readonly singleQuote: true;
+    readonly printWidth: 80;
+    readonly tabWidth: 2;
+    readonly useTabs: false;
+    readonly bracketSpacing: true;
+    readonly bracketSameLine: false;
+    readonly arrowParens: "avoid";
+    readonly endOfLine: "lf";
+    readonly quoteProps: "as-needed";
+    readonly jsxSingleQuote: true;
+    readonly proseWrap: "preserve";
+};
 /**
  * The TypeScript presets of `@tego/tsconfig` (packages/tsconfig), copied into a
  * standalone plugin's root instead of published as a package: they only drive
@@ -158,10 +175,17 @@ declare function writePlugin(repoRoot: string, answers: PluginAnswers): {
  * packages come from npm instead of this workspace. Same refusal rule as
  * {@link writePlugin}.
  */
-declare function writeStandalonePlugin(parentDirectory: string, answers: PluginAnswers): {
+declare function writeStandalonePlugin(parentDirectory: string, answers: PluginAnswers): Promise<{
     directory: string;
     files: string[];
-};
+}>;
+/**
+ * The files as Prettier writes them with the plugin's own settings, so a new
+ * plugin passes its `lint` gate (which enforces Prettier) from the first run.
+ * Done here rather than in the templates: where Prettier breaks a line depends
+ * on the plugin id's length.
+ */
+declare function formatPluginFiles(files: GeneratedFile[]): Promise<GeneratedFile[]>;
 /** What `tego-plugin create` prints on success. */
 interface CreatePluginResult {
     directory: string;
@@ -177,6 +201,6 @@ interface CreatePluginResult {
 declare function createStandalonePlugin(input: string, options: {
     parent: string;
     cwd: string;
-}): CreatePluginResult;
+}): Promise<CreatePluginResult>;
 
-export { type BuildPluginFilesOptions, type CreatePluginResult, type DependencySource, type GeneratedFile, PLUGIN_ID_HINT, PLUGIN_ID_PATTERN, PLUGIN_PARTS, PLUGIN_SCOPES, PUBLISHED_SDK_PACKAGES, type PluginAnswers, type PluginPart, STANDALONE_TSCONFIG_FILES, buildPluginFiles, createStandalonePlugin, packageNameFor, validatePluginAnswers, writePlugin, writeStandalonePlugin };
+export { type BuildPluginFilesOptions, type CreatePluginResult, type DependencySource, type GeneratedFile, PLUGIN_ID_HINT, PLUGIN_ID_PATTERN, PLUGIN_PARTS, PLUGIN_SCOPES, PLUGIN_TEMPLATES, PUBLISHED_SDK_PACKAGES, type PluginAnswers, type PluginPart, type PluginTemplate, STANDALONE_PRETTIER, STANDALONE_TSCONFIG_FILES, buildPluginFiles, createStandalonePlugin, formatPluginFiles, packageNameFor, validatePluginAnswers, writePlugin, writeStandalonePlugin };