refactor: js output
This commit is contained in:
parent
1aa28c2a34
commit
c6704c3a04
96 changed files with 3816 additions and 147 deletions
48
README.md
48
README.md
|
|
@ -15,10 +15,10 @@ npm install -g @byteb4rb1e/mime-todo
|
|||
|
||||
```sh
|
||||
# Create a TODO file and start tracking issues
|
||||
todo create --type feature --title "Add login" --plan "Implement OAuth2 flow"
|
||||
todo start 1 --plan "Using passport.js with Google provider"
|
||||
todo push # sync to Bugzilla
|
||||
todo done 1 --summary "OAuth2 login with Google, GitHub providers"
|
||||
mime-todo create --type feature --title "Add login" --plan "Implement OAuth2 flow"
|
||||
mime-todo start 1 --plan "Using passport.js with Google provider"
|
||||
mime-todo push # sync to Bugzilla
|
||||
mime-todo done 1 --summary "OAuth2 login with Google, GitHub providers"
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
|
@ -27,11 +27,11 @@ todo done 1 --summary "OAuth2 login with Google, GitHub providers"
|
|||
|
||||
| Command | Branch | Description |
|
||||
|---------|--------|-------------|
|
||||
| `todo create --type --title --plan` | `develop` | Create a new issue |
|
||||
| `todo start <id> --plan` | `develop` | Set issue to in-progress |
|
||||
| `todo done <id> --summary` | `<type>/<id>` | Mark issue as done |
|
||||
| `todo hold <id> --reason` | `<type>/<id>` | Put issue on hold |
|
||||
| `todo cancel <id> --reason` | `develop` or `<type>/<id>` | Cancel an issue |
|
||||
| `mime-todo create --type --title --plan` | `develop` | Create a new issue |
|
||||
| `mime-todo start <id> --plan` | `develop` | Set issue to in-progress |
|
||||
| `mime-todo done <id> --summary` | `<type>/<id>` | Mark issue as done |
|
||||
| `mime-todo hold <id> --reason` | `<type>/<id>` | Put issue on hold |
|
||||
| `mime-todo cancel <id> --reason` | `develop` or `<type>/<id>` | Cancel an issue |
|
||||
|
||||
Each lifecycle command creates a dedicated commit (`todo(<id>): <status>`)
|
||||
that modifies only the `TODO` file.
|
||||
|
|
@ -40,30 +40,30 @@ that modifies only the `TODO` file.
|
|||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `todo list` | List all issues |
|
||||
| `todo show <id>` | Show issue details |
|
||||
| `todo sprints` | List all sprints |
|
||||
| `todo issues-in-sprint <name>` | List issues in a sprint |
|
||||
| `mime-todo list` | List all issues |
|
||||
| `mime-todo show <id>` | Show issue details |
|
||||
| `mime-todo sprints` | List all sprints |
|
||||
| `mime-todo issues-in-sprint <name>` | List issues in a sprint |
|
||||
|
||||
### Bugzilla Integration
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `todo init` | Check/create Bugzilla products and components |
|
||||
| `todo push [ref]` | Push commits as Bugzilla comments |
|
||||
| `mime-todo init` | Check/create Bugzilla products and components |
|
||||
| `mime-todo push [ref]` | Push commits as Bugzilla comments |
|
||||
|
||||
#### `todo init`
|
||||
#### `mime-todo init`
|
||||
|
||||
Reads the `application/bugzilla` part from the `TODO` file and ensures the
|
||||
referenced products and components exist on the Bugzilla server.
|
||||
|
||||
```sh
|
||||
todo init # check what exists
|
||||
todo init --dry-run # preview changes
|
||||
todo init --confirm --assignee user@example.com # create missing items
|
||||
mime-todo init # check what exists
|
||||
mime-todo init --dry-run # preview changes
|
||||
mime-todo init --confirm --assignee user@example.com # create missing items
|
||||
```
|
||||
|
||||
#### `todo push`
|
||||
#### `mime-todo push`
|
||||
|
||||
Pushes git commits to Bugzilla as comments. Context-aware:
|
||||
|
||||
|
|
@ -73,10 +73,10 @@ Pushes git commits to Bugzilla as comments. Context-aware:
|
|||
updating bug status and posting the commit body as a comment.
|
||||
|
||||
```sh
|
||||
todo push # push all unpushed commits
|
||||
todo push HEAD~3 # push only the last 3 commits
|
||||
todo push --dry-run # preview without pushing
|
||||
todo push --strategy full # re-scan all bugs (not just targeted)
|
||||
mime-todo push # push all unpushed commits
|
||||
mime-todo push HEAD~3 # push only the last 3 commits
|
||||
mime-todo push --dry-run # preview without pushing
|
||||
mime-todo push --strategy full # re-scan all bugs (not just targeted)
|
||||
```
|
||||
|
||||
Each comment includes a clickable link to the commit. Comments are tagged
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue