@ridit/forge 0.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc +111 -0
  2. package/README.md +87 -0
  3. package/dist/index.mjs +45649 -0
  4. package/index.ts +1 -0
  5. package/package.json +40 -0
  6. package/src/colors.ts +10 -0
  7. package/src/commands/add.tsx +152 -0
  8. package/src/commands/branch.tsx +150 -0
  9. package/src/commands/checkout.tsx +55 -0
  10. package/src/commands/commit.tsx +77 -0
  11. package/src/commands/init.tsx +45 -0
  12. package/src/commands/log.tsx +99 -0
  13. package/src/commands/status.tsx +77 -0
  14. package/src/index.tsx +80 -0
  15. package/src/types/add.ts +4 -0
  16. package/src/types/branch.ts +6 -0
  17. package/src/types/checkpoint.ts +7 -0
  18. package/src/types/commit.ts +16 -0
  19. package/src/types/files.ts +13 -0
  20. package/src/types/repo.ts +5 -0
  21. package/src/utils/add.ts +126 -0
  22. package/src/utils/branch.ts +590 -0
  23. package/src/utils/checkout.ts +57 -0
  24. package/src/utils/checkpoint.ts +52 -0
  25. package/src/utils/commit.ts +237 -0
  26. package/src/utils/forgeIgnore.ts +56 -0
  27. package/src/utils/objects.ts +28 -0
  28. package/src/utils/repo.ts +64 -0
  29. package/src/utils/status.ts +46 -0
  30. package/src/utils/switchEvents.ts +10 -0
  31. package/tsconfig.json +29 -0
package/.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc ADDED
@@ -0,0 +1,111 @@
1
+ ---
2
+ description: Use Bun instead of Node.js, npm, pnpm, or vite.
3
+ globs: "*.ts, *.tsx, *.html, *.css, *.js, *.jsx, package.json"
4
+ alwaysApply: false
5
+ ---
6
+
7
+ Default to using Bun instead of Node.js.
8
+
9
+ - Use `bun <file>` instead of `node <file>` or `ts-node <file>`
10
+ - Use `bun test` instead of `jest` or `vitest`
11
+ - Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild`
12
+ - Use `bun install` instead of `npm install` or `yarn install` or `pnpm install`
13
+ - Use `bun run <script>` instead of `npm run <script>` or `yarn run <script>` or `pnpm run <script>`
14
+ - Use `bunx <package> <command>` instead of `npx <package> <command>`
15
+ - Bun automatically loads .env, so don't use dotenv.
16
+
17
+ ## APIs
18
+
19
+ - `Bun.serve()` supports WebSockets, HTTPS, and routes. Don't use `express`.
20
+ - `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
21
+ - `Bun.redis` for Redis. Don't use `ioredis`.
22
+ - `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
23
+ - `WebSocket` is built-in. Don't use `ws`.
24
+ - Prefer `Bun.file` over `node:fs`'s readFile/writeFile
25
+ - Bun.$`ls` instead of execa.
26
+
27
+ ## Testing
28
+
29
+ Use `bun test` to run tests.
30
+
31
+ ```ts#index.test.ts
32
+ import { test, expect } from "bun:test";
33
+
34
+ test("hello world", () => {
35
+ expect(1).toBe(1);
36
+ });
37
+ ```
38
+
39
+ ## Frontend
40
+
41
+ Use HTML imports with `Bun.serve()`. Don't use `vite`. HTML imports fully support React, CSS, Tailwind.
42
+
43
+ Server:
44
+
45
+ ```ts#index.ts
46
+ import index from "./index.html"
47
+
48
+ Bun.serve({
49
+ routes: {
50
+ "/": index,
51
+ "/api/users/:id": {
52
+ GET: (req) => {
53
+ return new Response(JSON.stringify({ id: req.params.id }));
54
+ },
55
+ },
56
+ },
57
+ // optional websocket support
58
+ websocket: {
59
+ open: (ws) => {
60
+ ws.send("Hello, world!");
61
+ },
62
+ message: (ws, message) => {
63
+ ws.send(message);
64
+ },
65
+ close: (ws) => {
66
+ // handle close
67
+ }
68
+ },
69
+ development: {
70
+ hmr: true,
71
+ console: true,
72
+ }
73
+ })
74
+ ```
75
+
76
+ HTML files can import .tsx, .jsx or .js files directly and Bun's bundler will transpile & bundle automatically. `<link>` tags can point to stylesheets and Bun's CSS bundler will bundle.
77
+
78
+ ```html#index.html
79
+ <html>
80
+ <body>
81
+ <h1>Hello, world!</h1>
82
+ <script type="module" src="./frontend.tsx"></script>
83
+ </body>
84
+ </html>
85
+ ```
86
+
87
+ With the following `frontend.tsx`:
88
+
89
+ ```tsx#frontend.tsx
90
+ import React from "react";
91
+ import { createRoot } from "react-dom/client";
92
+
93
+ // import .css files directly and it works
94
+ import './index.css';
95
+
96
+ const root = createRoot(document.body);
97
+
98
+ export default function Frontend() {
99
+ return <h1>Hello, world!</h1>;
100
+ }
101
+
102
+ root.render(<Frontend />);
103
+ ```
104
+
105
+ Then, run index.ts
106
+
107
+ ```sh
108
+ bun --hot ./index.ts
109
+ ```
110
+
111
+ For more information, read the Bun API docs in `node_modules/bun-types/docs/**.mdx`.
package/README.md ADDED
@@ -0,0 +1,87 @@
1
+ # Forge
2
+
3
+ Forge is a lightweight version control system built from scratch. Designed to be simple, fast, and easy to understand — Forge gives you the core of a VCS without the complexity of Git.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ # using bun
9
+ bun add @ridit/forge -g
10
+
11
+ # using npm
12
+ npm install -g @ridit/forge
13
+ ```
14
+
15
+ ## Features
16
+
17
+ - **Init** — initialize a new Forge repository
18
+ - **Add** — stage files for commit
19
+ - **Commit** — snapshot your staged files with a message
20
+ - **Log** — view commit history per branch or globally
21
+ - **Checkout** — restore a previous commit
22
+ - **Branches** — create, switch, and manage isolated branches
23
+ - **Merge** — merge branches with conflict detection
24
+ - **Status** — view modified, staged, untracked, and deleted files
25
+ - **Checkpoints** — auto-saved snapshots when switching branches
26
+ - **ForgeIgnore** — `.forgeignore` support to exclude files
27
+
28
+ ## CLI Commands
29
+
30
+ ```bash
31
+ forge init initialize an empty repo
32
+
33
+ forge add . stage all files
34
+ forge add <path> stage a specific file
35
+
36
+ forge commit -m "message" -a commit all staged files
37
+ forge commit -m "message" commit staged files
38
+
39
+ forge log view commits in current branch
40
+ forge log -g view all commits globally
41
+
42
+ forge checkout <commitId> restore a commit in current branch
43
+ forge checkout <commitId> -b <branch> restore a commit in a specific branch
44
+
45
+ forge branch <name> create a new branch
46
+ forge branch <name> -s switch to a branch
47
+ forge branch <name> -d delete a branch
48
+ forge branch <name> -m <branch> merge a branch into current branch
49
+
50
+ forge status show file statuses
51
+ ```
52
+
53
+ ## How It Works
54
+
55
+ Forge stores all data in a `.forge` folder at the root of your repository:
56
+
57
+ ```
58
+ .forge/
59
+ ├── commits/ ← global commit refs (lightweight)
60
+ ├── branches/
61
+ │ └── main/
62
+ │ ├── branch.json ← branch metadata + latest commit id
63
+ │ ├── checkpoint.json ← auto-snapshot saved on branch switch
64
+ │ └── commits/ ← full commits with file blobs
65
+ ├── repo.json ← repo metadata + active branch
66
+ └── tempAddedFiles.json ← staging area
67
+ ```
68
+
69
+ ## Branch System
70
+
71
+ - Every branch stores its own commit history
72
+ - Switching branches auto-saves a **checkpoint** of your current working state
73
+ - On switch back, Forge restores from checkpoint if it's up to date, otherwise falls back to the latest commit
74
+ - Merging compares changes since the **merge base** (last shared commit) and detects conflicts
75
+
76
+ ## File Statuses
77
+
78
+ | Status | Meaning |
79
+ | ----------- | ------------------------------------ |
80
+ | `untracked` | new file, not in last commit |
81
+ | `modified` | changed since last commit |
82
+ | `staged` | added to staging area |
83
+ | `deleted` | in last commit but removed from disk |
84
+
85
+ ## License
86
+
87
+ MIT