@savvy-web/templates 0.1.3 → 0.1.4

package/index.d.ts

@@ -6,6 +6,8 @@ import { Schema } from "effect";
  *
  * Templates produce content with a logical name and suggested filename.
  * The consumer decides where (and whether) to write the content.
+ *
+ * @public
  */
 interface TemplateEntry {
   /** Logical name for this entry (e.g., "tsconfig", "biome", "vscode-settings") */
@@ -15,21 +17,51 @@ interface TemplateEntry {
   /** The generated file content */
   readonly content: string;
 }
-/** A template: typed options in, content entries out. */
+/**
+ * A template: typed options in, content entries out.
+ *
+ * @public
+ */
 type Template<O> = (options: O) => TemplateEntry[];
-/** An update template: existing content + partial options in, content entries out. */
+/**
+ * An update template: existing content + partial options in, content entries out.
+ *
+ * @public
+ */
 type UpdateTemplate<O> = (existing: string, options: Partial<O>) => TemplateEntry[];
 //#endregion
 //#region src/lib/biome/index.d.ts
+/**
+ * Options for generating a Biome configuration file.
+ *
+ * @public
+ */
 declare const BiomeOptions: Schema.Struct<{
   version: typeof Schema.String;
   extends: Schema.optional<Schema.Array$<typeof Schema.String>>;
   root: Schema.optional<typeof Schema.Boolean>;
 }>;
+/**
+ * The decoded type of {@link BiomeOptions}.
+ *
+ * @public
+ */
 type BiomeOptionsType = typeof BiomeOptions.Type;
+/**
+ * Generates a `biome.jsonc` configuration file entry.
+ *
+ * @param options - the Biome configuration options
+ * @returns an array containing the generated `biome.jsonc` entry
+ * @public
+ */
 declare function createBiome(options: unknown): TemplateEntry[];
 //#endregion
 //#region src/lib/changeset/index.d.ts
+/**
+ * Options for generating a Changesets configuration file.
+ *
+ * @public
+ */
 declare const ChangesetOptions: Schema.Struct<{
   access: Schema.optionalWith<Schema.Literal<["public", "restricted"]>, {
     default: () => "restricted";
@@ -42,10 +74,27 @@ declare const ChangesetOptions: Schema.Struct<{
   }>;
   repo: Schema.optional<Schema.filter<typeof Schema.String>>;
 }>;
+/**
+ * The decoded type of {@link ChangesetOptions}.
+ *
+ * @public
+ */
 type ChangesetOptionsType = typeof ChangesetOptions.Type;
+/**
+ * Generates a `.changeset/config.json` configuration file entry.
+ *
+ * @param options - the Changesets configuration options
+ * @returns an array containing the generated changeset config entry
+ * @public
+ */
 declare function createChangeset(options: unknown): TemplateEntry[];
 //#endregion
 //#region src/lib/gitignore/index.d.ts
+/**
+ * Options for generating a `.gitignore` file.
+ *
+ * @public
+ */
 declare const GitignoreOptions: Schema.Struct<{
   sections: Schema.optional<Schema.Struct<{
     node: Schema.optional<typeof Schema.Boolean>;
@@ -56,10 +105,27 @@ declare const GitignoreOptions: Schema.Struct<{
   }>>;
   additional: Schema.optional<Schema.Array$<typeof Schema.String>>;
 }>;
+/**
+ * The decoded type of {@link GitignoreOptions}.
+ *
+ * @public
+ */
 type GitignoreOptionsType = typeof GitignoreOptions.Type;
+/**
+ * Generates a `.gitignore` file entry.
+ *
+ * @param options - the gitignore configuration options
+ * @returns an array containing the generated `.gitignore` entry
+ * @public
+ */
 declare function createGitignore(options: unknown): TemplateEntry[];
 //#endregion
 //#region src/lib/package-json/index.d.ts
+/**
+ * Options for generating a `package.json` file.
+ *
+ * @public
+ */
 declare const PackageJsonOptions: Schema.Struct<{
   name: typeof Schema.String;
   version: Schema.optionalWith<typeof Schema.String, {
@@ -103,28 +169,79 @@ declare const PackageJsonOptions: Schema.Struct<{
   }>>;
   keywords: Schema.optional<Schema.Array$<typeof Schema.String>>;
 }>;
+/**
+ * The decoded type of {@link PackageJsonOptions}.
+ *
+ * @public
+ */
 type PackageJsonOptionsType = typeof PackageJsonOptions.Type;
+/**
+ * Generates a sorted `package.json` file entry.
+ *
+ * @param options - the package.json configuration options
+ * @returns an array containing the generated `package.json` entry
+ * @public
+ */
 declare function createPackageJson(options: unknown): TemplateEntry[];
 //#endregion
 //#region src/lib/pnpm/index.d.ts
+/**
+ * Options for generating a `pnpm-workspace.yaml` file.
+ *
+ * @public
+ */
 declare const PnpmWorkspaceOptions: Schema.Struct<{
   packages: Schema.Array$<typeof Schema.String>;
   autoInstallPeers: Schema.optional<typeof Schema.Boolean>;
   catalogMode: Schema.optional<Schema.Literal<["strict", "prefer", "manual"]>>;
   catalog: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.String>>;
 }>;
+/**
+ * The decoded type of {@link PnpmWorkspaceOptions}.
+ *
+ * @public
+ */
 type PnpmWorkspaceOptionsType = typeof PnpmWorkspaceOptions.Type;
+/**
+ * Generates a `pnpm-workspace.yaml` file entry.
+ *
+ * @param options - the pnpm workspace configuration options
+ * @returns an array containing the generated `pnpm-workspace.yaml` entry
+ * @public
+ */
 declare function createPnpmWorkspace(options: unknown): TemplateEntry[];
 //#endregion
 //#region src/lib/readme/index.d.ts
+/**
+ * Options for generating a `README.md` file.
+ *
+ * @public
+ */
 declare const ReadmeOptions: Schema.Struct<{
   name: typeof Schema.String;
   description: Schema.optional<typeof Schema.String>;
 }>;
+/**
+ * The decoded type of {@link ReadmeOptions}.
+ *
+ * @public
+ */
 type ReadmeOptionsType = typeof ReadmeOptions.Type;
+/**
+ * Generates a `README.md` file entry.
+ *
+ * @param options - the README configuration options
+ * @returns an array containing the generated `README.md` entry
+ * @public
+ */
 declare function createReadme(options: unknown): TemplateEntry[];
 //#endregion
 //#region src/lib/tsconfig/index.d.ts
+/**
+ * Options for generating a `tsconfig.json` file.
+ *
+ * @public
+ */
 declare const TsConfigOptions: Schema.Struct<{
   extends: Schema.optional<Schema.Union<[typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
   composite: Schema.optional<typeof Schema.Boolean>;
@@ -134,10 +251,27 @@ declare const TsConfigOptions: Schema.Struct<{
     path: typeof Schema.String;
   }>>>;
 }>;
+/**
+ * The decoded type of {@link TsConfigOptions}.
+ *
+ * @public
+ */
 type TsConfigOptionsType = typeof TsConfigOptions.Type;
+/**
+ * Generates a `tsconfig.json` file entry.
+ *
+ * @param options - the TypeScript configuration options
+ * @returns an array containing the generated `tsconfig.json` entry
+ * @public
+ */
 declare function createTsConfig(options: unknown): TemplateEntry[];
 //#endregion
 //#region src/lib/turbo/index.d.ts
+/**
+ * Options for generating a root `turbo.json` file.
+ *
+ * @public
+ */
 declare const TurboRootOptions: Schema.Struct<{
   tasks: Schema.Record$<typeof Schema.String, typeof Schema.Unknown>;
   globalDependencies: Schema.optional<Schema.Array$<typeof Schema.String>>;
@@ -146,15 +280,49 @@ declare const TurboRootOptions: Schema.Struct<{
   ui: Schema.optional<Schema.Literal<["tui", "stream"]>>;
   concurrency: Schema.optional<Schema.Union<[typeof Schema.String, typeof Schema.Number]>>;
 }>;
+/**
+ * The decoded type of {@link TurboRootOptions}.
+ *
+ * @public
+ */
 type TurboRootOptionsType = typeof TurboRootOptions.Type;
+/**
+ * Options for generating a workspace-level `turbo.json` file.
+ *
+ * @public
+ */
 declare const TurboWorkspaceOptions: Schema.Struct<{
   tasks: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
 }>;
+/**
+ * The decoded type of {@link TurboWorkspaceOptions}.
+ *
+ * @public
+ */
 type TurboWorkspaceOptionsType = typeof TurboWorkspaceOptions.Type;
+/**
+ * Generates a root `turbo.json` file entry.
+ *
+ * @param options - the root Turborepo configuration options
+ * @returns an array containing the generated root `turbo.json` entry
+ * @public
+ */
 declare function createTurboRoot(options: unknown): TemplateEntry[];
+/**
+ * Generates a workspace-level `turbo.json` file entry.
+ *
+ * @param options - the workspace Turborepo configuration options
+ * @returns an array containing the generated workspace `turbo.json` entry
+ * @public
+ */
 declare function createTurboWorkspace(options: unknown): TemplateEntry[];
 //#endregion
 //#region src/lib/vscode/index.d.ts
+/**
+ * Options for generating VS Code configuration files.
+ *
+ * @public
+ */
 declare const VsCodeOptions: Schema.Struct<{
   settings: Schema.optional<Schema.Struct<{
     biome: Schema.optional<typeof Schema.Boolean>;
@@ -163,10 +331,27 @@ declare const VsCodeOptions: Schema.Struct<{
   }>>;
   extensions: Schema.optional<Schema.Array$<typeof Schema.String>>;
 }>;
+/**
+ * The decoded type of {@link VsCodeOptions}.
+ *
+ * @public
+ */
 type VsCodeOptionsType = typeof VsCodeOptions.Type;
+/**
+ * Generates `.vscode/settings.json` and `.vscode/extensions.json` file entries.
+ *
+ * @param options - the VS Code configuration options
+ * @returns an array containing the generated VS Code configuration entries
+ * @public
+ */
 declare function createVsCode(options: unknown): TemplateEntry[];
 //#endregion
 //#region src/lib/workspace/index.d.ts
+/**
+ * Options for generating a complete workspace scaffold.
+ *
+ * @public
+ */
 declare const WorkspaceOptions: Schema.Struct<{
   name: typeof Schema.String;
   packageManager: Schema.Literal<["pnpm", "npm", "bun"]>;
@@ -183,7 +368,19 @@ declare const WorkspaceOptions: Schema.Struct<{
     vscode: Schema.optional<typeof Schema.Boolean>;
   }>>;
 }>;
+/**
+ * The decoded type of {@link WorkspaceOptions}.
+ *
+ * @public
+ */
 type WorkspaceOptionsType = typeof WorkspaceOptions.Type;
+/**
+ * Generates all file entries for a new workspace scaffold.
+ *
+ * @param options - the workspace configuration options
+ * @returns an array of template entries for the complete workspace
+ * @public
+ */
 declare function createWorkspace(options: unknown): TemplateEntry[];
 //#endregion
 export { BiomeOptions, type BiomeOptionsType, ChangesetOptions, type ChangesetOptionsType, GitignoreOptions, type GitignoreOptionsType, PackageJsonOptions, type PackageJsonOptionsType, PnpmWorkspaceOptions, type PnpmWorkspaceOptionsType, ReadmeOptions, type ReadmeOptionsType, type Template, type TemplateEntry, TsConfigOptions, type TsConfigOptionsType, TurboRootOptions, type TurboRootOptionsType, TurboWorkspaceOptions, type TurboWorkspaceOptionsType, type UpdateTemplate, VsCodeOptions, type VsCodeOptionsType, WorkspaceOptions, type WorkspaceOptionsType, createBiome, createChangeset, createGitignore, createPackageJson, createPnpmWorkspace, createReadme, createTsConfig, createTurboRoot, createTurboWorkspace, createVsCode, createWorkspace };

package/lib/biome/index.js

@@ -1,11 +1,23 @@
 import { Schema } from "effect";
 
 //#region src/lib/biome/index.ts
+/**
+* Options for generating a Biome configuration file.
+*
+* @public
+*/
 const BiomeOptions = Schema.Struct({
 	version: Schema.String,
 	extends: Schema.optional(Schema.Array(Schema.String)),
 	root: Schema.optional(Schema.Boolean)
 });
+/**
+* Generates a `biome.jsonc` configuration file entry.
+*
+* @param options - the Biome configuration options
+* @returns an array containing the generated `biome.jsonc` entry
+* @public
+*/
 function createBiome(options) {
 	const opts = Schema.decodeUnknownSync(BiomeOptions)(options);
 	const config = { $schema: `https://biomejs.dev/schemas/${opts.version}/schema.json` };

package/lib/changeset/index.js

@@ -2,12 +2,24 @@ import { Schema } from "effect";
 
 //#region src/lib/changeset/index.ts
 const RepoPattern = Schema.String.pipe(Schema.pattern(/^[^/\s]+\/[^/\s]+$/));
+/**
+* Options for generating a Changesets configuration file.
+*
+* @public
+*/
 const ChangesetOptions = Schema.Struct({
 	access: Schema.optionalWith(Schema.Literal("public", "restricted"), { default: () => "restricted" }),
 	baseBranch: Schema.optionalWith(Schema.String, { default: () => "main" }),
 	changelog: Schema.optionalWith(Schema.String, { default: () => "@savvy-web/changesets/changelog" }),
 	repo: Schema.optional(RepoPattern)
 });
+/**
+* Generates a `.changeset/config.json` configuration file entry.
+*
+* @param options - the Changesets configuration options
+* @returns an array containing the generated changeset config entry
+* @public
+*/
 function createChangeset(options) {
 	const opts = Schema.decodeUnknownSync(ChangesetOptions)(options);
 	const config = {

package/lib/gitignore/index.js

@@ -1,6 +1,11 @@
 import { Schema } from "effect";
 
 //#region src/lib/gitignore/index.ts
+/**
+* Options for generating a `.gitignore` file.
+*
+* @public
+*/
 const GitignoreOptions = Schema.Struct({
 	sections: Schema.optional(Schema.Struct({
 		node: Schema.optional(Schema.Boolean),
@@ -11,6 +16,13 @@ const GitignoreOptions = Schema.Struct({
 	})),
 	additional: Schema.optional(Schema.Array(Schema.String))
 });
+/**
+* Generates a `.gitignore` file entry.
+*
+* @param options - the gitignore configuration options
+* @returns an array containing the generated `.gitignore` entry
+* @public
+*/
 function createGitignore(options) {
 	const opts = Schema.decodeUnknownSync(GitignoreOptions)(options);
 	const sections = {

package/lib/package-json/index.js

@@ -19,6 +19,11 @@ const PublishConfig = Schema.Struct({
 	linkDirectory: Schema.optional(Schema.Boolean),
 	targets: Schema.optional(Schema.Unknown)
 });
+/**
+* Options for generating a `package.json` file.
+*
+* @public
+*/
 const PackageJsonOptions = Schema.Struct({
 	name: Schema.String,
 	version: Schema.optionalWith(Schema.String, { default: () => "0.0.0" }),
@@ -57,6 +62,13 @@ const PackageJsonOptions = Schema.Struct({
 	publishConfig: Schema.optional(PublishConfig),
 	keywords: Schema.optional(Schema.Array(Schema.String))
 });
+/**
+* Generates a sorted `package.json` file entry.
+*
+* @param options - the package.json configuration options
+* @returns an array containing the generated `package.json` entry
+* @public
+*/
 function createPackageJson(options) {
 	const opts = Schema.decodeUnknownSync(PackageJsonOptions)(options);
 	const pkg = {

package/lib/pnpm/index.js

@@ -2,6 +2,11 @@ import { Schema } from "effect";
 import yaml from "js-yaml";
 
 //#region src/lib/pnpm/index.ts
+/**
+* Options for generating a `pnpm-workspace.yaml` file.
+*
+* @public
+*/
 const PnpmWorkspaceOptions = Schema.Struct({
 	packages: Schema.Array(Schema.String),
 	autoInstallPeers: Schema.optional(Schema.Boolean),
@@ -11,6 +16,13 @@ const PnpmWorkspaceOptions = Schema.Struct({
 		value: Schema.String
 	}))
 });
+/**
+* Generates a `pnpm-workspace.yaml` file entry.
+*
+* @param options - the pnpm workspace configuration options
+* @returns an array containing the generated `pnpm-workspace.yaml` entry
+* @public
+*/
 function createPnpmWorkspace(options) {
 	const opts = Schema.decodeUnknownSync(PnpmWorkspaceOptions)(options);
 	const config = { packages: opts.packages };

package/lib/readme/index.js

@@ -1,10 +1,22 @@
 import { Schema } from "effect";
 
 //#region src/lib/readme/index.ts
+/**
+* Options for generating a `README.md` file.
+*
+* @public
+*/
 const ReadmeOptions = Schema.Struct({
 	name: Schema.String,
 	description: Schema.optional(Schema.String)
 });
+/**
+* Generates a `README.md` file entry.
+*
+* @param options - the README configuration options
+* @returns an array containing the generated `README.md` entry
+* @public
+*/
 function createReadme(options) {
 	const opts = Schema.decodeUnknownSync(ReadmeOptions)(options);
 	const lines = [`# ${opts.name}`];

package/lib/tsconfig/index.js

@@ -1,6 +1,11 @@
 import { Schema } from "effect";
 
 //#region src/lib/tsconfig/index.ts
+/**
+* Options for generating a `tsconfig.json` file.
+*
+* @public
+*/
 const TsConfigOptions = Schema.Struct({
 	extends: Schema.optional(Schema.Union(Schema.String, Schema.Array(Schema.String))),
 	composite: Schema.optional(Schema.Boolean),
@@ -8,6 +13,13 @@ const TsConfigOptions = Schema.Struct({
 	exclude: Schema.optional(Schema.Array(Schema.String)),
 	references: Schema.optional(Schema.Array(Schema.Struct({ path: Schema.String })))
 });
+/**
+* Generates a `tsconfig.json` file entry.
+*
+* @param options - the TypeScript configuration options
+* @returns an array containing the generated `tsconfig.json` entry
+* @public
+*/
 function createTsConfig(options) {
 	const opts = Schema.decodeUnknownSync(TsConfigOptions)(options);
 	const config = {};

package/lib/turbo/index.js

@@ -1,6 +1,11 @@
 import { Schema } from "effect";
 
 //#region src/lib/turbo/index.ts
+/**
+* Options for generating a root `turbo.json` file.
+*
+* @public
+*/
 const TurboRootOptions = Schema.Struct({
 	tasks: Schema.Record({
 		key: Schema.String,
@@ -12,10 +17,22 @@ const TurboRootOptions = Schema.Struct({
 	ui: Schema.optional(Schema.Literal("tui", "stream")),
 	concurrency: Schema.optional(Schema.Union(Schema.String, Schema.Number))
 });
+/**
+* Options for generating a workspace-level `turbo.json` file.
+*
+* @public
+*/
 const TurboWorkspaceOptions = Schema.Struct({ tasks: Schema.optional(Schema.Record({
 	key: Schema.String,
 	value: Schema.Unknown
 })) });
+/**
+* Generates a root `turbo.json` file entry.
+*
+* @param options - the root Turborepo configuration options
+* @returns an array containing the generated root `turbo.json` entry
+* @public
+*/
 function createTurboRoot(options) {
 	const opts = Schema.decodeUnknownSync(TurboRootOptions)(options);
 	const config = {
@@ -33,6 +50,13 @@ function createTurboRoot(options) {
 		content: JSON.stringify(config, null, "	")
 	}];
 }
+/**
+* Generates a workspace-level `turbo.json` file entry.
+*
+* @param options - the workspace Turborepo configuration options
+* @returns an array containing the generated workspace `turbo.json` entry
+* @public
+*/
 function createTurboWorkspace(options) {
 	const opts = Schema.decodeUnknownSync(TurboWorkspaceOptions)(options);
 	const config = { extends: ["//"] };

package/lib/vscode/index.js

@@ -6,10 +6,22 @@ const Settings = Schema.Struct({
 	turbo: Schema.optional(Schema.Boolean),
 	vitest: Schema.optional(Schema.Boolean)
 });
+/**
+* Options for generating VS Code configuration files.
+*
+* @public
+*/
 const VsCodeOptions = Schema.Struct({
 	settings: Schema.optional(Settings),
 	extensions: Schema.optional(Schema.Array(Schema.String))
 });
+/**
+* Generates `.vscode/settings.json` and `.vscode/extensions.json` file entries.
+*
+* @param options - the VS Code configuration options
+* @returns an array containing the generated VS Code configuration entries
+* @public
+*/
 function createVsCode(options) {
 	const opts = Schema.decodeUnknownSync(VsCodeOptions)(options);
 	const features = opts.settings ?? {};

package/lib/workspace/index.js

@@ -17,6 +17,11 @@ const Features = Schema.Struct({
 	changesets: Schema.optional(Schema.Boolean),
 	vscode: Schema.optional(Schema.Boolean)
 });
+/**
+* Options for generating a complete workspace scaffold.
+*
+* @public
+*/
 const WorkspaceOptions = Schema.Struct({
 	name: Schema.String,
 	packageManager: Schema.Literal("pnpm", "npm", "bun"),
@@ -25,6 +30,13 @@ const WorkspaceOptions = Schema.Struct({
 	biomeVersion: Schema.optionalWith(Schema.String, { default: () => "2.3.3" }),
 	features: Schema.optional(Features)
 });
+/**
+* Generates all file entries for a new workspace scaffold.
+*
+* @param options - the workspace configuration options
+* @returns an array of template entries for the complete workspace
+* @public
+*/
 function createWorkspace(options) {
 	const opts = Schema.decodeUnknownSync(WorkspaceOptions)(options);
 	const features = opts.features ?? {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@savvy-web/templates",
-	"version": "0.1.3",
+	"version": "0.1.4",
 	"private": false,
 	"description": "Pure TypeScript templates for Silk Suite project scaffolding",
 	"homepage": "https://github.com/savvy-web/systems/tree/main/packages/templates",
@@ -24,7 +24,8 @@
 		".": {
 			"types": "./index.d.ts",
 			"import": "./index.js"
-		}
+		},
+		"./package.json": "./package.json"
 	},
 	"dependencies": {
 		"js-yaml": "^4.2.0",

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.58.7"
+      "packageVersion": "7.58.9"
     }
   ]
 }