@savvy-web/templates 0.1.1 → 0.1.3

package/lib/pnpm/index.js

@@ -0,0 +1,33 @@
+import { Schema } from "effect";
+import yaml from "js-yaml";
+
+//#region src/lib/pnpm/index.ts
+const PnpmWorkspaceOptions = Schema.Struct({
+	packages: Schema.Array(Schema.String),
+	autoInstallPeers: Schema.optional(Schema.Boolean),
+	catalogMode: Schema.optional(Schema.Literal("strict", "prefer", "manual")),
+	catalog: Schema.optional(Schema.Record({
+		key: Schema.String,
+		value: Schema.String
+	}))
+});
+function createPnpmWorkspace(options) {
+	const opts = Schema.decodeUnknownSync(PnpmWorkspaceOptions)(options);
+	const config = { packages: opts.packages };
+	if (opts.autoInstallPeers !== void 0) config.autoInstallPeers = opts.autoInstallPeers;
+	if (opts.catalogMode) config.catalogMode = opts.catalogMode;
+	if (opts.catalog && Object.keys(opts.catalog).length > 0) config.catalog = opts.catalog;
+	return [{
+		name: "pnpm-workspace",
+		filename: "pnpm-workspace.yaml",
+		content: yaml.dump(config, {
+			indent: 2,
+			lineWidth: -1,
+			noRefs: true,
+			sortKeys: false
+		})
+	}];
+}
+
+//#endregion
+export { PnpmWorkspaceOptions, createPnpmWorkspace };

package/lib/readme/index.js

@@ -0,0 +1,21 @@
+import { Schema } from "effect";
+
+//#region src/lib/readme/index.ts
+const ReadmeOptions = Schema.Struct({
+	name: Schema.String,
+	description: Schema.optional(Schema.String)
+});
+function createReadme(options) {
+	const opts = Schema.decodeUnknownSync(ReadmeOptions)(options);
+	const lines = [`# ${opts.name}`];
+	if (opts.description) lines.push("", opts.description);
+	lines.push("");
+	return [{
+		name: "readme",
+		filename: "README.md",
+		content: lines.join("\n")
+	}];
+}
+
+//#endregion
+export { ReadmeOptions, createReadme };

package/lib/tsconfig/index.js

@@ -0,0 +1,27 @@
+import { Schema } from "effect";
+
+//#region src/lib/tsconfig/index.ts
+const TsConfigOptions = Schema.Struct({
+	extends: Schema.optional(Schema.Union(Schema.String, Schema.Array(Schema.String))),
+	composite: Schema.optional(Schema.Boolean),
+	include: Schema.optional(Schema.Array(Schema.String)),
+	exclude: Schema.optional(Schema.Array(Schema.String)),
+	references: Schema.optional(Schema.Array(Schema.Struct({ path: Schema.String })))
+});
+function createTsConfig(options) {
+	const opts = Schema.decodeUnknownSync(TsConfigOptions)(options);
+	const config = {};
+	if (opts.extends !== void 0) config.extends = typeof opts.extends === "string" ? [opts.extends] : opts.extends;
+	if (opts.composite !== void 0) config.composite = opts.composite;
+	if (opts.include) config.include = opts.include;
+	if (opts.exclude) config.exclude = opts.exclude;
+	if (opts.references) config.references = opts.references;
+	return [{
+		name: "tsconfig",
+		filename: "tsconfig.json",
+		content: JSON.stringify(config, null, "	")
+	}];
+}
+
+//#endregion
+export { TsConfigOptions, createTsConfig };

package/lib/turbo/index.js

@@ -0,0 +1,48 @@
+import { Schema } from "effect";
+
+//#region src/lib/turbo/index.ts
+const TurboRootOptions = Schema.Struct({
+	tasks: Schema.Record({
+		key: Schema.String,
+		value: Schema.Unknown
+	}),
+	globalDependencies: Schema.optional(Schema.Array(Schema.String)),
+	globalEnv: Schema.optional(Schema.Array(Schema.String)),
+	globalPassThroughEnv: Schema.optional(Schema.Array(Schema.String)),
+	ui: Schema.optional(Schema.Literal("tui", "stream")),
+	concurrency: Schema.optional(Schema.Union(Schema.String, Schema.Number))
+});
+const TurboWorkspaceOptions = Schema.Struct({ tasks: Schema.optional(Schema.Record({
+	key: Schema.String,
+	value: Schema.Unknown
+})) });
+function createTurboRoot(options) {
+	const opts = Schema.decodeUnknownSync(TurboRootOptions)(options);
+	const config = {
+		$schema: "https://turborepo.com/schema.v2.json",
+		tasks: opts.tasks
+	};
+	if (opts.globalDependencies && opts.globalDependencies.length > 0) config.globalDependencies = opts.globalDependencies;
+	if (opts.globalEnv && opts.globalEnv.length > 0) config.globalEnv = opts.globalEnv;
+	if (opts.globalPassThroughEnv && opts.globalPassThroughEnv.length > 0) config.globalPassThroughEnv = opts.globalPassThroughEnv;
+	if (opts.ui) config.ui = opts.ui;
+	if (opts.concurrency !== void 0) config.concurrency = opts.concurrency;
+	return [{
+		name: "turbo-root",
+		filename: "turbo.json",
+		content: JSON.stringify(config, null, "	")
+	}];
+}
+function createTurboWorkspace(options) {
+	const opts = Schema.decodeUnknownSync(TurboWorkspaceOptions)(options);
+	const config = { extends: ["//"] };
+	if (opts.tasks && Object.keys(opts.tasks).length > 0) config.tasks = opts.tasks;
+	return [{
+		name: "turbo-workspace",
+		filename: "turbo.json",
+		content: JSON.stringify(config, null, "	")
+	}];
+}
+
+//#endregion
+export { TurboRootOptions, TurboWorkspaceOptions, createTurboRoot, createTurboWorkspace };

package/lib/vscode/index.js

@@ -0,0 +1,66 @@
+import { Schema } from "effect";
+
+//#region src/lib/vscode/index.ts
+const Settings = Schema.Struct({
+	biome: Schema.optional(Schema.Boolean),
+	turbo: Schema.optional(Schema.Boolean),
+	vitest: Schema.optional(Schema.Boolean)
+});
+const VsCodeOptions = Schema.Struct({
+	settings: Schema.optional(Settings),
+	extensions: Schema.optional(Schema.Array(Schema.String))
+});
+function createVsCode(options) {
+	const opts = Schema.decodeUnknownSync(VsCodeOptions)(options);
+	const features = opts.settings ?? {};
+	const codeActions = { "source.fixAll.ts": "explicit" };
+	const searchExclude = {
+		"**/node_modules": true,
+		"**/dist": true,
+		"**/.rslib": true,
+		"**/*.tsbuildinfo": true
+	};
+	const filesExclude = {
+		"**/node_modules": true,
+		"**/dist": true,
+		"**/.rslib": true,
+		"**/*.tsbuildinfo": true
+	};
+	if (features.biome) {
+		codeActions["source.organizeImports.biome"] = "explicit";
+		codeActions["source.fixAll.biome"] = "explicit";
+	}
+	if (features.vitest) {
+		searchExclude["**/.vitest"] = true;
+		searchExclude["**/.coverage"] = true;
+		filesExclude["**/.vitest"] = true;
+		filesExclude["**/.coverage"] = true;
+	}
+	if (features.turbo) {
+		searchExclude["**/.turbo"] = true;
+		filesExclude["**/.turbo"] = true;
+	}
+	const settings = {
+		"editor.formatOnSave": true,
+		"eslint.enable": !features.biome,
+		"prettier.enable": !features.biome,
+		"biome.enabled": !!features.biome,
+		"biome.requireConfiguration": true,
+		"editor.codeActionsOnSave": codeActions,
+		"search.exclude": searchExclude,
+		"files.exclude": filesExclude
+	};
+	const recommendations = [...new Set(opts.extensions ?? [])].sort();
+	return [{
+		name: "vscode-settings",
+		filename: ".vscode/settings.json",
+		content: JSON.stringify(settings, null, "	")
+	}, {
+		name: "vscode-extensions",
+		filename: ".vscode/extensions.json",
+		content: JSON.stringify({ recommendations }, null, "	")
+	}];
+}
+
+//#endregion
+export { VsCodeOptions, createVsCode };

package/lib/workspace/index.js

@@ -0,0 +1,81 @@
+import { createBiome } from "../biome/index.js";
+import { createChangeset } from "../changeset/index.js";
+import { createGitignore } from "../gitignore/index.js";
+import { createPackageJson } from "../package-json/index.js";
+import { createPnpmWorkspace } from "../pnpm/index.js";
+import { createReadme } from "../readme/index.js";
+import { createTsConfig } from "../tsconfig/index.js";
+import { createTurboRoot } from "../turbo/index.js";
+import { createVsCode } from "../vscode/index.js";
+import { Schema } from "effect";
+
+//#region src/lib/workspace/index.ts
+const Features = Schema.Struct({
+	biome: Schema.optional(Schema.Boolean),
+	vitest: Schema.optional(Schema.Boolean),
+	turbo: Schema.optional(Schema.Boolean),
+	changesets: Schema.optional(Schema.Boolean),
+	vscode: Schema.optional(Schema.Boolean)
+});
+const WorkspaceOptions = Schema.Struct({
+	name: Schema.String,
+	packageManager: Schema.Literal("pnpm", "npm", "bun"),
+	packageManagerVersion: Schema.String,
+	nodeVersion: Schema.String,
+	biomeVersion: Schema.optionalWith(Schema.String, { default: () => "2.3.3" }),
+	features: Schema.optional(Features)
+});
+function createWorkspace(options) {
+	const opts = Schema.decodeUnknownSync(WorkspaceOptions)(options);
+	const features = opts.features ?? {};
+	const entries = [];
+	entries.push(...createPackageJson({
+		name: opts.name,
+		version: "0.0.0",
+		private: true,
+		type: "module",
+		packageManager: `${opts.packageManager}@${opts.packageManagerVersion}`,
+		engines: { node: `>=${opts.nodeVersion}` }
+	}));
+	entries.push(...createTsConfig({}));
+	entries.push(...createGitignore({ sections: {
+		os: true,
+		node: true,
+		build: true,
+		env: true,
+		silk: !!features.changesets
+	} }));
+	entries.push(...createReadme({ name: opts.name }));
+	if (opts.packageManager === "pnpm") entries.push(...createPnpmWorkspace({
+		packages: ["packages/*"],
+		autoInstallPeers: true
+	}));
+	if (features.biome) entries.push(...createBiome({
+		version: opts.biomeVersion,
+		root: true
+	}));
+	if (features.turbo) entries.push(...createTurboRoot({
+		tasks: {
+			build: {
+				dependsOn: ["^build"],
+				outputs: ["dist/**"]
+			},
+			test: { dependsOn: ["build"] },
+			"types:check": {
+				cache: true,
+				outputLogs: "errors-only"
+			}
+		},
+		globalPassThroughEnv: ["CI", "GITHUB_ACTIONS"]
+	}));
+	if (features.changesets) entries.push(...createChangeset({ access: "restricted" }));
+	if (features.vscode) entries.push(...createVsCode({ settings: {
+		biome: !!features.biome,
+		turbo: !!features.turbo,
+		vitest: !!features.vitest
+	} }));
+	return entries;
+}
+
+//#endregion
+export { WorkspaceOptions, createWorkspace };

package/package.json

@@ -1,47 +1,36 @@
 {
-  "name": "@savvy-web/templates",
-  "version": "0.1.1",
-  "private": false,
-  "description": "Pure TypeScript templates for Silk Suite project scaffolding",
-  "homepage": "https://github.com/savvy-web/systems/tree/main/packages/templates",
-  "bugs": {
-    "url": "https://github.com/savvy-web/systems/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/savvy-web/systems.git",
-    "directory": "packages/templates"
-  },
-  "license": "MIT",
-  "author": {
-    "name": "C. Spencer Beggs",
-    "email": "spencer@savvyweb.systems",
-    "url": "https://savvyweb.systems"
-  },
-  "sideEffects": false,
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "import": "./index.js"
-    }
-  },
-  "dependencies": {
-    "js-yaml": "^4.1.1",
-    "sort-package-json": "^3.6.1"
-  },
-  "peerDependencies": {
-    "effect": ">=3.21.0"
-  },
-  "files": [
-    "!templates.api.json",
-    "!tsconfig.json",
-    "!tsdoc.json",
-    "LICENSE",
-    "README.md",
-    "index.d.ts",
-    "index.js",
-    "package.json",
-    "tsdoc-metadata.json"
-  ]
+	"name": "@savvy-web/templates",
+	"version": "0.1.3",
+	"private": false,
+	"description": "Pure TypeScript templates for Silk Suite project scaffolding",
+	"homepage": "https://github.com/savvy-web/systems/tree/main/packages/templates",
+	"bugs": {
+		"url": "https://github.com/savvy-web/systems/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/savvy-web/systems.git",
+		"directory": "packages/templates"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "C. Spencer Beggs",
+		"email": "spencer@savvyweb.systems",
+		"url": "https://savvyweb.systems"
+	},
+	"sideEffects": false,
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./index.d.ts",
+			"import": "./index.js"
+		}
+	},
+	"dependencies": {
+		"js-yaml": "^4.2.0",
+		"sort-package-json": "^4.0.0"
+	},
+	"peerDependencies": {
+		"effect": ">=3.21.0"
+	}
 }

package/tsdoc-metadata.json

@@ -1,11 +1,11 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.58.7"
-    }
-  ]
-}
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.58.7"
+    }
+  ]
+}