Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/good-first-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: "🚀 Good First Issue"
about: A starter task for new TypeScript / Commander contributors.
title: "[Good First Issue]: "
labels: ["good first issue", "help wanted", "typescript", "vitest"]
assignees: ""
---

## 📝 What needs to be done?
<!-- State the subcommand or flag to be added/fixed via Commander v14.0.3 -->

### 🎯 Expected Behavior
<!-- Define the precise terminal command and the expected stdout/stderr output -->

### 🛠️ Technical Implementation Guide
This project is modular and built on modern tooling:
1. **CLI Layer:** We handle flags using `commander` (v14.0.3) — entry point is in `src/index.ts`.
2. **Business Logic:** Implement your new handler or validation rules inside the respective subcommand file under `src/commands/`.
3. **Tests:** We use `vitest` (v4.1.6) with the native fork pool to separate testing environments cleanly. Tests live in `src/__tests__/`.

### 🧪 Verifying Your Work Locally
1. Clean install your dependencies:
```bash
npm install
```
2. Run our strict test runner to ensure code coverage and logic pass perfectly:
```bash
npm test
```
*(Note: This fires up `vitest run --pool=forks` with coverage via `@vitest/coverage-v8`, after automatically rebuilding the TypeScript source.)*

### ⚖️ Open Source & Licensing Safeguard
This project is proudly protected under the **AGPL-3.0 License**. Because it is a standalone CLI execution tool, running, extending, or contributing to this codebase **does not** impact or "infect" your external proprietary or commercial enterprise apps. Your code remains yours, and we promise transparent attribution!
Comment thread
utkarsh232005 marked this conversation as resolved.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"scripts": {
"build": "tsup src/index.ts --format esm --dts",
"dev": "tsup src/index.ts --format esm --watch",
"pretest": "npm run build",
"test": "vitest run --pool=forks",
"prepublishOnly": "npm run build"
},
Expand All @@ -35,7 +36,7 @@
"devops"
],
"author": "",
"license": "MIT",
"license": "AGPL-3.0-only",
"dependencies": {
"@kubernetes/client-node": "^1.4.0",
"@vr_patel/tui": "^1.0.0",
Expand Down
2 changes: 1 addition & 1 deletion src/__tests__/auth.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ describe('auth command & AI clients', () => {
]);
await program.parseAsync(['node', 'test', 'auth', 'list']);
expect(logSpy).toHaveBeenCalledWith(expect.stringContaining('openai'));
expect(logSpy).toHaveBeenCalledWith(expect.stringContaining('supe...ikey'));
expect(logSpy).toHaveBeenCalledWith(expect.stringContaining('(set)'));
});

it('shows empty list message', async () => {
Expand Down