@repokit/core 2.0.7 → 3.0.0

package/Cargo.lock

@@ -27,6 +27,12 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
 [[package]]
 name = "colored"
 version = "3.1.1"
@@ -61,6 +67,38 @@ version = "0.8.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28"
 
+[[package]]
+name = "dirs"
+version = "6.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c3e8aa94d75141228480295a7d0e7feb620b1a5ad9f12bc40be62411e38cce4e"
+dependencies = [
+ "dirs-sys",
+]
+
+[[package]]
+name = "dirs-sys"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e01a3366d27ee9890022452ee61b2b63a67e6f13f58900b651ff5665f0bb1fab"
+dependencies = [
+ "libc",
+ "option-ext",
+ "redox_users",
+ "windows-sys",
+]
+
+[[package]]
+name = "getrandom"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ff2abc00be7fca6ebc474524697ae276ad847ad0a6b3faa4bcb027e9a4614ad0"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wasi",
+]
+
 [[package]]
 name = "globset"
 version = "0.4.18"
@@ -96,6 +134,21 @@ version = "1.0.17"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "92ecc6618181def0457392ccd0ee51198e065e016d1d527a7ac1b6dc7c1f09d2"
 
+[[package]]
+name = "libc"
+version = "0.2.183"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b5b646652bf6661599e1da8901b3b9522896f01e736bad5f723fe7a3a27f899d"
+
+[[package]]
+name = "libredox"
+version = "0.1.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7ddbf48fd451246b1f8c2610bd3b4ac0cc6e149d89832867093ab69a17194f08"
+dependencies = [
+ "libc",
+]
+
 [[package]]
 name = "log"
 version = "0.4.29"
@@ -114,6 +167,12 @@ version = "0.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "f5438dd2b2ff4c6df6e1ce22d825ed2fa93ee2922235cc45186991717f0a892d"
 
+[[package]]
+name = "option-ext"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d"
+
 [[package]]
 name = "pin-project-lite"
 version = "0.2.16"
@@ -131,13 +190,24 @@ dependencies = [
 
 [[package]]
 name = "quote"
-version = "1.0.44"
+version = "1.0.45"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "21b2ebcf727b7760c461f091f9f0f539b77b8e87f2fd88131e7f1b433b3cece4"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
 dependencies = [
  "proc-macro2",
 ]
 
+[[package]]
+name = "redox_users"
+version = "0.5.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a4e608c6638b9c18977b00b475ac1f28d14e84b27d8d42f70e0bf1e3dec127ac"
+dependencies = [
+ "getrandom",
+ "libredox",
+ "thiserror",
+]
+
 [[package]]
 name = "regex"
 version = "1.12.3"
@@ -169,7 +239,7 @@ checksum = "a96887878f22d7bad8a3b6dc5b7440e0ada9a245242924394987b21cf2210a4c"
 
 [[package]]
 name = "repokit"
-version = "2.0.7"
+version = "3.0.0"
 dependencies = [
  "alphanumeric-sort",
  "colored",
@@ -178,6 +248,7 @@ dependencies = [
  "regex",
  "serde",
  "serde_json",
+ "shellexpand",
  "tokio",
 ]
 
@@ -233,22 +304,51 @@ dependencies = [
  "zmij",
 ]
 
+[[package]]
+name = "shellexpand"
+version = "3.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32824fab5e16e6c4d86dc1ba84489390419a39f97699852b66480bb87d297ed8"
+dependencies = [
+ "dirs",
+]
+
 [[package]]
 name = "syn"
-version = "2.0.114"
+version = "2.0.117"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d4d107df263a3013ef9b1879b0df87d706ff80f65a86ea879bd9c31f9b307c2a"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
 dependencies = [
  "proc-macro2",
  "quote",
  "unicode-ident",
 ]
 
+[[package]]
+name = "thiserror"
+version = "2.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4288b5bcbc7920c07a1149a35cf9590a2aa808e0bc1eafaade0b80947865fbc4"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "2.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ebc4ee7f67670e9b64d05fa4253e753e016c6c95ff35b89b7941d6b856dec1d5"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "tokio"
-version = "1.49.0"
+version = "1.50.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "72a2903cd7736441aac9df9d7688bd0ce48edccaadf181c3b90be801e81d3d86"
+checksum = "27ad5e34374e03cfffefc301becb44e9dc3c17584f414349ebe29ed26661822d"
 dependencies = [
  "pin-project-lite",
 ]
@@ -269,6 +369,12 @@ dependencies = [
  "winapi-util",
 ]
 
+[[package]]
+name = "wasi"
+version = "0.11.1+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b"
+
 [[package]]
 name = "winapi-util"
 version = "0.1.11"

package/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "repokit"
-version = "2.0.7"
+version = "3.0.0"
 edition = "2024"
 
 [[bin]]
@@ -13,6 +13,7 @@ serde_json = "1.0"
 colored = "3"
 normalize-path = "0.2.1"
 alphanumeric-sort = "1.5.5"
-tokio = "1.49.0"
+tokio = "1.50.0"
 ignore = "0.4.25"
 regex = { version = "1.12.3", features = ["std", "unicode"] }
+shellexpand = "3.1.2"

package/README.md

@@ -228,6 +228,51 @@ The commands you register onto the repokit toolchain will always be invoked usin
 
 If your command needs to reason about the file system, keep this in mind.
 
+### Themes
+
+The Repokit CLI can be customized to support themes that better match your team's visual preferences.
+
+Repokit comes with 4 pre-built themes that you can use in your `RepoKitConfig`.
+
+```typescript
+import {
+  RepoKitConfig,
+  SeeingRed, // A red theme
+  TheBlues, // A blue theme
+  Green, // A green theme
+} from "@repokit/core";
+
+export const Kit = new RepoKitConfig({
+  project: "My Project",
+  theme: SeeingRed, // Specify a theme here
+});
+```
+
+By omitting the `theme` property `RepoKit` will use its default visuals.
+
+In addition to built-in themes, you can create your own using the `RepoKitTheme`
+
+```typescript
+import { RepoKitConfig, RepoKitTheme } from "@repokit/core";
+
+export const Kit = new RepoKitConfig({
+  project: "My Project",
+  theme: new RepoKitTheme({
+    prefixColor: "rgb(220, 36, 91)",
+    commandColor: "rgb(220, 36, 36)",
+    subcommandColor: "rgb(220, 131, 36)",
+    argColor: "rgb(220, 205, 36)",
+    descriptionColor: "rgb(179, 100, 151)",
+    errorPrefixColor: "rgb(220, 36, 39)",
+    highlightColor: "rgb(237, 175, 41)",
+  }),
+});
+```
+
+All properties on the `RepoKitTheme` are optional overrides for `RepoKit`'s default styling. A color can be any CSS-valid `rgb()` string.
+
+<img src="media/seeing-red.webp" width="100%" alt="seeing red theme" />
+
 ## Motivation
 
 I worked in a codebase at Google that used just about every programming language in existence. Each team had their own methodology for exposing commands, scripts, and API's for their team's day-to-day development needs.

package/dist/RepoKitConfig.d.mts

@@ -1,13 +1,16 @@
+import { RepoKitTheme } from "./RepoKitTheme.mjs";
 import { ICommand, IRepoKitConfig } from "./types.mjs";
 import { RepoKitCommand } from "./RepoKitCommand.mjs";
 
 //#region externals/RepoKitConfig.d.ts
-declare class RepoKitConfig implements Required<IRepoKitConfig> {
+declare class RepoKitConfig {
   project: string;
+  themes: RepoKitTheme[];
   thirdParty: RepoKitCommand[];
   commands: Record<string, ICommand>;
   constructor({
     project,
+    themes,
     commands,
     thirdParty
   }: IRepoKitConfig);

package/dist/RepoKitConfig.mjs

@@ -2,9 +2,11 @@ import { RepoKitCommand } from "./RepoKitCommand.mjs";
 //#region externals/RepoKitConfig.ts
 var RepoKitConfig = class {
 	project;
+	themes;
 	thirdParty;
 	commands;
-	constructor({ project, commands = {}, thirdParty = [] }) {
+	constructor({ project, themes = [], commands = {}, thirdParty = [] }) {
+		this.themes = themes;
 		this.project = project;
 		this.commands = commands;
 		this.thirdParty = thirdParty.map((command) => new RepoKitCommand(command));

package/dist/RepoKitTheme.d.mts

@@ -0,0 +1,47 @@
+import { IRepoKitTheme, RepoKitThemeColors } from "./types.mjs";
+
+//#region externals/RepoKitTheme.d.ts
+/**
+ * Repokit Theme
+ *
+ * A repokit theme allows you to customize the color
+ * usage of the CLI by adding a `RepoKitTheme` instance
+ * to your `RepoKitConfig`
+ *
+ * ```typescript
+ * import { RepoKitConfig, RepoKitTheme } from "@repokit/core";
+ *
+ * export const RepoKit = new RepoKitConfig({
+ *   project: "Repokit",
+ *   themes: [
+ *     new RepoKitTheme({
+ *       name: "my-theme",
+ *       colors: {
+ *         prefixColor: "rgb(220, 36, 91)",
+ *         commandColor: "rgb(220, 36, 36)",
+ *         subcommandColor: "rgb(220, 131, 36)",
+ *         argColor: "rgb(220, 205, 36)",
+ *         descriptionColor: "rgb(95, 28, 71)",
+ *         errorPrefixColor: "rgb(220, 36, 39)",
+ *         hightlightColor: "rgb(8, 98, 255)",
+ *       }
+ *     }),
+ *   ]
+ * });
+ * ```
+ *
+ * To enable your theme you can run
+ * ```bash
+ * repokit themes --set my-theme
+ * ```
+ */
+declare class RepoKitTheme implements IRepoKitTheme {
+  readonly name: string;
+  readonly colors: RepoKitThemeColors;
+  constructor({
+    name,
+    colors
+  }: IRepoKitTheme);
+}
+//#endregion
+export { RepoKitTheme };

package/dist/RepoKitTheme.mjs

@@ -0,0 +1,45 @@
+//#region externals/RepoKitTheme.ts
+/**
+* Repokit Theme
+*
+* A repokit theme allows you to customize the color
+* usage of the CLI by adding a `RepoKitTheme` instance
+* to your `RepoKitConfig`
+*
+* ```typescript
+* import { RepoKitConfig, RepoKitTheme } from "@repokit/core";
+*
+* export const RepoKit = new RepoKitConfig({
+*   project: "Repokit",
+*   themes: [
+*     new RepoKitTheme({
+*       name: "my-theme",
+*       colors: {
+*         prefixColor: "rgb(220, 36, 91)",
+*         commandColor: "rgb(220, 36, 36)",
+*         subcommandColor: "rgb(220, 131, 36)",
+*         argColor: "rgb(220, 205, 36)",
+*         descriptionColor: "rgb(95, 28, 71)",
+*         errorPrefixColor: "rgb(220, 36, 39)",
+*         hightlightColor: "rgb(8, 98, 255)",
+*       }
+*     }),
+*   ]
+* });
+* ```
+*
+* To enable your theme you can run
+* ```bash
+* repokit themes --set my-theme
+* ```
+*/
+var RepoKitTheme = class {
+	name;
+	colors;
+	constructor({ name, colors }) {
+		this.name = name;
+		this.colors = colors;
+	}
+};
+//#endregion
+export { RepoKitTheme };

package/dist/index.d.mts

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

package/dist/index.mjs

@@ -1,3 +1,4 @@
 import { RepoKitCommand } from "./RepoKitCommand.mjs";
 import { RepoKitConfig } from "./RepoKitConfig.mjs";
-export { RepoKitCommand, RepoKitConfig };
+import { RepoKitTheme } from "./RepoKitTheme.mjs";
+export { RepoKitCommand, RepoKitConfig, RepoKitTheme };

package/dist/types.d.mts

@@ -1,10 +1,8 @@
-import { RepoKitCommand } from "./RepoKitCommand.mjs";
+import { RepoKitConfig } from "./RepoKitConfig.mjs";
 
 //#region externals/types.d.ts
-interface IRepoKitConfig {
+interface IRepoKitConfig extends Omit<Partial<RepoKitConfig>, "project"> {
   project: string;
-  thirdParty?: RepoKitCommand[];
-  commands?: Record<string, ICommand>;
 }
 interface IRepoKitCommand {
   name: string;
@@ -21,5 +19,20 @@ interface ILocatedCommand extends IRepoKitCommand {
   location: string;
 }
 type AsyncTask<T> = () => Promise<T>;
+type OptionalSpace = " " | "";
+type RGBString = `rgb(${number},${OptionalSpace}${number},${OptionalSpace}${number})`;
+interface RepoKitThemeColors {
+  prefixColor?: RGBString;
+  commandColor?: RGBString;
+  subcommandColor?: RGBString;
+  argColor?: RGBString;
+  descriptionColor?: RGBString;
+  errorPrefixColor?: RGBString;
+  highlightColor?: RGBString;
+}
+interface IRepoKitTheme {
+  name: string;
+  colors: RepoKitThemeColors;
+}
 //#endregion
-export { AsyncTask, ICommand, ILocatedCommand, IRepoKitCommand, IRepoKitConfig };
+export { AsyncTask, ICommand, ILocatedCommand, IRepoKitCommand, IRepoKitConfig, IRepoKitTheme, RGBString, RepoKitThemeColors };

package/externals/RepoKitConfig.ts

@@ -1,12 +1,20 @@
 import { RepoKitCommand } from "./RepoKitCommand";
+import type { RepoKitTheme } from "./RepoKitTheme";
 import type { ICommand, IRepoKitConfig } from "./types";
 /* eslint-disable typescript-eslint(no-misused-spread */
 
-export class RepoKitConfig implements Required<IRepoKitConfig> {
+export class RepoKitConfig {
   project: string;
+  themes: RepoKitTheme[];
   thirdParty: RepoKitCommand[];
   commands: Record<string, ICommand>;
-  constructor({ project, commands = {}, thirdParty = [] }: IRepoKitConfig) {
+  constructor({
+    project,
+    themes = [],
+    commands = {},
+    thirdParty = [],
+  }: IRepoKitConfig) {
+    this.themes = themes;
     this.project = project;
     this.commands = commands;
     this.thirdParty = thirdParty.map(command => new RepoKitCommand(command));

package/externals/RepoKitTheme.ts

@@ -0,0 +1,44 @@
+import type { IRepoKitTheme, RepoKitThemeColors } from "./types";
+
+/**
+ * Repokit Theme
+ *
+ * A repokit theme allows you to customize the color
+ * usage of the CLI by adding a `RepoKitTheme` instance
+ * to your `RepoKitConfig`
+ *
+ * ```typescript
+ * import { RepoKitConfig, RepoKitTheme } from "@repokit/core";
+ *
+ * export const RepoKit = new RepoKitConfig({
+ *   project: "Repokit",
+ *   themes: [
+ *     new RepoKitTheme({
+ *       name: "my-theme",
+ *       colors: {
+ *         prefixColor: "rgb(220, 36, 91)",
+ *         commandColor: "rgb(220, 36, 36)",
+ *         subcommandColor: "rgb(220, 131, 36)",
+ *         argColor: "rgb(220, 205, 36)",
+ *         descriptionColor: "rgb(95, 28, 71)",
+ *         errorPrefixColor: "rgb(220, 36, 39)",
+ *         hightlightColor: "rgb(8, 98, 255)",
+ *       }
+ *     }),
+ *   ]
+ * });
+ * ```
+ *
+ * To enable your theme you can run
+ * ```bash
+ * repokit themes --set my-theme
+ * ```
+ */
+export class RepoKitTheme implements IRepoKitTheme {
+  public readonly name: string;
+  public readonly colors: RepoKitThemeColors;
+  constructor({ name, colors }: IRepoKitTheme) {
+    this.name = name;
+    this.colors = colors;
+  }
+}

package/externals/index.ts

@@ -1,3 +1,4 @@
 export * from "./RepoKitCommand";
 export * from "./RepoKitConfig";
+export * from "./RepoKitTheme";
 export * from "./types";

package/externals/types.ts

@@ -1,9 +1,10 @@
-import type { RepoKitCommand } from "./RepoKitCommand";
+import type { RepoKitConfig } from "./RepoKitConfig";
 
-export interface IRepoKitConfig {
+export interface IRepoKitConfig extends Omit<
+  Partial<RepoKitConfig>,
+  "project"
+> {
   project: string;
-  thirdParty?: RepoKitCommand[];
-  commands?: Record<string, ICommand>;
 }
 
 export interface IRepoKitCommand {
@@ -24,3 +25,23 @@ export interface ILocatedCommand extends IRepoKitCommand {
 }
 
 export type AsyncTask<T> = () => Promise<T>;
+
+type OptionalSpace = " " | "";
+
+export type RGBString =
+  `rgb(${number},${OptionalSpace}${number},${OptionalSpace}${number})`;
+
+export interface RepoKitThemeColors {
+  prefixColor?: RGBString;
+  commandColor?: RGBString;
+  subcommandColor?: RGBString;
+  argColor?: RGBString;
+  descriptionColor?: RGBString;
+  errorPrefixColor?: RGBString;
+  highlightColor?: RGBString;
+}
+
+export interface IRepoKitTheme {
+  name: string;
+  colors: RepoKitThemeColors;
+}

package/installation/install.sh

@@ -1,4 +1,4 @@
-CURRENT_VERSION="2.0.7"
+CURRENT_VERSION="3.0.0"
 CWD=$(pwd)
 
 REPLACEMENT="/node_modules"
@@ -36,8 +36,14 @@ if [ -f .repokit ]; then
     fi
 fi
 
-touch ".repokit"
-printf "$CURRENT_VERSION" > ".repokit"
+DOT_FILE=".repokit"
+TEMP_FILE=".repokit_tmp";
+
+touch "$DOT_FILE"
+
+printf "$CURRENT_VERSION\n" > "$TEMP_FILE"
+tail +2 "$DOT_FILE" >> "$TEMP_FILE"
+mv "$TEMP_FILE" "$DOT_FILE"
 
 
 cd $CWD