@ykdz/template 0.0.5 → 0.0.6

package/dist/src/preset-projection.d.ts

@@ -16,6 +16,7 @@ export type PresetPackageAdditionOptions = {
 export type PresetPackageAdditionPlan = {
     readonly packagePath: string;
     readonly workspacePackageGlob: string;
+    readonly workspaceMembershipGlob?: string;
     readonly packageRole: PackageRole;
     readonly packageSourcePreset: PackageSourcePreset;
     readonly sourceRoot: string;

package/dist/src/preset-source.d.ts

@@ -0,0 +1,430 @@
+import type { BuiltInPreset, ValidationResult } from "./declarations.js";
+import { type TemplateDependencyCatalog } from "./dependency-catalog.js";
+import { type PresetProjectionDeclaration } from "./projection-capabilities.js";
+export type PresetSourceManifestPresetSource = {
+    roots: string[];
+    files: string[];
+    sharedResources: string[];
+};
+export type PresetSourceManifestPreset = BuiltInPreset & {
+    dependencyCatalog?: string[];
+    projection?: PresetProjectionDeclaration;
+    source?: PresetSourceManifestPresetSource;
+};
+export type PresetSourceManifestSharedResource = {
+    id: string;
+    path: string;
+};
+export type PresetSourceFixtureMatrixPresetSupport = {
+    preset: string;
+};
+export type PresetSourceFixtureMatrixPackageAdditionSupport = {
+    preset: string;
+    packageLeafName: string;
+};
+export type PresetSourceFixtureMatrixCombination = {
+    basePreset: string;
+    addedPreset: string;
+    linkFrom?: string[];
+};
+export type PresetSourceFixtureMatrixSemanticSkip = {
+    basePreset: string;
+    addedPreset: string;
+    reason: string;
+};
+export type PresetSourceFixtureMatrixContract = {
+    initSupport: PresetSourceFixtureMatrixPresetSupport[];
+    packageAdditionSupport: PresetSourceFixtureMatrixPackageAdditionSupport[];
+    supportedCombinations: PresetSourceFixtureMatrixCombination[];
+    semanticSkips: PresetSourceFixtureMatrixSemanticSkip[];
+    checkRequirements: string[];
+    environmentPreparation: string[];
+};
+export type PresetSourceManifest = {
+    schemaVersion: 1;
+    name: string;
+    sharedResources: PresetSourceManifestSharedResource[];
+    fixtureMatrix?: PresetSourceFixtureMatrixContract;
+    presets: PresetSourceManifestPreset[];
+};
+export type PresetSourceManifestValidationOptions = {
+    readonly sourceRoot?: string;
+    readonly dependencyCatalog?: TemplateDependencyCatalog;
+};
+export declare const presetSourceManifestJsonSchema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://ykdz.dev/schemas/template/preset-source-manifest.schema.json";
+    readonly title: "Preset Source Manifest";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["schemaVersion", "name", "presets"];
+    readonly properties: {
+        readonly schemaVersion: {
+            readonly const: 1;
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+        readonly sharedResources: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "path"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly path: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                };
+            };
+        };
+        readonly fixtureMatrix: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["initSupport", "packageAdditionSupport", "supportedCombinations", "semanticSkips", "checkRequirements", "environmentPreparation"];
+            readonly properties: {
+                readonly initSupport: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["preset"];
+                        readonly properties: {
+                            readonly preset: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    };
+                };
+                readonly packageAdditionSupport: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["preset", "packageLeafName"];
+                        readonly properties: {
+                            readonly preset: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly packageLeafName: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                                readonly pattern: "^[a-z0-9][a-z0-9-]*$";
+                            };
+                        };
+                    };
+                };
+                readonly supportedCombinations: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["basePreset", "addedPreset"];
+                        readonly properties: {
+                            readonly basePreset: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly addedPreset: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly linkFrom: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                    readonly minLength: 1;
+                                };
+                            };
+                        };
+                    };
+                };
+                readonly semanticSkips: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["basePreset", "addedPreset", "reason"];
+                        readonly properties: {
+                            readonly basePreset: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly addedPreset: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly reason: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    };
+                };
+                readonly checkRequirements: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly enum: readonly ["machine-verifiable-next-steps", "root-check-ci"];
+                    };
+                    readonly uniqueItems: true;
+                };
+                readonly environmentPreparation: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly enum: readonly ["playwright-browser-assets"];
+                    };
+                    readonly uniqueItems: true;
+                };
+            };
+        };
+        readonly presets: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["name", "title", "description", "generation", "supportedPackageManagers", "supportedProjectKinds", "packageAdditionSupport", "features"];
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly title: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly generation: {
+                        readonly enum: readonly ["supported", "future"];
+                    };
+                    readonly supportedPackageManagers: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly enum: readonly ["pnpm"];
+                        };
+                        readonly uniqueItems: true;
+                    };
+                    readonly supportedProjectKinds: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly items: {
+                            readonly enum: readonly ["multi-package"];
+                        };
+                        readonly uniqueItems: true;
+                    };
+                    readonly packageAdditionSupport: {
+                        readonly enum: readonly ["supported", "unsupported"];
+                    };
+                    readonly features: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly enum: ("devcontainer" | "oxc-format-lint" | "cargo-test" | "github-actions" | "dependabot" | "pnpm-catalog" | "strict-typescript" | "root-check" | "fix-command" | "rustfmt-clippy" | "native-binary-release")[];
+                        };
+                        readonly uniqueItems: true;
+                    };
+                    readonly dependencyCatalog: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                        readonly uniqueItems: true;
+                    };
+                    readonly projection: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["capabilities"];
+                        readonly properties: {
+                            readonly capabilities: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly required: readonly ["kind", "workspacePackageGlob", "packageRole", "packageSourcePreset", "sourceFiles"];
+                                        readonly properties: {
+                                            readonly kind: {
+                                                readonly const: "workspace-library-package";
+                                            };
+                                            readonly workspacePackageGlob: {
+                                                readonly const: "packages/*";
+                                            };
+                                            readonly packageRole: {
+                                                readonly const: "shared-library";
+                                            };
+                                            readonly packageSourcePreset: {
+                                                readonly const: "ts-lib";
+                                            };
+                                            readonly sourceFiles: {
+                                                readonly type: "array";
+                                                readonly minItems: 1;
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                    readonly minLength: 1;
+                                                };
+                                            };
+                                        };
+                                    }, {
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly required: readonly ["kind", "workspacePackageGlob", "packages"];
+                                        readonly properties: {
+                                            readonly kind: {
+                                                readonly const: "workspace-node-packages";
+                                            };
+                                            readonly workspacePackageGlob: {
+                                                readonly const: "apps/*";
+                                            };
+                                            readonly packages: {
+                                                readonly type: "array";
+                                                readonly minItems: 1;
+                                                readonly items: {
+                                                    readonly type: "object";
+                                                    readonly additionalProperties: false;
+                                                    readonly required: readonly ["kind", "path", "sourceFiles"];
+                                                    readonly properties: {
+                                                        readonly kind: {
+                                                            readonly enum: readonly ["hono-api", "vue-app"];
+                                                        };
+                                                        readonly path: {
+                                                            readonly enum: readonly ["apps/api", "apps/web"];
+                                                        };
+                                                        readonly sourceFiles: {
+                                                            readonly type: "array";
+                                                            readonly minItems: 1;
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                                readonly minLength: 1;
+                                                            };
+                                                        };
+                                                    };
+                                                };
+                                            };
+                                            readonly packageLinks: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "object";
+                                                    readonly additionalProperties: false;
+                                                    readonly required: readonly ["consumerPackagePath", "providerPackagePath"];
+                                                    readonly properties: {
+                                                        readonly consumerPackagePath: {
+                                                            readonly const: "apps/web";
+                                                        };
+                                                        readonly providerPackagePath: {
+                                                            readonly const: "apps/api";
+                                                        };
+                                                    };
+                                                };
+                                            };
+                                        };
+                                    }, {
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly required: readonly ["kind", "workspacePackageGlob", "sourceFiles"];
+                                        readonly properties: {
+                                            readonly kind: {
+                                                readonly const: "rust-binary-workspace";
+                                            };
+                                            readonly workspacePackageGlob: {
+                                                readonly const: "packages/*";
+                                            };
+                                            readonly sourceFiles: {
+                                                readonly type: "array";
+                                                readonly minItems: 1;
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                    readonly minLength: 1;
+                                                };
+                                            };
+                                        };
+                                    }, {
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly required: readonly ["kind"];
+                                        readonly properties: {
+                                            readonly kind: {
+                                                readonly const: "strict-typescript-root";
+                                            };
+                                        };
+                                    }, {
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly required: readonly ["kind"];
+                                        readonly properties: {
+                                            readonly kind: {
+                                                readonly const: "oxc-format-lint";
+                                            };
+                                        };
+                                    }, {
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly required: readonly ["kind"];
+                                        readonly properties: {
+                                            readonly kind: {
+                                                readonly const: "node-pnpm-devcontainer";
+                                            };
+                                        };
+                                    }, {
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly required: readonly ["kind"];
+                                        readonly properties: {
+                                            readonly kind: {
+                                                readonly const: "github-maintenance";
+                                            };
+                                        };
+                                    }];
+                                };
+                            };
+                        };
+                    };
+                    readonly source: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly roots: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                    readonly minLength: 1;
+                                };
+                            };
+                            readonly files: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                    readonly minLength: 1;
+                                };
+                            };
+                            readonly sharedResources: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                    readonly minLength: 1;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+};
+export declare function validatePresetSourceManifest(input: unknown, options?: PresetSourceManifestValidationOptions): ValidationResult<PresetSourceManifest>;
+export declare function validateBuiltInPresetSourceManifest(input: unknown, options?: PresetSourceManifestValidationOptions): ValidationResult<PresetSourceManifest>;
+export declare function manifestReferencedSourceFiles(manifest: PresetSourceManifest, sourceRoot: string): string[];
+export declare function loadPresetSourceManifestFile(filePath: string): PresetSourceManifest;
+export declare function loadBuiltInPresetSourceManifest(): PresetSourceManifest;
+export declare function findPresetSourceManifestPreset(manifest: PresetSourceManifest, presetName: string): PresetSourceManifestPreset | undefined;
+export declare function findBuiltInPresetSourceManifestPreset(presetName: string): PresetSourceManifestPreset | undefined;