alex-c-line 1.26.0 → 1.26.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2026 alextheman231
+
+Permission is hereby granted, free
+of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice
+(including the next paragraph) shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+# alex-c-line
+
+![npm version](https://img.shields.io/npm/v/alex-c-line)
+![npm downloads](https://img.shields.io/npm/dm/alex-c-line)
+![npm license](https://img.shields.io/npm/l/alex-c-line)
+
+[![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>
+
+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.
+
+`alex-c-line` is designed to be developer-first, opinionated where it matters, and safe by default, especially when mutating repository state.
+
+## Installation
+
+To install the command-line tool, you can do this locally per working repository using the following command:
+
+```bash
+npm install alex-c-line
+```
+
+`npm` may be replaced with your package manager of choice.
+
+Alternatively, you can install it globally for usage all throughout your system, in any working repository. This will allow you to then use `alex-c-line` in repositories that may not even necessarily support it directly, so you can still feel the benefits of some of the more context-agnostic commands.
+
+```bash
+npm install -g alex-c-line
+```
+
+## Quick start
+
+You can use any command by typing out `alex-c-line` in the terminal, followed by the command you want to run. For example:
+
+```bash
+alex-c-line say-hello
+```
+
+Some commands may even take extra arguments. For example:
+
+```bash
+alex-c-line increment-version 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
+```
+
+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:
+
+```bash
+alex-c-line use-local-package alex-c-line -- increment-version 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.
+
+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.
+
+```javascript
+import { defineAlexCLineConfig } from "alex-c-line/configs";
+
+export default defineAlexCLineConfig({
+  createPullRequestTemplate: {
+    category: "general",
+    projectType: "package",
+  },
+  preCommit: {
+    packageManager: "pnpm",
+    steps: ["build", "format", "lint", "test"],
+  },
+})
+```
+
+Alternatively, you can create a TypeScript file, then build it to a pure JavaScript file, and the benefit of that is that you'd be able to use the types directly instead, which may be better as it even takes a type argument for the pre-commit steps.
+
+```typescript
+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",
+  },
+  preCommit: {
+    packageManager: "pnpm",
+    steps: ["build", "format", "lint", "test"],
+  },
+};
+
+export default alexCLineConfig;
+```
+
+Note, however, that we do not support directly running config files with TypeScript just yet. This may be planned in the near future, but for now, building the pure TypeScript file to pure JavaScript and using that as the config file is the best bet as of now.
+
+Private configs can be treated in the same way, except the type would be `AlexCLinePrivateConfig`, and the function `defineAlexCLinePrivateConfig`. Please also note that if you create a private config in a shared repository, it MUST be added to `.gitignore` so that it stays user-specific and does not get included in version control.
+
+## Documentation
+
+A full documentation site is coming soon. In the meantime, you may run `alex-c-line --help` for more information about how to use all commands.

package/dist/index.cjs

@@ -1575,16 +1575,18 @@ function formatError(error) {
 
 //#endregion
 //#region package.json
-var version = "1.26.0";
+var name = "alex-c-line";
+var version = "1.26.2";
+var description = "Command-line tool with commands to streamline the developer workflow.";
 var package_default = {
-	name: "alex-c-line",
+	name,
 	version,
-	description: "Command-line tool with commands to streamline the developer workflow.",
+	description,
 	repository: {
 		"type": "git",
 		"url": "git+https://github.com/alextheman231/alex-c-line.git"
 	},
-	license: "ISC",
+	license: "MIT",
 	author: "alextheman",
 	type: "module",
 	exports: {
@@ -1688,10 +1690,9 @@ var package_default = {
 (async () => {
 	try {
 		const program = new commander.Command();
-		program.name("alex-c-line").description("CLI tool built by Alex").version(version);
-		const notifier = (0, update_notifier.default)({ pkg: package_default });
-		await notifier.fetchInfo();
-		if (notifier.update) notifier.notify({ message: `${await createAlexCLineArtwork({ includeColors: Boolean(supports_color.default.stdout) })}
+		program.name(name).description(description).version(version);
+		(0, update_notifier.default)({ pkg: package_default }).notify({ message: `
+${await createAlexCLineArtwork({ includeColors: Boolean(supports_color.default.stdout) })}
 A new update of \`alex-c-line\` is available!
   {currentVersion} → {latestVersion}
 Run \`{updateCommand}\` to update.

package/dist/index.js

@@ -1537,16 +1537,18 @@ function formatError(error) {
 
 //#endregion
 //#region package.json
-var version = "1.26.0";
+var name = "alex-c-line";
+var version = "1.26.2";
+var description = "Command-line tool with commands to streamline the developer workflow.";
 var package_default = {
-	name: "alex-c-line",
+	name,
 	version,
-	description: "Command-line tool with commands to streamline the developer workflow.",
+	description,
 	repository: {
 		"type": "git",
 		"url": "git+https://github.com/alextheman231/alex-c-line.git"
 	},
-	license: "ISC",
+	license: "MIT",
 	author: "alextheman",
 	type: "module",
 	exports: {
@@ -1650,10 +1652,9 @@ var package_default = {
 (async () => {
 	try {
 		const program = new Command();
-		program.name("alex-c-line").description("CLI tool built by Alex").version(version);
-		const notifier = updateNotifier({ pkg: package_default });
-		await notifier.fetchInfo();
-		if (notifier.update) notifier.notify({ message: `${await createAlexCLineArtwork({ includeColors: Boolean(supportsColor.stdout) })}
+		program.name(name).description(description).version(version);
+		updateNotifier({ pkg: package_default }).notify({ message: `
+${await createAlexCLineArtwork({ includeColors: Boolean(supportsColor.stdout) })}
 A new update of \`alex-c-line\` is available!
   {currentVersion} → {latestVersion}
 Run \`{updateCommand}\` to update.

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "alex-c-line",
-  "version": "1.26.0",
+  "version": "1.26.2",
   "description": "Command-line tool with commands to streamline the developer workflow.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/alextheman231/alex-c-line.git"
   },
-  "license": "ISC",
+  "license": "MIT",
   "author": "alextheman",
   "type": "module",
   "exports": {