@savvy-web/github-action-builder 0.7.4 → 0.7.6

package/cli/commands/init.js

@@ -0,0 +1,247 @@
+import { Console, Effect } from "effect";
+import { existsSync, mkdirSync, writeFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { Args, Command, Options } from "@effect/cli";
+
+//#region src/cli/commands/init.ts
+/* v8 ignore start - CLI commands require integration testing */
+/**
+* Init command for GitHub Action Builder CLI.
+*/
+/**
+* Action name positional argument.
+*/
+const actionNameArg = Args.text({ name: "action-name" }).pipe(Args.withDescription("Name of the GitHub Action (also the output directory)"));
+/**
+* Force overwrite option.
+*/
+const forceOption = Options.boolean("force").pipe(Options.withAlias("f"), Options.withDescription("Overwrite existing files"), Options.withDefault(false));
+/**
+* Get current package version (replaced at build time).
+*/
+const getPackageVersion = () => {
+	return process.env.__PACKAGE_VERSION__ ?? "0.0.0";
+};
+/**
+* Generate package.json content.
+*/
+const generatePackageJson = (name) => {
+	const pkg = {
+		name,
+		version: "0.0.0",
+		private: true,
+		type: "module",
+		scripts: {
+			build: "github-action-builder build",
+			validate: "github-action-builder validate",
+			typecheck: "tsc --noEmit"
+		},
+		devDependencies: {
+			"@savvy-web/github-action-builder": `^${getPackageVersion()}`,
+			typescript: "^5.9.3"
+		},
+		dependencies: {
+			"@actions/core": "^1.11.1",
+			"@actions/github": "^6.0.0"
+		}
+	};
+	return `${JSON.stringify(pkg, null, 2)}\n`;
+};
+/**
+* Generate tsconfig.json content.
+*/
+const generateTsConfig = () => {
+	return `${JSON.stringify({
+		compilerOptions: {
+			target: "ES2022",
+			module: "NodeNext",
+			moduleResolution: "NodeNext",
+			strict: true,
+			esModuleInterop: true,
+			skipLibCheck: true,
+			forceConsistentCasingInFileNames: true,
+			declaration: false,
+			outDir: "dist",
+			rootDir: "src"
+		},
+		include: ["src/**/*.ts", "action.config.ts"],
+		exclude: ["node_modules", "dist"]
+	}, null, 2)}\n`;
+};
+/**
+* Generate action.yml content.
+*/
+const generateActionYml = (name) => {
+	return `name: "${name}"
+description: "A GitHub Action built with @savvy-web/github-action-builder"
+author: ""
+
+inputs:
+  example-input:
+    description: "An example input"
+    required: false
+    default: "hello"
+
+outputs:
+  example-output:
+    description: "An example output"
+
+runs:
+  using: "node24"
+  main: "dist/main.js"
+  pre: "dist/pre.js"
+  post: "dist/post.js"
+
+branding:
+  icon: "zap"
+  color: "blue"
+`;
+};
+/**
+* Default configuration file content.
+*/
+const defaultConfig = `import { GitHubAction } from "@savvy-web/github-action-builder";
+
+export default GitHubAction.create({
+	// Entry points are auto-detected from src/main.ts, src/pre.ts, src/post.ts
+	// Uncomment to customize:
+	// entries: {
+	//   main: "src/main.ts",
+	//   pre: "src/pre.ts",
+	//   post: "src/post.ts",
+	// },
+
+	// Build options
+	// build: {
+	//   minify: true,
+	//   sourceMap: false,
+	// },
+
+	// Validation options
+	// validation: {
+	//   strict: undefined, // Auto-detects CI environment
+	// },
+});
+`;
+/**
+* Generate src/main.ts content.
+*/
+const mainTemplate = `import * as core from "@actions/core";
+
+async function run(): Promise<void> {
+	try {
+		const input = core.getInput("example-input");
+		core.info(\`Running main action with input: \${input}\`);
+
+		// Your main action logic goes here
+
+		core.setOutput("example-output", "success");
+	} catch (error) {
+		if (error instanceof Error) {
+			core.setFailed(error.message);
+		} else {
+			core.setFailed("An unexpected error occurred");
+		}
+	}
+}
+
+run();
+`;
+/**
+* Generate src/pre.ts content.
+*/
+const preTemplate = `import * as core from "@actions/core";
+
+async function run(): Promise<void> {
+	try {
+		core.info("Running pre action...");
+
+		// Your pre-action setup logic goes here
+		// This runs before the main action
+	} catch (error) {
+		if (error instanceof Error) {
+			core.setFailed(error.message);
+		} else {
+			core.setFailed("An unexpected error occurred");
+		}
+	}
+}
+
+run();
+`;
+/**
+* Generate src/post.ts content.
+*/
+const postTemplate = `import * as core from "@actions/core";
+
+async function run(): Promise<void> {
+	try {
+		core.info("Running post action...");
+
+		// Your post-action cleanup logic goes here
+		// This runs after the main action, even if it fails
+	} catch (error) {
+		if (error instanceof Error) {
+			core.warning(error.message);
+		} else {
+			core.warning("An unexpected error occurred during cleanup");
+		}
+	}
+}
+
+run();
+`;
+/**
+* Write a file if it doesn't exist or force is enabled.
+*/
+const writeFile = (path, content, force, createdFiles, skippedFiles) => {
+	if (existsSync(path) && !force) {
+		skippedFiles.push(path);
+		return;
+	}
+	writeFileSync(path, content, "utf-8");
+	createdFiles.push(path);
+};
+/**
+* Init command handler.
+*/
+const initHandler = ({ actionName, force }) => Effect.gen(function* () {
+	const projectDir = resolve(process.cwd(), actionName);
+	const createdFiles = [];
+	const skippedFiles = [];
+	if (existsSync(projectDir) && !force) {
+		yield* Console.error(`Directory already exists: ${actionName}`);
+		yield* Console.error("Use --force to overwrite existing files.");
+		return yield* Effect.fail(/* @__PURE__ */ new Error("Directory exists"));
+	}
+	if (!existsSync(projectDir)) mkdirSync(projectDir, { recursive: true });
+	const srcDir = resolve(projectDir, "src");
+	if (!existsSync(srcDir)) mkdirSync(srcDir, { recursive: true });
+	writeFile(resolve(projectDir, "package.json"), generatePackageJson(actionName), force, createdFiles, skippedFiles);
+	writeFile(resolve(projectDir, "tsconfig.json"), generateTsConfig(), force, createdFiles, skippedFiles);
+	writeFile(resolve(projectDir, "action.yml"), generateActionYml(actionName), force, createdFiles, skippedFiles);
+	writeFile(resolve(projectDir, "action.config.ts"), defaultConfig, force, createdFiles, skippedFiles);
+	writeFile(resolve(srcDir, "main.ts"), mainTemplate, force, createdFiles, skippedFiles);
+	writeFile(resolve(srcDir, "pre.ts"), preTemplate, force, createdFiles, skippedFiles);
+	writeFile(resolve(srcDir, "post.ts"), postTemplate, force, createdFiles, skippedFiles);
+	yield* Console.log(`Created ${actionName}/`);
+	if (createdFiles.length > 0) for (const file of createdFiles) yield* Console.log(`  ${file.replace(`${projectDir}/`, "")}`);
+	if (skippedFiles.length > 0) {
+		yield* Console.log("\nSkipped existing files (use --force to overwrite):");
+		for (const file of skippedFiles) yield* Console.log(`  ${file.replace(`${projectDir}/`, "")}`);
+	}
+	yield* Console.log("\nNext steps:");
+	yield* Console.log(`  cd ${actionName}`);
+	yield* Console.log("  npm install");
+	yield* Console.log("  npm run build");
+});
+/**
+* Init command - creates a new GitHub Action project.
+*/
+const initCommand = Command.make("init", {
+	actionName: actionNameArg,
+	force: forceOption
+}, initHandler);
+
+//#endregion
+export { initCommand };

package/cli/commands/validate.js

@@ -0,0 +1,42 @@
+import { ConfigService } from "../../services/config.js";
+import { ValidationService } from "../../services/validation.js";
+import { configOption, quietOption } from "./build.js";
+import { Console, Effect, Option } from "effect";
+import { Command } from "@effect/cli";
+
+//#region src/cli/commands/validate.ts
+/* v8 ignore start - CLI commands require integration testing */
+/**
+* Validate command for GitHub Action Builder CLI.
+*/
+/**
+* Validate command handler using Effect services.
+*/
+const validateHandler = ({ config, quiet }) => Effect.gen(function* () {
+	const configService = yield* ConfigService;
+	const validationService = yield* ValidationService;
+	const cwd = process.cwd();
+	if (!quiet) yield* Console.log("Loading configuration...");
+	const loadOptions = Option.isSome(config) ? {
+		cwd,
+		configPath: config.value
+	} : { cwd };
+	const configResult = yield* configService.load(loadOptions);
+	if (!quiet) if (configResult.usingDefaults) yield* Console.log("  Using default configuration");
+	else yield* Console.log(`  Found ${configResult.configPath}`);
+	if (!quiet) yield* Console.log("\nValidating...");
+	const validationResult = yield* validationService.validate(configResult.config, { cwd });
+	yield* Console.log(`\n${validationService.formatResult(validationResult)}`);
+	if (!validationResult.valid) return yield* Effect.fail(/* @__PURE__ */ new Error("Validation failed"));
+	if (!quiet) yield* Console.log("\nValidation completed successfully!");
+});
+/**
+* Validate command - checks action.yml and configuration.
+*/
+const validateCommand = Command.make("validate", {
+	config: configOption,
+	quiet: quietOption
+}, validateHandler);
+
+//#endregion
+export { validateCommand };

package/errors.js

@@ -0,0 +1,284 @@
+import { Data } from "effect";
+
+//#region src/errors.ts
+/**
+* Typed error classes for GitHub Action Builder.
+*
+* @remarks
+* Uses Effect's Data.TaggedError pattern for type-safe error handling
+* with pattern matching support via the `_tag` discriminant.
+*
+* @example Pattern matching on errors
+* ```typescript
+* import { ConfigNotFound, ConfigInvalid } from "@savvy-web/github-action-builder";
+*
+* function handleError(error: ConfigError): string {
+*   switch (error._tag) {
+*     case "ConfigNotFound":
+*       return `Config not found at ${error.path}`;
+*     case "ConfigInvalid":
+*       return `Invalid config: ${error.errors.join(", ")}`;
+*     case "ConfigLoadFailed":
+*       return `Failed to load config: ${error.cause}`;
+*   }
+* }
+* ```
+*/
+/**
+* Base class for ConfigNotFound error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const ConfigNotFoundBase = Data.TaggedError("ConfigNotFound");
+/**
+* Error when configuration file is not found.
+*
+* @public
+*/
+var ConfigNotFound = class extends ConfigNotFoundBase {};
+/**
+* Base class for ConfigInvalid error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const ConfigInvalidBase = Data.TaggedError("ConfigInvalid");
+/**
+* Error when configuration file exists but contains invalid content.
+*
+* @public
+*/
+var ConfigInvalid = class extends ConfigInvalidBase {};
+/**
+* Base class for ConfigLoadFailed error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const ConfigLoadFailedBase = Data.TaggedError("ConfigLoadFailed");
+/**
+* Error when configuration file fails to load (import error, syntax error, etc.).
+*
+* @public
+*/
+var ConfigLoadFailed = class extends ConfigLoadFailedBase {};
+/**
+* Base class for MainEntryMissing error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const MainEntryMissingBase = Data.TaggedError("MainEntryMissing");
+/**
+* Error when the required main entry point is missing.
+*
+* @public
+*/
+var MainEntryMissing = class extends MainEntryMissingBase {};
+/**
+* Base class for EntryFileMissing error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const EntryFileMissingBase = Data.TaggedError("EntryFileMissing");
+/**
+* Error when an explicitly specified entry file is missing.
+*
+* @public
+*/
+var EntryFileMissing = class extends EntryFileMissingBase {};
+/**
+* Base class for ActionYmlMissing error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const ActionYmlMissingBase = Data.TaggedError("ActionYmlMissing");
+/**
+* Error when action.yml file is missing.
+*
+* @public
+*/
+var ActionYmlMissing = class extends ActionYmlMissingBase {};
+/**
+* Base class for ActionYmlSyntaxError error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const ActionYmlSyntaxErrorBase = Data.TaggedError("ActionYmlSyntaxError");
+/**
+* Error when action.yml has invalid YAML syntax.
+*
+* @public
+*/
+var ActionYmlSyntaxError = class extends ActionYmlSyntaxErrorBase {};
+/**
+* Base class for ActionYmlSchemaError error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const ActionYmlSchemaErrorBase = Data.TaggedError("ActionYmlSchemaError");
+/**
+* Error when action.yml fails schema validation.
+*
+* @public
+*/
+var ActionYmlSchemaError = class extends ActionYmlSchemaErrorBase {};
+/**
+* Base class for ValidationFailed error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const ValidationFailedBase = Data.TaggedError("ValidationFailed");
+/**
+* Error when validation fails in strict mode (CI environment).
+*
+* @public
+*/
+var ValidationFailed = class extends ValidationFailedBase {};
+/**
+* Base class for BundleFailed error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const BundleFailedBase = Data.TaggedError("BundleFailed");
+/**
+* Error when bundling with rsbuild fails.
+*
+* @public
+*/
+var BundleFailed = class extends BundleFailedBase {};
+/**
+* Base class for WriteError error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const WriteErrorBase = Data.TaggedError("WriteError");
+/**
+* Error when writing output files fails.
+*
+* @public
+*/
+var WriteError = class extends WriteErrorBase {};
+/**
+* Base class for CleanError error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const CleanErrorBase = Data.TaggedError("CleanError");
+/**
+* Error when cleaning the output directory fails.
+*
+* @public
+*/
+var CleanError = class extends CleanErrorBase {};
+/**
+* Base class for BuildFailed error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const BuildFailedBase = Data.TaggedError("BuildFailed");
+/**
+* Error when the build process fails overall.
+*
+* @public
+*/
+var BuildFailed = class extends BuildFailedBase {};
+/**
+* Base class for PersistLocalError error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const PersistLocalErrorBase = Data.TaggedError("PersistLocalError");
+/**
+* Error when persisting build output to local action directory fails.
+*
+* @public
+*/
+var PersistLocalError = class extends PersistLocalErrorBase {};
+/**
+* Base class for ActionYmlPathError error.
+*
+* @privateRemarks
+* This export is required for api-extractor documentation generation.
+* Effect's Data.TaggedError creates an anonymous base class that must be
+* explicitly exported to avoid "forgotten export" warnings. Do not delete.
+*
+* @internal
+*/
+const ActionYmlPathErrorBase = Data.TaggedError("ActionYmlPathError");
+/**
+* Error when action.yml runs paths don't resolve correctly in destination.
+*
+* @public
+*/
+var ActionYmlPathError = class extends ActionYmlPathErrorBase {};
+
+//#endregion
+export { ActionYmlMissing, ActionYmlMissingBase, ActionYmlPathError, ActionYmlPathErrorBase, ActionYmlSchemaError, ActionYmlSchemaErrorBase, ActionYmlSyntaxError, ActionYmlSyntaxErrorBase, BuildFailed, BuildFailedBase, BundleFailed, BundleFailedBase, CleanError, CleanErrorBase, ConfigInvalid, ConfigInvalidBase, ConfigLoadFailed, ConfigLoadFailedBase, ConfigNotFound, ConfigNotFoundBase, EntryFileMissing, EntryFileMissingBase, MainEntryMissing, MainEntryMissingBase, PersistLocalError, PersistLocalErrorBase, ValidationFailed, ValidationFailedBase, WriteError, WriteErrorBase };