Skip to content

EvangeLabs/IssueSnap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IssueSnap

Snap a bug report — one command to collect everything and open a prefilled GitHub issue.

Install

npm install --save-dev issuesnap

Or use it directly without installing:

npx issuesnap "Build failure on Windows"

Usage

With a title:

npx issuesnap "TypeError in auth module"

Pipe an error log:

npm run build 2>&1 | npx issuesnap

As a dev dependency:

{
  "scripts": {
    "issuesnap": "issuesnap"
  }
}
npm run issuesnap -- "Production crash"

What It Collects

  • Error log — from stdin or command argument
  • Environment — OS, CPU, memory, shell, Node.js, npm, Yarn, pnpm, Git, Python, Go, Rust, VS Code
  • Git context — branch name and commit hash
  • Dependenciesdependencies, devDependencies, and peerDependencies from package.json

How It Works

  1. Captures the error from a pipe or CLI argument
  2. Collects environment info via envinfo
  3. Reads Git branch, commit hash, and remote URL
  4. Reads dependency versions from package.json
  5. Builds a prefilled GitHub issue URL
  6. Opens it in your browser

Requirements

  • Node.js >= 18
  • A Git repository with a GitHub remote

License

MIT

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors