mirror of
https://github.com/jarrodwatts/claude-hud.git
synced 2026-04-16 06:32:39 +00:00
opensourcify
This commit is contained in:
1
.github/CODEOWNERS
vendored
Normal file
1
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1 @@
|
||||
* @jarrodwatts
|
||||
21
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
21
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Report a reproducible problem
|
||||
labels: bug
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
## Steps to Reproduce
|
||||
|
||||
## Expected Behavior
|
||||
|
||||
## Actual Behavior
|
||||
|
||||
## Environment
|
||||
|
||||
- OS:
|
||||
- Node/Bun version:
|
||||
- Claude Code version:
|
||||
|
||||
## Logs or Screenshots
|
||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Security report
|
||||
url: mailto:security@jarrodwatts.com
|
||||
about: Please report security vulnerabilities via email.
|
||||
15
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
15
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea or enhancement
|
||||
labels: enhancement
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
## Problem to Solve
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
## Additional Context
|
||||
7
.github/dependabot.yml
vendored
Normal file
7
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "npm"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
open-pull-requests-limit: 5
|
||||
11
.github/pull_request_template.md
vendored
Normal file
11
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
## Summary
|
||||
|
||||
## Testing
|
||||
|
||||
- [ ] `npm test`
|
||||
- [ ] `npm run test:coverage`
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Tests updated or not needed
|
||||
- [ ] Docs updated if behavior changed
|
||||
24
.github/workflows/release.yml
vendored
Normal file
24
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v*.*.*"
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20.x
|
||||
cache: npm
|
||||
- run: npm ci
|
||||
- run: npm run build
|
||||
- run: npm test
|
||||
- run: npm run test:coverage
|
||||
- name: Create release
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
generate_release_notes: true
|
||||
@@ -9,8 +9,8 @@ Claude HUD is a Claude Code plugin that displays a real-time multi-line statusli
|
||||
## Build Commands
|
||||
|
||||
```bash
|
||||
bun install # Install dependencies
|
||||
bun run build # Build TypeScript to dist/
|
||||
npm ci # Install dependencies
|
||||
npm run build # Build TypeScript to dist/
|
||||
|
||||
# Test with sample stdin data
|
||||
echo '{"model":{"display_name":"Opus"},"context_window":{"current_usage":{"input_tokens":45000},"context_window_size":200000}}' | node dist/index.js
|
||||
|
||||
31
CODE_OF_CONDUCT.md
Normal file
31
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment include:
|
||||
|
||||
- Being respectful and considerate
|
||||
- Using welcoming and inclusive language
|
||||
- Accepting constructive feedback
|
||||
- Focusing on what is best for the community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
- Harassment or discrimination
|
||||
- Trolling, insulting, or derogatory comments
|
||||
- Publishing others' private information without permission
|
||||
|
||||
## Enforcement
|
||||
|
||||
Community leaders are responsible for clarifying standards of acceptable behavior and may take appropriate action in response to unacceptable behavior.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the maintainer at: security@jarrodwatts.com.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the Contributor Covenant, version 2.1.
|
||||
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||
35
CONTRIBUTING.md
Normal file
35
CONTRIBUTING.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Contributing
|
||||
|
||||
Thanks for contributing to Claude HUD. This repo is small and fast-moving, so we optimize for clarity and quick review.
|
||||
|
||||
## How to Contribute
|
||||
|
||||
1) Fork and clone the repo
|
||||
2) Create a branch
|
||||
3) Make your changes
|
||||
4) Run tests and update docs if needed
|
||||
5) Open a pull request
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
npm run build
|
||||
npm test
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
See `TESTING.md` for the full testing strategy, fixtures, and snapshot updates.
|
||||
|
||||
## Code Style
|
||||
|
||||
- Keep changes focused and small.
|
||||
- Prefer tests for behavior changes.
|
||||
- Avoid introducing dependencies unless necessary.
|
||||
|
||||
## Pull Requests
|
||||
|
||||
- Describe the problem and the fix.
|
||||
- Include tests or explain why they are not needed.
|
||||
- Link issues when relevant.
|
||||
5
MAINTAINERS.md
Normal file
5
MAINTAINERS.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Maintainers
|
||||
|
||||
- Jarrod Watts (https://github.com/jarrodwatts)
|
||||
|
||||
If you are interested in becoming a maintainer, open an issue to start the conversation.
|
||||
20
README.md
20
README.md
@@ -112,8 +112,8 @@ git clone https://github.com/jarrodwatts/claude-hud
|
||||
cd claude-hud
|
||||
|
||||
# Install & build
|
||||
bun install
|
||||
bun run build
|
||||
npm ci
|
||||
npm run build
|
||||
|
||||
# Test with sample data
|
||||
echo '{"model":{"display_name":"Opus"},"context_window":{"current_usage":{"input_tokens":45000},"context_window_size":200000}}' | node dist/index.js
|
||||
@@ -127,6 +127,22 @@ npm test
|
||||
|
||||
See `TESTING.md` for the full testing strategy and contribution expectations.
|
||||
|
||||
## Contributing
|
||||
|
||||
See `CONTRIBUTING.md` for guidelines and `CODE_OF_CONDUCT.md` for community standards.
|
||||
|
||||
## Support
|
||||
|
||||
See `SUPPORT.md` for support scope and contact guidance.
|
||||
|
||||
## Maintainers
|
||||
|
||||
See `MAINTAINERS.md`.
|
||||
|
||||
## Plugin Release
|
||||
|
||||
See `RELEASING.md` for the checklist to ship a new Claude Code plugin release.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
24
RELEASING.md
Normal file
24
RELEASING.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# Releasing
|
||||
|
||||
This project ships as a Claude Code plugin. Releases should include compiled `dist/` output.
|
||||
|
||||
## Release Checklist
|
||||
|
||||
1) Update versions:
|
||||
- `package.json`
|
||||
- `.claude-plugin/plugin.json`
|
||||
- `CHANGELOG.md`
|
||||
2) Build:
|
||||
```bash
|
||||
npm ci
|
||||
npm run build
|
||||
npm test
|
||||
npm run test:coverage
|
||||
```
|
||||
3) Verify plugin entrypoint:
|
||||
- `.claude-plugin/plugin.json` points to `dist/index.js`
|
||||
4) Commit and tag:
|
||||
- `git tag vX.Y.Z`
|
||||
5) Publish:
|
||||
- Push tag
|
||||
- Create GitHub release with notes from `CHANGELOG.md`
|
||||
12
SECURITY.md
Normal file
12
SECURITY.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Security fixes are applied to the latest release series only.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Please report security issues to: security@jarrodwatts.com
|
||||
|
||||
Include a clear description, reproduction steps, and any relevant logs or screenshots.
|
||||
We will acknowledge receipt within 5 business days and provide a timeline for a fix if applicable.
|
||||
16
SUPPORT.md
Normal file
16
SUPPORT.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Support Policy
|
||||
|
||||
This project is maintained on a best-effort basis.
|
||||
|
||||
## What We Support
|
||||
|
||||
- The latest release
|
||||
- Claude Code versions documented in `README.md`
|
||||
- Node.js 18+ or Bun
|
||||
|
||||
## How to Get Help
|
||||
|
||||
- Open a GitHub issue for bugs or feature requests
|
||||
- For security issues, see `SECURITY.md`
|
||||
|
||||
We cannot guarantee response times, but we will triage issues as time allows.
|
||||
Reference in New Issue
Block a user