gh-issue-kit 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TERUSI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,224 @@
+# gh-issue-kit
+
+A command line tool for setting up GitHub Issue templates and drafting issues from those templates.
+
+`gh-issue-kit` helps you:
+
+- initialize `.github/ISSUE_TEMPLATE`
+- manage a local `.gh-issue/` workspace
+- create Markdown issue drafts from installed templates
+- send those drafts to GitHub Issues with `gh`
+
+## Requirements
+
+- Node.js `>= 20`
+- GitHub CLI `gh` for the `send` command
+
+## Authentication
+
+Authenticate GitHub CLI before using `gh-issue-kit`:
+
+```sh
+gh auth login
+```
+
+This is required because `gh-issue-kit` uses `gh` to inspect repositories and create issues.
+
+## Installation
+
+### Global installation
+
+If you want to run `gh-issue-kit` directly from your terminal, install it globally:
+
+```sh
+npm install -g gh-issue-kit
+```
+
+Or with pnpm:
+
+```sh
+pnpm add -g gh-issue-kit
+```
+
+### Local installation
+
+If you prefer to install it in a project:
+
+```sh
+npm install gh-issue-kit
+```
+
+Example `package.json` scripts:
+
+```json
+{
+  "scripts": {
+    "gh-init": "gh-issue-kit init",
+    "gh-create": "gh-issue-kit create",
+    "gh-send": "gh-issue-kit send"
+  }
+}
+```
+
+## Commands
+
+### `gh-issue-kit init`
+
+Initialize the local `gh-issue` workspace.
+
+What it does:
+
+- creates `.gh-issue/`
+- creates `.gh-issue/README.md`
+- optionally creates issue templates in `.github/ISSUE_TEMPLATE/`
+
+Behavior:
+
+- if `.gh-issue/` already exists, initialization stops
+- first asks whether issue templates should be created
+- if you answer `no`, only `.gh-issue/` is prepared and the command exits with `All done!`
+- if you answer `yes`, you can choose template types and languages before files are written
+
+Example:
+
+```sh
+gh-issue-kit init
+```
+
+Generated template files are written under:
+
+```text
+.github/ISSUE_TEMPLATE/
+```
+
+The local draft workspace is:
+
+```text
+.gh-issue/
+```
+
+### `gh-issue-kit create`
+
+Create a Markdown issue draft from one of the installed issue templates.
+
+This command:
+
+- reads templates from `.github/ISSUE_TEMPLATE/`
+- prompts you to choose a template
+- prompts for the issue title and each field
+- saves the result as a Markdown draft under `.gh-issue/`
+
+Example:
+
+```sh
+gh-issue-kit create
+```
+
+#### `create` options
+
+##### `--vim`
+
+Preselect Vim for textarea fields.
+
+Behavior:
+
+- for required textarea fields, the Vim/direct chooser is skipped
+- for optional textarea fields, you are asked only whether to edit or skip
+
+Example:
+
+```sh
+gh-issue-kit create --vim
+```
+
+##### `--no-vim`
+
+Preselect direct input for textarea fields.
+
+Behavior:
+
+- for required textarea fields, the Vim/direct chooser is skipped
+- for optional textarea fields, you are asked only whether to edit or skip
+
+Example:
+
+```sh
+gh-issue-kit create --no-vim
+```
+
+#### Textarea behavior
+
+When no editor option is specified:
+
+- required textarea fields ask how to enter content
+- optional textarea fields can be edited or skipped
+
+When Vim is used:
+
+- content is written in a temporary hidden file
+- guide comments are inserted at the top
+- those guide comments are removed before saving the final draft
+
+### `gh-issue-kit send`
+
+Create GitHub Issues from Markdown drafts stored in `.gh-issue/`.
+
+This command:
+
+- reads draft files from `.gh-issue/`
+- prompts you to select one or more drafts
+- creates GitHub Issues with `gh issue create`
+- removes each draft after successful submission
+
+Example:
+
+```sh
+gh-issue-kit send
+```
+
+#### `send` options
+
+##### `--all`
+
+Send all drafts without showing the selection prompt.
+
+Example:
+
+```sh
+gh-issue-kit send --all
+```
+
+The `send` command ignores:
+
+```text
+.gh-issue/README.md
+```
+
+## Draft format
+
+Each generated draft uses front matter for the issue title and Markdown for the body.
+
+Example:
+
+```md
+---
+title: [BUG] Build fails on CI
+---
+
+## Summary
+
+The build fails when running the release workflow.
+```
+
+## Typical workflow
+
+1. Run `gh auth login`
+2. Run `gh-issue-kit init`
+3. Run `gh-issue-kit create`
+4. Review the draft in `.gh-issue/`
+5. Run `gh-issue-kit send`
+
+## Notes
+
+- Existing template files are skipped instead of overwritten.
+- The bundled templates are starter templates. Review and adjust them for your project before using them in production.