alex-c-line 2.0.0 → 2.0.2

package/README.md

@@ -7,7 +7,7 @@
 [![CI](https://github.com/alextheman231/alex-c-line/actions/workflows/ci.yml/badge.svg)](https://github.com/alextheman231/alex-c-line/actions/workflows/ci.yml)
 [![Publish to NPM Registry and GitHub Releases](https://github.com/alextheman231/alex-c-line/actions/workflows/publish.yml/badge.svg)](https://github.com/alextheman231/alex-c-line/actions/workflows/publish.yml)
 
-<img src="./artwork/alex-c-line.png" alt="alex-c-line artwork" width=250 height=250>
+<img src="./media/alex-c-line.png" alt="alex-c-line artwork" width=250 height=250>
 
 This is my command-line tool, which serves as a developer toolkit that can be used in any repository to streamline the developer workflow. It provides a flexible configuration system so you can customise its behaviour to match your workflow.
 
@@ -40,24 +40,24 @@ alex-c-line say-hello
 Some commands may even take extra arguments. For example:
 
 ```bash
-alex-c-line increment-version v1.2.3 major
+alex-c-line version increment v1.2.3 major
 ```
 
 Flags may also be passed through in the following way.
 
 ```bash
-alex-c-line increment-version v1.2.3 major --no-prefix
+alex-c-line version increment v1.2.3 major --no-prefix
 ```
 
-Note that for `use-local-package` specifically, you will need to add `--` before the local `alex-c-line` arguments to ensure that all flags get passed through correctly. Example:
+Note that for `local-package use` specifically, you will need to add `--` before the local `alex-c-line` arguments to ensure that all flags get passed through correctly. Example:
 
 ```bash
-alex-c-line use-local-package alex-c-line -- increment-version v1.2.3 major --no-prefix
+alex-c-line local-package use alex-c-line -- version increment v1.2.3 major --no-prefix
 ```
 
 ## Configs
 
-Some commands also support usage of the config system. For example, `pre-commit-2` supports the `alex-c-line.config.js` file, and `use-local-package` supports the more user-specific `.alex-c-line.private.config.js` file. `alex-c-line.config.js` is intended for shared configurations per repository, whereas `.alex-c-line.private.config.js` are for configurations specific to the user's usage.
+Some commands also support usage of the config system. For example, `pre-commit` supports the `alex-c-line.config.js` file, and `local-package use` supports the more user-specific `.alex-c-line.private.config.js` file. `alex-c-line.config.js` is intended for shared configurations per repository, whereas `.alex-c-line.private.config.js` are for configurations specific to the user's usage.
 
 The `configs` subpath provides some helper functions and types that may be helpful when constructing these configs. Namely, `defineAlexCLineConfig` can be used as a type helper, so that you get better type hints in the editor.
 
@@ -65,9 +65,11 @@ The `configs` subpath provides some helper functions and types that may be helpf
 import { defineAlexCLineConfig } from "alex-c-line/configs";
 
 export default defineAlexCLineConfig({
-  createPullRequestTemplate: {
-    category: "general",
-    projectType: "package",
+  template: {
+    pullRequest: {
+      category: "general",
+      projectType: "package",
+    }
   },
   preCommit: {
     packageManager: "pnpm",
@@ -84,9 +86,11 @@ import type { AlexCLineConfig } from "alex-c-line/configs";
 import { scripts } from "./package.json" with { type: "json" };
 
 const alexCLineConfig: AlexCLineConfig<keyof typeof scripts> = {
-  createPullRequestTemplate: {
-    category: "general",
-    projectType: "package",
+  template: {
+    pullRequest: {
+      category: "general",
+      projectType: "package",
+    }
   },
   preCommit: {
     packageManager: "pnpm",

package/dist/configs/index.cjs

@@ -1,4 +1,4 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region \0rolldown/runtime.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -7,16 +7,12 @@ var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") {
-		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-			key = keys[i];
-			if (!__hasOwnProp.call(to, key) && key !== except) {
-				__defProp(to, key, {
-					get: ((k) => from[k]).bind(null, key),
-					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-				});
-			}
-		}
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
 	}
 	return to;
 };
@@ -24,13 +20,11 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	value: mod,
 	enumerable: true
 }) : target, mod));
-
 //#endregion
 require("@alextheman/utility");
 let zod = require("zod");
 zod = __toESM(zod);
 let _alextheman_utility_internal = require("@alextheman/utility/internal");
-
 //#region src/configs/helpers/preCommit/definePreCommitConfig.ts
 const preCommitStepOptionsSchema = zod.default.strictObject({ arguments: zod.default.array(zod.default.string()).optional() });
 const preCommitConfigSchema = zod.default.strictObject({
@@ -49,7 +43,6 @@ const preCommitConfigSchema = zod.default.strictObject({
 function definePreCommitConfig(config) {
 	return config;
 }
-
 //#endregion
 //#region src/configs/helpers/template/pullRequest/defineTemplatePullRequestSchema.ts
 const templatePullRequestBaseSchema = zod.default.strictObject({ projectName: zod.default.string().optional() });
@@ -64,17 +57,13 @@ const templatePullRequestSchema = zod.default.discriminatedUnion("category", [te
 function defineCreatePullRequestTemplateConfig(config) {
 	return config;
 }
-
-//#endregion
-//#region src/configs/helpers/defineAlexCLineConfig.ts
-const alexCLineConfigSchema = zod.default.strictObject({
+zod.default.strictObject({
 	preCommit: preCommitConfigSchema,
 	template: zod.default.object({ pullRequest: templatePullRequestSchema })
 }).partial();
 function defineAlexCLineConfig(config) {
 	return config;
 }
-
 //#endregion
 //#region src/configs/types/ConfigFileName.ts
 const ConfigFileName = {
@@ -82,17 +71,13 @@ const ConfigFileName = {
 	ES_MODULES_JAVASCRIPT: "alex-c-line.config.mjs",
 	COMMON_JS_JAVASCRIPT: "alex-c-line.config.cjs"
 };
-
 //#endregion
 //#region src/configs/types/template/pullRequest/PullRequestTemplateCategory.ts
 const PullRequestTemplateCategory = {
 	GENERAL: "general",
 	INFRASTRUCTURE: "infrastructure"
 };
-
-//#endregion
-//#region src/configs/helpers/defineAlexCLinePrivateConfig.ts
-const alexCLinePrivateConfigSchema = zod.default.object({ localPackage: zod.default.strictObject({
+zod.default.object({ localPackage: zod.default.strictObject({
 	enableCache: zod.default.boolean().optional(),
 	localPackages: zod.default.record(zod.default.string(), zod.default.strictObject({
 		packageManager: zod.default.enum(_alextheman_utility_internal.PackageManager),
@@ -105,25 +90,21 @@ const alexCLinePrivateConfigSchema = zod.default.object({ localPackage: zod.defa
 function defineAlexCLinePrivateConfig(config) {
 	return config;
 }
-
-//#endregion
-//#region src/configs/helpers/preCommit/definePreCommitPrivateConfig.ts
-const preCommitPrivateConfigSchema = zod.default.strictObject({ disableSteps: zod.default.array(zod.default.string()).optional() });
+zod.default.strictObject({ disableSteps: zod.default.array(zod.default.string()).optional() });
 function definePreCommitPrivateConfig(config) {
 	return config;
 }
-
 //#endregion
 exports.ConfigFileName = ConfigFileName;
-Object.defineProperty(exports, 'DependencyGroup', {
-  enumerable: true,
-  get: function () {
-    return _alextheman_utility_internal.DependencyGroup;
-  }
+Object.defineProperty(exports, "DependencyGroup", {
+	enumerable: true,
+	get: function() {
+		return _alextheman_utility_internal.DependencyGroup;
+	}
 });
 exports.PullRequestTemplateCategory = PullRequestTemplateCategory;
 exports.defineAlexCLineConfig = defineAlexCLineConfig;
 exports.defineAlexCLinePrivateConfig = defineAlexCLinePrivateConfig;
 exports.defineCreatePullRequestTemplateConfig = defineCreatePullRequestTemplateConfig;
 exports.definePreCommitConfig = definePreCommitConfig;
-exports.definePreCommitPrivateConfig = definePreCommitPrivateConfig;
+exports.definePreCommitPrivateConfig = definePreCommitPrivateConfig;

package/dist/configs/index.d.cts

@@ -9,14 +9,14 @@ interface BaseOptions {
 }
 interface StepRunner<ExecaOptions extends Options = BaseOptions> {
   <NewOpts extends Options>(options: NewOpts): StepRunner<ExecaOptions & NewOpts>;
-  (command: string, args?: readonly string[]): Promise<Result<ExecaOptions>>;
-  (strings: TemplateStringsArray, ...interpolations: TemplateExpression[]): Promise<Result<ExecaOptions>>;
+  (command: string, args?: ReadonlyArray<string>): Promise<Result<ExecaOptions>>;
+  (strings: TemplateStringsArray, ...interpolations: Array<TemplateExpression>): Promise<Result<ExecaOptions>>;
 }
 //#endregion
 //#region src/configs/types/preCommit/PreCommitConfig.d.ts
 interface PreCommitStepOptions {
   /** Arguments to pass to the given script */
-  arguments?: string[];
+  arguments?: Array<string>;
 }
 type StepFunction = (stepRunner: StepRunner) => void | Promise<void>;
 interface PreCommitConfig<ScriptName extends string = string> {
@@ -25,7 +25,7 @@ interface PreCommitConfig<ScriptName extends string = string> {
   /** Allow the hook to run even if there are no staged changes. */
   allowNoStagedChanges?: boolean;
   /** The steps to run in the pre-commit hook. */
-  steps: (StepFunction | ScriptName | [ScriptName, PreCommitStepOptions])[];
+  steps: Array<StepFunction | ScriptName | [ScriptName, PreCommitStepOptions]>;
   /** Update the git index after the run */
   updateIndex?: boolean;
 }
@@ -96,7 +96,7 @@ declare function definePreCommitConfig<ScriptName extends string = string>(confi
 //#region src/configs/types/preCommit/PreCommitPrivateConfig.d.ts
 interface PreCommitPrivateConfig<ScriptName extends string = string> {
   /** List of script names to skip */
-  disableSteps?: ScriptName[];
+  disableSteps?: Array<ScriptName>;
 }
 //#endregion
 //#region src/configs/helpers/preCommit/definePreCommitPrivateConfig.d.ts

package/dist/configs/index.d.ts

@@ -10,14 +10,14 @@ interface BaseOptions {
 }
 interface StepRunner<ExecaOptions extends Options = BaseOptions> {
   <NewOpts extends Options>(options: NewOpts): StepRunner<ExecaOptions & NewOpts>;
-  (command: string, args?: readonly string[]): Promise<Result<ExecaOptions>>;
-  (strings: TemplateStringsArray, ...interpolations: TemplateExpression[]): Promise<Result<ExecaOptions>>;
+  (command: string, args?: ReadonlyArray<string>): Promise<Result<ExecaOptions>>;
+  (strings: TemplateStringsArray, ...interpolations: Array<TemplateExpression>): Promise<Result<ExecaOptions>>;
 }
 //#endregion
 //#region src/configs/types/preCommit/PreCommitConfig.d.ts
 interface PreCommitStepOptions {
   /** Arguments to pass to the given script */
-  arguments?: string[];
+  arguments?: Array<string>;
 }
 type StepFunction = (stepRunner: StepRunner) => void | Promise<void>;
 interface PreCommitConfig<ScriptName extends string = string> {
@@ -26,7 +26,7 @@ interface PreCommitConfig<ScriptName extends string = string> {
   /** Allow the hook to run even if there are no staged changes. */
   allowNoStagedChanges?: boolean;
   /** The steps to run in the pre-commit hook. */
-  steps: (StepFunction | ScriptName | [ScriptName, PreCommitStepOptions])[];
+  steps: Array<StepFunction | ScriptName | [ScriptName, PreCommitStepOptions]>;
   /** Update the git index after the run */
   updateIndex?: boolean;
 }
@@ -97,7 +97,7 @@ declare function definePreCommitConfig<ScriptName extends string = string>(confi
 //#region src/configs/types/preCommit/PreCommitPrivateConfig.d.ts
 interface PreCommitPrivateConfig<ScriptName extends string = string> {
   /** List of script names to skip */
-  disableSteps?: ScriptName[];
+  disableSteps?: Array<ScriptName>;
 }
 //#endregion
 //#region src/configs/helpers/preCommit/definePreCommitPrivateConfig.d.ts

package/dist/configs/index.js

@@ -1,7 +1,6 @@
 import "@alextheman/utility";
 import z from "zod";
 import { DependencyGroup, PackageManager } from "@alextheman/utility/internal";
-
 //#region src/configs/helpers/preCommit/definePreCommitConfig.ts
 const preCommitStepOptionsSchema = z.strictObject({ arguments: z.array(z.string()).optional() });
 const preCommitConfigSchema = z.strictObject({
@@ -20,7 +19,6 @@ const preCommitConfigSchema = z.strictObject({
 function definePreCommitConfig(config) {
 	return config;
 }
-
 //#endregion
 //#region src/configs/helpers/template/pullRequest/defineTemplatePullRequestSchema.ts
 const templatePullRequestBaseSchema = z.strictObject({ projectName: z.string().optional() });
@@ -35,17 +33,13 @@ const templatePullRequestSchema = z.discriminatedUnion("category", [templatePull
 function defineCreatePullRequestTemplateConfig(config) {
 	return config;
 }
-
-//#endregion
-//#region src/configs/helpers/defineAlexCLineConfig.ts
-const alexCLineConfigSchema = z.strictObject({
+z.strictObject({
 	preCommit: preCommitConfigSchema,
 	template: z.object({ pullRequest: templatePullRequestSchema })
 }).partial();
 function defineAlexCLineConfig(config) {
 	return config;
 }
-
 //#endregion
 //#region src/configs/types/ConfigFileName.ts
 const ConfigFileName = {
@@ -53,17 +47,13 @@ const ConfigFileName = {
 	ES_MODULES_JAVASCRIPT: "alex-c-line.config.mjs",
 	COMMON_JS_JAVASCRIPT: "alex-c-line.config.cjs"
 };
-
 //#endregion
 //#region src/configs/types/template/pullRequest/PullRequestTemplateCategory.ts
 const PullRequestTemplateCategory = {
 	GENERAL: "general",
 	INFRASTRUCTURE: "infrastructure"
 };
-
-//#endregion
-//#region src/configs/helpers/defineAlexCLinePrivateConfig.ts
-const alexCLinePrivateConfigSchema = z.object({ localPackage: z.strictObject({
+z.object({ localPackage: z.strictObject({
 	enableCache: z.boolean().optional(),
 	localPackages: z.record(z.string(), z.strictObject({
 		packageManager: z.enum(PackageManager),
@@ -76,13 +66,9 @@ const alexCLinePrivateConfigSchema = z.object({ localPackage: z.strictObject({
 function defineAlexCLinePrivateConfig(config) {
 	return config;
 }
-
-//#endregion
-//#region src/configs/helpers/preCommit/definePreCommitPrivateConfig.ts
-const preCommitPrivateConfigSchema = z.strictObject({ disableSteps: z.array(z.string()).optional() });
+z.strictObject({ disableSteps: z.array(z.string()).optional() });
 function definePreCommitPrivateConfig(config) {
 	return config;
 }
-
 //#endregion
-export { ConfigFileName, DependencyGroup, PullRequestTemplateCategory, defineAlexCLineConfig, defineAlexCLinePrivateConfig, defineCreatePullRequestTemplateConfig, definePreCommitConfig, definePreCommitPrivateConfig };
+export { ConfigFileName, DependencyGroup, PullRequestTemplateCategory, defineAlexCLineConfig, defineAlexCLinePrivateConfig, defineCreatePullRequestTemplateConfig, definePreCommitConfig, definePreCommitPrivateConfig };

package/dist/configs/internal/index.cjs

@@ -1,5 +1,4 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/configs/internal/alexCLineConfig.ts
 const alexCLineConfig = {
 	preCommit: {
@@ -16,7 +15,6 @@ const alexCLineConfig = {
 		projectType: "package"
 	} }
 };
-
 //#endregion
 //#region src/configs/internal/infrastructureConfig.ts
 const infrastructureConfig = {
@@ -36,7 +34,6 @@ const infrastructureConfig = {
 		requireConfirmationFrom: "AlexMan123456"
 	} }
 };
-
 //#endregion
 //#region src/configs/internal/packageConfig.ts
 function packageConfig(steps = [
@@ -56,7 +53,6 @@ function packageConfig(steps = [
 		} }
 	};
 }
-
 //#endregion
 //#region src/configs/internal/testConfig.ts
 const testConfig = {
@@ -70,9 +66,8 @@ const testConfig = {
 		projectType: "package"
 	} }
 };
-
 //#endregion
 exports.alexCLineConfig = alexCLineConfig;
 exports.infrastructureConfig = infrastructureConfig;
 exports.packageConfig = packageConfig;
-exports.testConfig = testConfig;
+exports.testConfig = testConfig;

package/dist/configs/internal/index.d.cts

@@ -8,14 +8,14 @@ interface BaseOptions {
 }
 interface StepRunner<ExecaOptions extends Options = BaseOptions> {
   <NewOpts extends Options>(options: NewOpts): StepRunner<ExecaOptions & NewOpts>;
-  (command: string, args?: readonly string[]): Promise<Result<ExecaOptions>>;
-  (strings: TemplateStringsArray, ...interpolations: TemplateExpression[]): Promise<Result<ExecaOptions>>;
+  (command: string, args?: ReadonlyArray<string>): Promise<Result<ExecaOptions>>;
+  (strings: TemplateStringsArray, ...interpolations: Array<TemplateExpression>): Promise<Result<ExecaOptions>>;
 }
 //#endregion
 //#region src/configs/types/preCommit/PreCommitConfig.d.ts
 interface PreCommitStepOptions {
   /** Arguments to pass to the given script */
-  arguments?: string[];
+  arguments?: Array<string>;
 }
 type StepFunction = (stepRunner: StepRunner) => void | Promise<void>;
 interface PreCommitConfig<ScriptName extends string = string> {
@@ -24,7 +24,7 @@ interface PreCommitConfig<ScriptName extends string = string> {
   /** Allow the hook to run even if there are no staged changes. */
   allowNoStagedChanges?: boolean;
   /** The steps to run in the pre-commit hook. */
-  steps: (StepFunction | ScriptName | [ScriptName, PreCommitStepOptions])[];
+  steps: Array<StepFunction | ScriptName | [ScriptName, PreCommitStepOptions]>;
   /** Update the git index after the run */
   updateIndex?: boolean;
 }
@@ -114,7 +114,7 @@ declare const PreCommitStep: {
 type PreCommitStep = "build" | "format" | "lint" | "test";
 //#endregion
 //#region src/configs/internal/packageConfig.d.ts
-declare function packageConfig<ScriptName extends string = PreCommitStep>(steps?: (StepFunction | ScriptName | PreCommitStep | [ScriptName | PreCommitStep, PreCommitStepOptions])[]): AlexCLineConfig<PreCommitStep>;
+declare function packageConfig<ScriptName extends string = PreCommitStep>(steps?: Array<StepFunction | ScriptName | PreCommitStep | [ScriptName | PreCommitStep, PreCommitStepOptions]>): AlexCLineConfig<PreCommitStep>;
 //#endregion
 //#region src/configs/internal/testConfig.d.ts
 declare const testConfig: AlexCLineConfig<"artwork">;

package/dist/configs/internal/index.d.ts

@@ -1,7 +1,5 @@
 import { PackageManager } from "@alextheman/utility/internal";
 import { Options, Result, TemplateExpression } from "execa";
-import "@alextheman/utility";
-
 //#region src/cli/commands/root/pre-commit/createStepRunner.d.ts
 interface BaseOptions {
   stdio: "inherit";
@@ -9,14 +7,14 @@ interface BaseOptions {
 }
 interface StepRunner<ExecaOptions extends Options = BaseOptions> {
   <NewOpts extends Options>(options: NewOpts): StepRunner<ExecaOptions & NewOpts>;
-  (command: string, args?: readonly string[]): Promise<Result<ExecaOptions>>;
-  (strings: TemplateStringsArray, ...interpolations: TemplateExpression[]): Promise<Result<ExecaOptions>>;
+  (command: string, args?: ReadonlyArray<string>): Promise<Result<ExecaOptions>>;
+  (strings: TemplateStringsArray, ...interpolations: Array<TemplateExpression>): Promise<Result<ExecaOptions>>;
 }
 //#endregion
 //#region src/configs/types/preCommit/PreCommitConfig.d.ts
 interface PreCommitStepOptions {
   /** Arguments to pass to the given script */
-  arguments?: string[];
+  arguments?: Array<string>;
 }
 type StepFunction = (stepRunner: StepRunner) => void | Promise<void>;
 interface PreCommitConfig<ScriptName extends string = string> {
@@ -25,7 +23,7 @@ interface PreCommitConfig<ScriptName extends string = string> {
   /** Allow the hook to run even if there are no staged changes. */
   allowNoStagedChanges?: boolean;
   /** The steps to run in the pre-commit hook. */
-  steps: (StepFunction | ScriptName | [ScriptName, PreCommitStepOptions])[];
+  steps: Array<StepFunction | ScriptName | [ScriptName, PreCommitStepOptions]>;
   /** Update the git index after the run */
   updateIndex?: boolean;
 }
@@ -115,7 +113,7 @@ declare const PreCommitStep: {
 type PreCommitStep = "build" | "format" | "lint" | "test";
 //#endregion
 //#region src/configs/internal/packageConfig.d.ts
-declare function packageConfig<ScriptName extends string = PreCommitStep>(steps?: (StepFunction | ScriptName | PreCommitStep | [ScriptName | PreCommitStep, PreCommitStepOptions])[]): AlexCLineConfig<PreCommitStep>;
+declare function packageConfig<ScriptName extends string = PreCommitStep>(steps?: Array<StepFunction | ScriptName | PreCommitStep | [ScriptName | PreCommitStep, PreCommitStepOptions]>): AlexCLineConfig<PreCommitStep>;
 //#endregion
 //#region src/configs/internal/testConfig.d.ts
 declare const testConfig: AlexCLineConfig<"artwork">;

package/dist/configs/internal/index.js

@@ -14,7 +14,6 @@ const alexCLineConfig = {
 		projectType: "package"
 	} }
 };
-
 //#endregion
 //#region src/configs/internal/infrastructureConfig.ts
 const infrastructureConfig = {
@@ -34,7 +33,6 @@ const infrastructureConfig = {
 		requireConfirmationFrom: "AlexMan123456"
 	} }
 };
-
 //#endregion
 //#region src/configs/internal/packageConfig.ts
 function packageConfig(steps = [
@@ -54,7 +52,6 @@ function packageConfig(steps = [
 		} }
 	};
 }
-
 //#endregion
 //#region src/configs/internal/testConfig.ts
 const testConfig = {
@@ -68,6 +65,5 @@ const testConfig = {
 		projectType: "package"
 	} }
 };
-
 //#endregion
-export { alexCLineConfig, infrastructureConfig, packageConfig, testConfig };
+export { alexCLineConfig, infrastructureConfig, packageConfig, testConfig };