gitforest 0.1.0 → 1.0.0

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 (183) hide show
  1. package/LICENSE +21 -0
  2. package/package.json +24 -4
  3. package/src/github/auth.ts +3 -3
  4. package/src/utils/debug.ts +4 -4
  5. package/.bunignore +0 -7
  6. package/.github/workflows/ci.yml +0 -73
  7. package/CLAUDE.md +0 -111
  8. package/CONTRIBUTING.md +0 -145
  9. package/bun.lock +0 -267
  10. package/bunfig.toml +0 -15
  11. package/cli +0 -0
  12. package/docs/ai/IMPROVEMENT_PLAN.md +0 -341
  13. package/docs/ai/VERIFICATION_REPORT.md +0 -87
  14. package/docs/ai/architecture.md +0 -169
  15. package/docs/ai/checks/check-2025-12-02-tests.md +0 -40
  16. package/docs/ai/checks/check-2025-12-02.md +0 -55
  17. package/docs/ai/checks/test-verification-report.md +0 -85
  18. package/docs/ai/implementation-guide.md +0 -776
  19. package/docs/ai/research/gitty-codebase-analysis.md +0 -221
  20. package/docs/ai/tickets/GENERAL-sitrep.md +0 -30
  21. package/docs/ai/tickets/TASK-database-tests-sitrep.md +0 -25
  22. package/docs/ai/tickets/TASK-deprecated-functions-sitrep.md +0 -28
  23. package/docs/ai/tickets/TASK-detail-modal-sitrep.md +0 -28
  24. package/docs/ai/tickets/TASK-filter-overlay-sitrep.md +0 -24
  25. package/docs/ai/tickets/TASK-github-service-sitrep.md +0 -32
  26. package/docs/ai/tickets/TASK-github-token-sitrep.md +0 -51
  27. package/docs/ai/tickets/TASK-hascommits-sitrep.md +0 -35
  28. package/docs/ai/tickets/TASK-keybindings-sitrep.md +0 -26
  29. package/docs/ai/tickets/TASK-layout-sitrep.md +0 -25
  30. package/docs/ai/tickets/TASK-markdown-sitrep.md +0 -28
  31. package/docs/ai/tickets/TASK-project-item-sitrep.md +0 -79
  32. package/docs/ai/tickets/TASK-sitrep.md +0 -28
  33. package/docs/ai/tickets/TASK-state-sitrep.md +0 -26
  34. package/docs/ai/tickets/TASK-types-sitrep.md +0 -25
  35. package/docs/ai/tickets/TASK-unified-item-fix-sitrep.md +0 -26
  36. package/docs/ai/tickets/TKT-001-sitrep.md +0 -24
  37. package/docs/ai/tickets/TKT-002-sitrep.md +0 -25
  38. package/docs/ai/tickets/TKT-003-git-service-refactoring-complete.md +0 -46
  39. package/docs/ai/tickets/TKT-003-git-service-refactoring-plan.md +0 -135
  40. package/docs/ai/tickets/TKT-003-sitrep.md +0 -26
  41. package/docs/ai/tickets/TKT-004-sitrep.md +0 -27
  42. package/docs/ai/tickets/TKT-005-sitrep.md +0 -25
  43. package/docs/ai/tickets/TKT-006-sitrep.md +0 -26
  44. package/docs/ai/tickets/TKT-007-sitrep.md +0 -30
  45. package/docs/ai/tickets/TKT-008-sitrep.md +0 -32
  46. package/docs/ai/tickets/TKT-009-sitrep.md +0 -27
  47. package/docs/ai/tickets/TKT-010-sitrep.md +0 -27
  48. package/docs/ai/tickets/TKT-011-sitrep.md +0 -26
  49. package/docs/ai/tickets/TKT-012-sitrep.md +0 -25
  50. package/docs/ai/tickets/sitreps/TASK-actions-sitrep.md +0 -28
  51. package/docs/ai/tickets/sitreps/TASK-actions-test-sitrep.md +0 -25
  52. package/docs/ai/tickets/sitreps/TASK-app-integration-sitrep.md +0 -25
  53. package/docs/ai/tickets/sitreps/TASK-background-fetch-sitrep.md +0 -24
  54. package/docs/ai/tickets/sitreps/TASK-background-fetch-test-sitrep.md +0 -29
  55. package/docs/ai/tickets/sitreps/TASK-batch-tests-sitrep.md +0 -29
  56. package/docs/ai/tickets/sitreps/TASK-bun-test-sitrep.md +0 -26
  57. package/docs/ai/tickets/sitreps/TASK-cache-tests-sitrep.md +0 -30
  58. package/docs/ai/tickets/sitreps/TASK-cli-tests-sitrep.md +0 -28
  59. package/docs/ai/tickets/sitreps/TASK-clone-error-handling-sitrep.md +0 -26
  60. package/docs/ai/tickets/sitreps/TASK-commands-tests-sitrep.md +0 -25
  61. package/docs/ai/tickets/sitreps/TASK-component-tests-1-sitrep.md +0 -30
  62. package/docs/ai/tickets/sitreps/TASK-configloader-tests-sitrep.md +0 -25
  63. package/docs/ai/tickets/sitreps/TASK-confirm-dialog-test-sitrep.md +0 -29
  64. package/docs/ai/tickets/sitreps/TASK-coverage-sitrep.md +0 -95
  65. package/docs/ai/tickets/sitreps/TASK-database-tests-summary.md +0 -61
  66. package/docs/ai/tickets/sitreps/TASK-error-boundary-sitrep.md +0 -30
  67. package/docs/ai/tickets/sitreps/TASK-error-tests-sitrep.md +0 -27
  68. package/docs/ai/tickets/sitreps/TASK-errors-tests-sitrep.md +0 -25
  69. package/docs/ai/tickets/sitreps/TASK-extract-reducer-sitrep.md +0 -27
  70. package/docs/ai/tickets/sitreps/TASK-filter-overlay-test-sitrep.md +0 -25
  71. package/docs/ai/tickets/sitreps/TASK-final-verification-sitrep.md +0 -28
  72. package/docs/ai/tickets/sitreps/TASK-fix-all-tests-sitrep.md +0 -25
  73. package/docs/ai/tickets/sitreps/TASK-fix-hooks-sitrep.md +0 -26
  74. package/docs/ai/tickets/sitreps/TASK-fix-remaining-tests-sitrep.md +0 -25
  75. package/docs/ai/tickets/sitreps/TASK-fix-test-failures-sitrep.md +0 -26
  76. package/docs/ai/tickets/sitreps/TASK-fix-tests-sitrep.md +0 -24
  77. package/docs/ai/tickets/sitreps/TASK-formatters-tests-sitrep.md +0 -25
  78. package/docs/ai/tickets/sitreps/TASK-git-timeouts-sitrep.md +0 -29
  79. package/docs/ai/tickets/sitreps/TASK-github-cache-test-sitrep.md +0 -25
  80. package/docs/ai/tickets/sitreps/TASK-githubcli-tests-sitrep.md +0 -24
  81. package/docs/ai/tickets/sitreps/TASK-gitstatus-tests-sitrep.md +0 -24
  82. package/docs/ai/tickets/sitreps/TASK-hooks-isolation-sitrep.md +0 -27
  83. package/docs/ai/tickets/sitreps/TASK-keybindings-tests-sitrep.md +0 -25
  84. package/docs/ai/tickets/sitreps/TASK-layout-tests-sitrep.md +0 -25
  85. package/docs/ai/tickets/sitreps/TASK-mock-factories-sitrep.md +0 -27
  86. package/docs/ai/tickets/sitreps/TASK-modal-tests-sitrep.md +0 -32
  87. package/docs/ai/tickets/sitreps/TASK-processbatch-fix-sitrep.md +0 -27
  88. package/docs/ai/tickets/sitreps/TASK-projectlist-tests-sitrep.md +0 -30
  89. package/docs/ai/tickets/sitreps/TASK-projectutils-tests-sitrep.md +0 -25
  90. package/docs/ai/tickets/sitreps/TASK-scanner-tests-sitrep.md +0 -29
  91. package/docs/ai/tickets/sitreps/TASK-select-all-sitrep.md +0 -25
  92. package/docs/ai/tickets/sitreps/TASK-shell-error-handling-sitrep.md +0 -27
  93. package/docs/ai/tickets/sitreps/TASK-store-tests-sitrep.md +0 -25
  94. package/docs/ai/tickets/sitreps/TASK-test-fixes-sitrep.md +0 -26
  95. package/docs/ai/tickets/sitreps/TASK-test-summary-sitrep.md +0 -25
  96. package/docs/ai/tickets/sitreps/TASK-test-verification-sitrep.md +0 -27
  97. package/docs/ai/tickets/sitreps/TASK-testsuite-sitrep.md +0 -75
  98. package/docs/ai/tickets/sitreps/TASK-unified-reducer-tests-sitrep.md +0 -29
  99. package/docs/ai/tickets/sitreps/TASK-unified-repos-test-sitrep.md +0 -29
  100. package/docs/ai/tickets/sitreps/TASK-unified-tests-sitrep.md +0 -25
  101. package/docs/ai/tickets/sitreps/TASK-useprojects-tests-sitrep.md +0 -25
  102. package/docs/ai/tickets/sitreps/TASK-utility-tests-sitrep.md +0 -32
  103. package/docs/ai/tickets/sitreps/TKT-003-git-service-refactoring-sitrep.md +0 -64
  104. package/docs/ai/tkt-001-fix-database-error.md +0 -217
  105. package/docs/ai/ui-enhancement-plan.md +0 -562
  106. package/test/integration/app.isolated.tsx +0 -240
  107. package/test/integration/cli-commands.test.ts +0 -287
  108. package/test/integration/cli-validation.test.ts +0 -264
  109. package/test/integration/git-operations.test.ts +0 -218
  110. package/test/integration/scanner.test.ts +0 -228
  111. package/test/preload.ts +0 -18
  112. package/test/unit/cli/commands.test.ts +0 -13
  113. package/test/unit/cli/formatters.test.ts +0 -1116
  114. package/test/unit/cli/github-commands.test.ts +0 -12
  115. package/test/unit/components/CloneDialog.test.tsx +0 -240
  116. package/test/unit/components/ColumnHeader.test.tsx +0 -128
  117. package/test/unit/components/CommandPalette.test.tsx +0 -355
  118. package/test/unit/components/ConfirmDialog.test.tsx +0 -111
  119. package/test/unit/components/ErrorBoundary.test.tsx +0 -139
  120. package/test/unit/components/FilterBar.test.tsx +0 -43
  121. package/test/unit/components/FilterOptionsOverlay.test.tsx +0 -197
  122. package/test/unit/components/HelpOverlay.test.tsx +0 -90
  123. package/test/unit/components/Layout.test.tsx +0 -328
  124. package/test/unit/components/MarkdownRenderer.test.tsx +0 -45
  125. package/test/unit/components/ProgressBar.test.tsx +0 -138
  126. package/test/unit/components/ProjectItem.test.tsx +0 -182
  127. package/test/unit/components/ProjectList.test.tsx +0 -311
  128. package/test/unit/components/RepoDetailModal.test.tsx +0 -445
  129. package/test/unit/components/StatusBar.test.tsx +0 -112
  130. package/test/unit/components/UnifiedProjectItem.test.tsx +0 -618
  131. package/test/unit/components/ViewModeIndicator.test.tsx +0 -137
  132. package/test/unit/components/test-utils.tsx +0 -63
  133. package/test/unit/config/loader.test.ts +0 -692
  134. package/test/unit/db/database.test.ts +0 -978
  135. package/test/unit/db/index.test.ts +0 -314
  136. package/test/unit/fixtures/setup.ts +0 -186
  137. package/test/unit/git/commands-untested.test.ts +0 -205
  138. package/test/unit/git/commands.test.ts +0 -269
  139. package/test/unit/git/operations.test.ts +0 -322
  140. package/test/unit/git/status.test.ts +0 -219
  141. package/test/unit/github/auth.test.ts +0 -317
  142. package/test/unit/github/cache.test.ts +0 -1028
  143. package/test/unit/github/cli.test.ts +0 -135
  144. package/test/unit/github/unified.test.ts +0 -1201
  145. package/test/unit/graceful-shutdown.test.ts +0 -83
  146. package/test/unit/hooks/useBackgroundFetch.test.tsx +0 -239
  147. package/test/unit/hooks/useConfirmDialogActions.test.tsx +0 -81
  148. package/test/unit/hooks/useKeyBindings.isolated.ts +0 -715
  149. package/test/unit/hooks/useProjects.test.tsx +0 -186
  150. package/test/unit/hooks/useUnifiedRepos-simple.test.tsx +0 -115
  151. package/test/unit/hooks/useUnifiedRepos.test.tsx +0 -177
  152. package/test/unit/mocks/config.ts +0 -109
  153. package/test/unit/mocks/git-service.ts +0 -274
  154. package/test/unit/mocks/github-service.ts +0 -250
  155. package/test/unit/mocks/index.ts +0 -72
  156. package/test/unit/mocks/project.ts +0 -148
  157. package/test/unit/mocks/state-mocks.ts +0 -187
  158. package/test/unit/mocks/unified.ts +0 -169
  159. package/test/unit/operations/batch.test.ts +0 -216
  160. package/test/unit/operations/commands.test.ts +0 -550
  161. package/test/unit/scanner/errors.test.ts +0 -297
  162. package/test/unit/scanner/index.test.ts +0 -1011
  163. package/test/unit/scanner/markers.test.ts +0 -150
  164. package/test/unit/scanner/submodules.test.ts +0 -99
  165. package/test/unit/services/git-errors.test.ts +0 -190
  166. package/test/unit/services/git.test.ts +0 -442
  167. package/test/unit/services/github-errors.test.ts +0 -293
  168. package/test/unit/services/github.test.ts +0 -200
  169. package/test/unit/state/actions.test.ts +0 -217
  170. package/test/unit/state/reducer.test.ts +0 -745
  171. package/test/unit/state/store.test.tsx +0 -711
  172. package/test/unit/types/commands.test.ts +0 -220
  173. package/test/unit/types/schema.test.ts +0 -179
  174. package/test/unit/utils/array.test.ts +0 -73
  175. package/test/unit/utils/debug.test.ts +0 -23
  176. package/test/unit/utils/errors.test.ts +0 -295
  177. package/test/unit/utils/markdown.test.ts +0 -163
  178. package/test/unit/utils/project-utils.test.ts +0 -756
  179. package/test/unit/utils/rate-limiter.test.ts +0 -256
  180. package/test/unit/utils/retry.test.ts +0 -165
  181. package/test/unit/utils/strip-ansi.ts +0 -13
  182. package/test/unit/utils/timeout.test.ts +0 -93
  183. package/tsconfig.json +0 -29
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Brian Sunter
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/package.json CHANGED
@@ -1,9 +1,13 @@
1
1
  {
2
2
  "name": "gitforest",
3
- "version": "0.1.0",
3
+ "version": "1.0.0",
4
4
  "description": "TUI for managing multiple Git repositories and GitHub integration",
5
5
  "module": "src/index.tsx",
6
6
  "type": "module",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "git+https://github.com/briansunter/gitforest.git"
10
+ },
7
11
  "bin": {
8
12
  "gitforest": "./src/index.tsx"
9
13
  },
@@ -39,12 +43,28 @@
39
43
  "chalk": "^5.3.0"
40
44
  },
41
45
  "devDependencies": {
46
+ "@semantic-release/changelog": "^6.0.3",
47
+ "@semantic-release/commit-analyzer": "^13.0.1",
48
+ "@semantic-release/git": "^10.0.1",
49
+ "@semantic-release/release-notes-generator": "^14.1.0",
42
50
  "@types/bun": "latest",
43
51
  "@types/react": "^18.3.12",
52
+ "conventional-changelog-conventionalcommits": "^9.1.0",
44
53
  "drizzle-kit": "^0.28.1",
45
- "ink-testing-library": "^4.0.0"
54
+ "ink-testing-library": "^4.0.0",
55
+ "semantic-release": "^25.0.2",
56
+ "semantic-release-plugin-update-version-in-files": "^2.0.1"
46
57
  },
47
58
  "peerDependencies": {
48
59
  "typescript": "^5"
49
- }
50
- }
60
+ },
61
+ "publishConfig": {
62
+ "access": "public"
63
+ },
64
+ "files": [
65
+ "src",
66
+ "config",
67
+ "README.md",
68
+ "LICENSE"
69
+ ]
70
+ }
@@ -58,7 +58,7 @@ export async function getTokenAsync(): Promise<string | null> {
58
58
  }
59
59
 
60
60
  // Try to get token from gh CLI
61
- if (process.env.GITTY_IGNORE_GH) return null;
61
+ if (process.env.GITFOREST_IGNORE_GH) return null;
62
62
 
63
63
  try {
64
64
  const result = await Bun.$`gh auth token`.quiet().nothrow();
@@ -81,7 +81,7 @@ export async function getTokenAsync(): Promise<string | null> {
81
81
  * Check if gh CLI is installed
82
82
  */
83
83
  export async function isGhInstalled(): Promise<boolean> {
84
- if (process.env.GITTY_IGNORE_GH) return false;
84
+ if (process.env.GITFOREST_IGNORE_GH) return false;
85
85
 
86
86
  try {
87
87
  const result = await Bun.$`gh --version`.quiet().nothrow();
@@ -231,7 +231,7 @@ export async function getAuthStatus(): Promise<{
231
231
  }
232
232
 
233
233
  // Check gh CLI
234
- if (process.env.GITTY_IGNORE_GH) return { authenticated: false };
234
+ if (process.env.GITFOREST_IGNORE_GH) return { authenticated: false };
235
235
 
236
236
  try {
237
237
  const statusResult = await Bun.$`gh auth status -h github.com`.quiet().nothrow();
@@ -1,12 +1,12 @@
1
1
  /**
2
2
  * Debug logging utility
3
- * Enable debug output by setting GITTY_DEBUG=1 environment variable
3
+ * Enable debug output by setting GITFOREST_DEBUG=1 environment variable
4
4
  */
5
5
 
6
- const DEBUG = process.env.GITTY_DEBUG === "1" || process.env.GITTY_DEBUG === "true";
6
+ const DEBUG = process.env.GITFOREST_DEBUG === "1" || process.env.GITFOREST_DEBUG === "true";
7
7
 
8
8
  /**
9
- * Log a debug message (only when GITTY_DEBUG is enabled)
9
+ * Log a debug message (only when GITFOREST_DEBUG is enabled)
10
10
  */
11
11
  export function debug(context: string, message: string, data?: unknown): void {
12
12
  if (!DEBUG) return;
@@ -20,7 +20,7 @@ export function debug(context: string, message: string, data?: unknown): void {
20
20
  }
21
21
 
22
22
  /**
23
- * Log a debug error (only when GITTY_DEBUG is enabled)
23
+ * Log a debug error (only when GITFOREST_DEBUG is enabled)
24
24
  */
25
25
  export function debugError(context: string, message: string, error: unknown): void {
26
26
  if (!DEBUG) return;
package/.bunignore DELETED
@@ -1,7 +0,0 @@
1
- # Bun test ignores
2
- #
3
- # Files named .test.isolated.ts/.tsx are automatically excluded from test discovery
4
- # because they don't match the standard pattern (.test.ts, .spec.ts, etc.)
5
- #
6
- # No directories need to be excluded - all tests run with `bun test`
7
- # except 2 isolated files that must run separately (see bunfig.toml)
@@ -1,73 +0,0 @@
1
- name: CI
2
-
3
- on:
4
- push:
5
- branches: [master, main]
6
- pull_request:
7
- branches: [master, main]
8
-
9
- jobs:
10
- test:
11
- name: Test
12
- runs-on: ubuntu-latest
13
- continue-on-error: true
14
-
15
- steps:
16
- - name: Checkout code
17
- uses: actions/checkout@v4
18
-
19
- - name: Setup Bun
20
- uses: oven-sh/setup-bun@v1
21
- with:
22
- bun-version: latest
23
-
24
- - name: Install dependencies
25
- run: bun install
26
-
27
- - name: Run tests
28
- run: bun test
29
-
30
- type-check:
31
- name: Type Check
32
- runs-on: ubuntu-latest
33
-
34
- steps:
35
- - name: Checkout code
36
- uses: actions/checkout@v4
37
-
38
- - name: Setup Bun
39
- uses: oven-sh/setup-bun@v1
40
- with:
41
- bun-version: latest
42
-
43
- - name: Install dependencies
44
- run: bun install
45
-
46
- - name: Check TypeScript compilation (non-strict)
47
- run: bun build src/cli/index.ts 2>&1 | head -5 || true
48
-
49
- build:
50
- name: Build
51
- runs-on: ubuntu-latest
52
- needs: [type-check]
53
-
54
- steps:
55
- - name: Checkout code
56
- uses: actions/checkout@v4
57
-
58
- - name: Setup Bun
59
- uses: oven-sh/setup-bun@v1
60
- with:
61
- bun-version: latest
62
-
63
- - name: Install dependencies
64
- run: bun install
65
-
66
- - name: Build CLI
67
- run: bun build src/cli/index.ts --compile --outfile gitforest
68
-
69
- - name: Upload build artifact
70
- uses: actions/upload-artifact@v4
71
- with:
72
- name: gitforest-cli
73
- path: gitforest
package/CLAUDE.md DELETED
@@ -1,111 +0,0 @@
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
- - Bun automatically loads .env, so don't use dotenv.
15
-
16
- ## APIs
17
-
18
- - `Bun.serve()` supports WebSockets, HTTPS, and routes. Don't use `express`.
19
- - `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
20
- - `Bun.redis` for Redis. Don't use `ioredis`.
21
- - `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
22
- - `WebSocket` is built-in. Don't use `ws`.
23
- - Prefer `Bun.file` over `node:fs`'s readFile/writeFile
24
- - Bun.$`ls` instead of execa.
25
-
26
- ## Testing
27
-
28
- Use `bun test` to run tests.
29
-
30
- ```ts#index.test.ts
31
- import { test, expect } from "bun:test";
32
-
33
- test("hello world", () => {
34
- expect(1).toBe(1);
35
- });
36
- ```
37
-
38
- ## Frontend
39
-
40
- Use HTML imports with `Bun.serve()`. Don't use `vite`. HTML imports fully support React, CSS, Tailwind.
41
-
42
- Server:
43
-
44
- ```ts#index.ts
45
- import index from "./index.html"
46
-
47
- Bun.serve({
48
- routes: {
49
- "/": index,
50
- "/api/users/:id": {
51
- GET: (req) => {
52
- return new Response(JSON.stringify({ id: req.params.id }));
53
- },
54
- },
55
- },
56
- // optional websocket support
57
- websocket: {
58
- open: (ws) => {
59
- ws.send("Hello, world!");
60
- },
61
- message: (ws, message) => {
62
- ws.send(message);
63
- },
64
- close: (ws) => {
65
- // handle close
66
- }
67
- },
68
- development: {
69
- hmr: true,
70
- console: true,
71
- }
72
- })
73
- ```
74
-
75
- 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.
76
-
77
- ```html#index.html
78
- <html>
79
- <body>
80
- <h1>Hello, world!</h1>
81
- <script type="module" src="./frontend.tsx"></script>
82
- </body>
83
- </html>
84
- ```
85
-
86
- With the following `frontend.tsx`:
87
-
88
- ```tsx#frontend.tsx
89
- import React from "react";
90
-
91
- // import .css files directly and it works
92
- import './index.css';
93
-
94
- import { createRoot } from "react-dom/client";
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/**.md`.
package/CONTRIBUTING.md DELETED
@@ -1,145 +0,0 @@
1
- # Contributing to Gitforest
2
-
3
- Thank you for your interest in contributing to Gitforest! This document provides guidelines and instructions for contributing.
4
-
5
- ## Development Setup
6
-
7
- ### Prerequisites
8
-
9
- - [Bun](https://bun.sh/) runtime (v1.0 or later)
10
- - [gh CLI](https://cli.github.com/) for GitHub operations (optional)
11
- - Git
12
-
13
- ### Getting Started
14
-
15
- 1. Clone the repository:
16
- ```bash
17
- git clone https://github.com/yourusername/gitforest.git
18
- cd gitforest
19
- ```
20
-
21
- 2. Install dependencies:
22
- ```bash
23
- bun install
24
- ```
25
-
26
- 3. Create a config file:
27
- ```bash
28
- bun run start --init
29
- ```
30
-
31
- 4. Run tests to verify setup:
32
- ```bash
33
- bun test
34
- ```
35
-
36
- 5. Start development:
37
- ```bash
38
- bun run dev
39
- ```
40
-
41
- ## Project Structure
42
-
43
- ```
44
- gitforest/
45
- ├── src/
46
- │ ├── cli/ # Command-line interface
47
- │ ├── components/ # React/Ink UI components
48
- │ ├── config/ # Configuration loading
49
- │ ├── db/ # SQLite database (Drizzle ORM)
50
- │ ├── git/ # Git operations
51
- │ ├── github/ # GitHub API integration
52
- │ ├── hooks/ # React hooks
53
- │ ├── operations/ # Batch operations
54
- │ ├── scanner/ # Directory scanning
55
- │ ├── services/ # Service abstractions
56
- │ ├── state/ # State management
57
- │ ├── types/ # TypeScript types
58
- │ └── utils/ # Utility functions
59
- ├── test/ # Test files
60
- ├── docs/ # Documentation
61
- └── config/ # Example configurations
62
- ```
63
-
64
- ## Development Guidelines
65
-
66
- ### Code Style
67
-
68
- - Use TypeScript strict mode
69
- - Follow existing code patterns
70
- - Add JSDoc comments to public APIs
71
- - Use meaningful variable and function names
72
-
73
- ### Testing
74
-
75
- - Write tests for new features
76
- - Ensure all tests pass before submitting PR
77
- - Use mocks for external services (git, GitHub API)
78
-
79
- ```bash
80
- # Run all tests
81
- bun test
82
-
83
- # Run tests with coverage
84
- bun test --coverage
85
-
86
- # Run specific test file
87
- bun test test/path/to/file.test.ts
88
- ```
89
-
90
- ### Type Checking
91
-
92
- ```bash
93
- bun run typecheck
94
- ```
95
-
96
- ### Commits
97
-
98
- - Use clear, descriptive commit messages
99
- - Reference issue numbers when applicable
100
- - Keep commits focused and atomic
101
-
102
- ## Pull Request Process
103
-
104
- 1. Fork the repository
105
- 2. Create a feature branch (`git checkout -b feature/amazing-feature`)
106
- 3. Make your changes
107
- 4. Run tests and type checking
108
- 5. Commit your changes
109
- 6. Push to your fork
110
- 7. Open a Pull Request
111
-
112
- ### PR Checklist
113
-
114
- - [ ] Tests pass (`bun test`)
115
- - [ ] Type checking passes (`bun run typecheck`)
116
- - [ ] Code follows project style
117
- - [ ] Documentation updated if needed
118
- - [ ] Commit messages are clear
119
-
120
- ## Reporting Issues
121
-
122
- When reporting issues, please include:
123
-
124
- - Gitforest version
125
- - Bun version (`bun --version`)
126
- - Operating system
127
- - Steps to reproduce
128
- - Expected vs actual behavior
129
- - Relevant error messages
130
-
131
- ## Feature Requests
132
-
133
- Feature requests are welcome! Please:
134
-
135
- - Check existing issues first
136
- - Describe the use case
137
- - Explain why it would be useful
138
-
139
- ## Questions?
140
-
141
- Feel free to open an issue for questions or discussions.
142
-
143
- ## License
144
-
145
- By contributing, you agree that your contributions will be licensed under the project's license.