@repokit/core 2.0.0 → 2.0.2

package/README.md

@@ -81,6 +81,8 @@ repokit
 
 The CLI will list out its internal commands as well as any commands you registered in your config file.
 
+<img src="media/post-init.webp" alt="Help screen after initialization" />
+
 Next run:
 
 ```bash
@@ -95,16 +97,49 @@ To begin building your CLI, run:
 repokit register ./path/to/your/feature
 ```
 
-This command generates a tool definition for your feature that you can fill out using your tool's API's. When complete, save the file and run:
+This command generates a tool definition for your feature that you can fill out using your tool's API's. A tool definition might look something like the following:
+
+```typescript
+import { RepoKitCommand } from "@repokit/core";
+
+export const Commands = new RepoKitCommand({
+  name: "user-interface",
+  description: "Build commands for the UI",
+  commands: {
+    "build:production": {
+      command: "vite build",
+      description: "Build the UI for production",
+      args: {
+        "(--optimization | -o)":
+          "Run post-build optimizers such as compression and css purging",
+      },
+    },
+    "run:development": {
+      command: "vite",
+      description: "Run the UI in development mode",
+      args: {
+        "(--port | -p)":
+          "Specifies the port number to run the development server on",
+        "(--open | -o)": "Opens your OS' preferred browser",
+      },
+    },
+  },
+});
+```
+
+When finished with your definition, save the file and run:
 
 ```bash
-repokit <your-tool-name>
+repokit user-interface
 ```
 
-The CLI will list out your new tool's API's. To invoke any of them, run:
+The CLI will list out your new tool's API's:
+<img src="media/new-command.webp" alt="Command definition" />
+
+To invoke any of them, run:
 
 ```bash
-repokit <your-tool-name> <your-command-name>
+repokit user-interface <sub-command> <args>
 ```
 
 ### Reasoning about your toolchain

package/dist/ConfigurationParser.mjs

@@ -1,5 +1,5 @@
-import { TSCompiler } from "./TSCompiler.mjs";
 import { RepoKitConfig } from "./RepoKitConfig.mjs";
+import { TSCompiler } from "./TSCompiler.mjs";
 import { existsSync } from "node:fs";
 import { join } from "node:path";
 import { parseArgs } from "node:util";

package/dist/RepoKitConfig.d.mts

@@ -1,5 +1,5 @@
-import { RepoKitCommand } from "./RepoKitCommand.mjs";
 import { ICommand, IRepoKitConfig } from "./types.mjs";
+import { RepoKitCommand } from "./RepoKitCommand.mjs";
 
 //#region externals/RepoKitConfig.d.ts
 declare class RepoKitConfig implements Required<IRepoKitConfig> {

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { RepoKitCommand } from "./RepoKitCommand.mjs";
 import { AsyncTask, ICommand, ILocatedCommand, IRepoKitCommand, IRepoKitConfig } from "./types.mjs";
+import { RepoKitCommand } from "./RepoKitCommand.mjs";
 import { RepoKitConfig } from "./RepoKitConfig.mjs";
 export { AsyncTask, ICommand, ILocatedCommand, IRepoKitCommand, IRepoKitConfig, RepoKitCommand, RepoKitConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@repokit/core",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "A knowledgebase for your repository - wrapped in a CLI",
   "keywords": [
     "cli",

package/dist/CommandParser.d.mts

@@ -1,10 +0,0 @@
-import { TSCompiler } from "./TSCompiler.mjs";
-
-//#region externals/CommandParser.d.ts
-declare class CommandParser extends TSCompiler {
-  static parse(): Promise<void>;
-  private static parseCommand;
-  private static parsePaths;
-}
-//#endregion
-export { CommandParser };

package/dist/ConcurrencyPool.d.mts

@@ -1,13 +0,0 @@
-import { AsyncTask } from "./types.mjs";
-
-//#region externals/ConcurrencyPool.d.ts
-declare class ConcurrencyPool<T> {
-  readonly maxConcurrency: number;
-  private readonly IDs;
-  private readonly activeTasks;
-  constructor(maxConcurrency?: number);
-  enqueue(task: AsyncTask<T>): Promise<T>;
-  private executeTask;
-}
-//#endregion
-export { ConcurrencyPool };

package/dist/ConcurrencyPool.mjs

@@ -1,22 +0,0 @@
-import { AutoIncrementingID } from "@figliolia/event-emitter";
-//#region externals/ConcurrencyPool.ts
-var ConcurrencyPool = class {
-	IDs = new AutoIncrementingID();
-	activeTasks = /* @__PURE__ */ new Map();
-	constructor(maxConcurrency = 10) {
-		this.maxConcurrency = maxConcurrency;
-	}
-	async enqueue(task) {
-		if (this.activeTasks.size === this.maxConcurrency) await Promise.race(Array.from(this.activeTasks.values()));
-		return this.executeTask(task);
-	}
-	executeTask(task) {
-		const ID = this.IDs.get();
-		const promise = task();
-		this.activeTasks.set(ID, promise);
-		promise.finally(() => this.activeTasks.delete(ID));
-		return promise;
-	}
-};
-//#endregion
-export { ConcurrencyPool };

package/dist/ConfigurationParser.d.mts

@@ -1,9 +0,0 @@
-import { TSCompiler } from "./TSCompiler.mjs";
-
-//#region externals/ConfigurationParser.d.ts
-declare class ConfigurationParser extends TSCompiler {
-  static parse(): void;
-  private static parseRoot;
-}
-//#endregion
-export { ConfigurationParser };

package/dist/TSCompiler.d.mts

@@ -1,8 +0,0 @@
-//#region externals/TSCompiler.d.ts
-declare class TSCompiler {
-  private static readonly compilerOptions;
-  static compile<T extends Record<string, unknown>>(path: string): T;
-  private static import;
-}
-//#endregion
-export { TSCompiler };

package/dist/templates/command_template.mjs

@@ -1,4 +0,0 @@
-//#region externals/templates/command_template.txt
-var command_template_default = "import { RepoKitCommand } from \"@repokit/core\";\n\n/**\n * Please fill out this command file with your desired settings\n */\nexport const Commands = new RepoKitCommand({\n  name: \"<Your Package Name>\",\n  owner: \"<Optional Team or Individual>\",\n  description: \"<Your Package Description>\",\n  commands: {\n    \"<your-first-command>\": {\n      command: \"<insert shell command here>\",\n      description: \"A description for your command\",\n    },\n    \"<your-second-command>\": {\n      command: \"<insert shell command here>\",\n      description: \"A description for your command\",\n    },\n    \"<your-third-command>\": {\n      command: \"<insert shell command here>\",\n      description: \"A description for your command\",\n    },\n  },\n});\n";
-//#endregion
-export { command_template_default as default };

package/dist/templates/configuration_template.mjs

@@ -1,4 +0,0 @@
-//#region externals/templates/configuration_template.txt
-var configuration_template_default = "import { RepoKitConfig } from \"@repokit/core\";\n\n/**\n * Please fill out this config file with your desired\n * repokit settings\n */\nexport const RepoKit = new RepoKitConfig({\n  project: \"Your Project Name\",\n  commands: {\n    \"<your-first-command>\": {\n      command: \"<insert shell command here>\",\n      description: \"A description for your command\",\n    },\n    \"<your-second-command>\": {\n      command: \"<insert shell command here>\",\n      description: \"A description for your command\",\n    },\n    \"<your-third-command>\": {\n      command: \"<insert shell command here>\",\n      description: \"A description for your command\",\n    },\n  },\n});\n";
-//#endregion
-export { configuration_template_default as default };

package/dist/types.mjs

@@ -1 +0,0 @@
-export {};