@repokit/core 4.0.5 → 5.0.0

package/README.md

@@ -4,7 +4,7 @@
 
 A knowledgebase for your repository - wrapped in a CLI.
 
-Repokit is designed for large teams in complex codebases to publish self-documenting commands, API's, and workflows to a central CLI.
+Repokit is designed for large teams in complex codebases to publish self-documenting commands, API's, and workflows to a central repository-owned CLI.
 
 The Repokit CLI exists as a living source of documentation and knowledge - growing alongside your team.
 
@@ -12,7 +12,20 @@ The Repokit CLI exists as a living source of documentation and knowledge - growi
 
 ### Installation
 
-If you do not have node.js setup in your repository, you'll first want to install node.js.
+Installation requires `rust` and `node.js` installed on your machine
+
+#### Rust Installation
+
+```bash
+# install rust
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+# install repokit
+cargo install repokit
+```
+
+#### Node.js
+
+If you do not have node.js setup on your machine, you'll first want to install node.js.
 
 [NVM is a popular posix compliant installer](https://github.com/nvm-sh/nvm)
 
@@ -25,10 +38,10 @@ npm init
 If you don't have `typescript` already setup in your repository, you can run:
 
 ```bash
-npm i -D typescript && tsc --init
+npm i -D typescript && npx tsc --init
 ```
 
-Next, install repokit:
+Next, install repokit's command definition library:
 
 ```bash
 npm i -D @repokit/core

package/dist/types.d.mts

@@ -1,7 +1,7 @@
 import { RepoKitConfig } from "./RepoKitConfig.mjs";
 
 //#region externals/types.d.ts
-interface IRepoKitConfig extends Omit<Partial<RepoKitConfig>, "project"> {
+interface IRepoKitConfig extends Omit<Partial<RepoKitConfig>, "project" | "toScoped"> {
   project: string;
 }
 interface IRepoKitCommand {

package/externals/TSCompiler.ts

@@ -1,5 +1,4 @@
-import type { RegisterOptions } from "ts-node";
-import { register } from "ts-node";
+import { register, type RegisterOptions } from "ts-node";
 
 import type { UnwrappedBrigdeOperation } from "./types";
 

package/externals/types.ts

@@ -2,7 +2,7 @@ import type { RepoKitConfig } from "./RepoKitConfig";
 
 export interface IRepoKitConfig extends Omit<
   Partial<RepoKitConfig>,
-  "project"
+  "project" | "toScoped"
 > {
   project: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@repokit/core",
-  "version": "4.0.5",
+  "version": "5.0.0",
   "description": "A knowledgebase for your repository - wrapped in a CLI",
   "keywords": [
     "cli",
@@ -18,11 +18,7 @@
   "files": [
     "media",
     "dist",
-    "externals",
-    "internals",
-    "installation",
-    "Cargo.lock",
-    "Cargo.toml"
+    "externals"
   ],
   "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
@@ -31,19 +27,19 @@
     "access": "public"
   },
   "scripts": {
-    "build:all": "pnpm lint:ts && pnpm lint:rust && pnpm install:rust",
-    "build:rust": "cargo build --release",
+    "build": "pnpm build:debug --release",
+    "build:debug": "pnpm build:ts && cargo build",
     "build:ts": "tsx devserver/run.ts",
     "clean:ts": "tsx devserver/run.ts -c",
-    "grant:exec": "chmod -R +x ./installation",
-    "install:rust": "pnpm build:rust && cargo install --path .",
-    "lint:all": "pnpm lint:ts && pnpm lint:rust",
-    "lint:rust": "cargo clippy --fix --allow-dirty",
-    "lint:ts": "oxlint --type-aware --type-check --report-unused-disable-directives --fix && oxfmt",
+    "format:toml": "taplo lint && taplo format",
+    "lint:all": "pnpm lint:rust && pnpm lint:ts",
+    "lint:rust": "cargo clippy --fix --allow-dirty --allow-no-vcs && pnpm format:toml",
+    "lint:rust:ci": "cargo clippy --fix",
+    "lint:ts": "oxlint --type-aware --report-unused-disable-directives --fix && oxfmt",
     "package:ts": "pnpm lint:ts && pnpm lint:rust && pnpm build:ts",
-    "postinstall": "pnpm grant:exec && ./installation/install.sh",
-    "repokit": "pnpm install:rust && repokit",
-    "run:dev": "pnpm build:ts && cargo run --package repokit --bin repokit",
+    "prepare": "husky",
+    "release": "tsx release/run.ts",
+    "run:dev": "pnpm build:ts && cargo run --bin repokit",
     "watch:ts": "tsx devserver/run.ts -w"
   },
   "dependencies": {
@@ -54,14 +50,27 @@
   "devDependencies": {
     "@figliolia/child-process": "^1.0.4",
     "@figliolia/semver": "^1.0.0",
+    "@taplo/cli": "^0.7.0",
     "@types/node": "^25.3.0",
-    "chalk": "^5.6.2",
-    "oxfmt": "^0.47.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.0.2",
+    "oxfmt": "^0.53.0",
     "oxlint": "^1.42.0",
-    "oxlint-tsgolint": "^0.22.0",
-    "tsdown": "^0.21.0",
+    "oxlint-tsgolint": "^0.23.0",
+    "tsdown": "^0.22.0",
     "tsx": "^4.21.0",
     "typescript": "^6.0.2"
   },
+  "lint-staged": {
+    "*.@(js|ts|tsx|yml|yaml|md|json)": [
+      "pnpm lint:ts"
+    ],
+    "*.toml": [
+      "pnpm format:toml"
+    ],
+    "*.rs": [
+      "pnpm lint:rust"
+    ]
+  },
   "packageManager": "pnpm@10.33.2"
 }