Skip to content

docs: integrate Commander.js, oclif and yargs#616

Merged
jdx merged 6 commits intojdx:mainfrom
gaojunran:docs-integrate-js
May 3, 2026
Merged

docs: integrate Commander.js, oclif and yargs#616
jdx merged 6 commits intojdx:mainfrom
gaojunran:docs-integrate-js

Conversation

@gaojunran
Copy link
Copy Markdown
Contributor

@gaojunran gaojunran commented May 3, 2026

https://github.com/gaojunran/usage-integrations

a monorepo that shares Node.js lib integrations. 50+ tests for each integration to make it workable.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.03%. Comparing base (874b964) to head (c1ac046).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #616   +/-   ##
=======================================
  Coverage   79.03%   79.03%           
=======================================
  Files          48       48           
  Lines        7235     7235           
  Branches     7235     7235           
=======================================
  Hits         5718     5718           
  Misses       1140     1140           
  Partials      377      377           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation to include new Node.js integrations for Commander.js, oclif, and yargs, moving them from the planned list to the active integrations list. Feedback suggests using official project websites instead of GitHub repository links for these tools to improve documentation quality and consistency.

Comment thread docs/spec/integrations.md Outdated
@jdx
Copy link
Copy Markdown
Owner

jdx commented May 3, 2026

oclif! been a while!

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 3, 2026

Greptile Summary

This PR promotes Commander.js, oclif, and yargs from the "Planned" section to "Available" integrations, linking each to an @usage-spec-scoped npm package. The Commander.js framework link has been correctly updated to the canonical github.com/tj/commander.js URL, and the sidebar entries now point to npm package pages rather than an external personal repo.

Confidence Score: 4/5

Docs-only PR; no runtime risk. Key concerns about npm package availability and external-repo dependency were raised in prior review threads and should be resolved before merge.

No code execution paths are touched. The changes are entirely documentation. The Commander.js URL fix is correct. Residual concerns (npm packages not yet published, integration living in an external personal repo) were flagged in previous review threads and are not re-raised here, but they remain open and cap confidence below 5.

docs/spec/integrations.md — verify @usage-spec packages are published before the integration links go live.

Important Files Changed

Filename Overview
docs/spec/integrations.md Adds Commander.js, oclif, and yargs rows to the "Available" table; removes them from "Planned". Framework links are correct canonical URLs. Package links point to npmjs.com pages for the @usage-spec scope.
docs/.vitepress/config.mts Adds three sidebar items for the new Node.js integrations, each linking to their respective npmjs.com package pages — consistent with how argparse and OptionParser link to external resources.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Integrations Page] --> B[Available]
    A --> C[Planned]

    B --> B1[Cobra — internal docs page]
    B --> B2[clap — internal docs page]
    B --> B3[argparse — GitHub repo link]
    B --> B4[OptionParser — GitHub repo link]
    B --> B5[Commander.js — npm package page]
    B --> B6[oclif — npm package page]
    B --> B7[yargs — npm package page]

    C --> C1[urfave/cli]
    C --> C2[Typer]
    C --> C3[Click]
Loading

Reviews (3): Last reviewed commit: "[autofix.ci] apply automated fixes" | Re-trigger Greptile

Comment thread docs/spec/integrations.md Outdated
Comment thread docs/.vitepress/config.mts Outdated
gaojunran and others added 2 commits May 3, 2026 18:30
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@gaojunran gaojunran marked this pull request as draft May 3, 2026 10:32
Comment thread docs/spec/integrations.md Outdated
@gaojunran gaojunran marked this pull request as ready for review May 3, 2026 10:39
@gaojunran
Copy link
Copy Markdown
Contributor Author

@jdx Ready for review!

@jdx jdx merged commit 9213dfe into jdx:main May 3, 2026
8 checks passed
@mise-en-dev mise-en-dev mentioned this pull request May 3, 2026
jdx pushed a commit that referenced this pull request May 3, 2026
### 🚀 Features

- **(complete)** auto-completion for usage shebang scripts by
[@jdx](https://github.com/jdx) in
[#620](#620)

### 🐛 Bug Fixes

- **(docs)** stack banner and pin close button on mobile by
[@jdx](https://github.com/jdx) in
[#603](#603)

### 📚 Documentation

- **(site)** show release version and github stars by
[@jdx](https://github.com/jdx) in
[#604](#604)
- add cross-site announcement banner by [@jdx](https://github.com/jdx)
in [#600](#600)
- fix banner dark-mode contrast by [@jdx](https://github.com/jdx) in
[#601](#601)
- respect banner expires field by [@jdx](https://github.com/jdx) in
[#602](#602)
- prefix star count with ★ glyph and populate it on deploy by
[@jdx](https://github.com/jdx) in
[#606](#606)
- integrate Commander.js, oclif and yargs by
[@gaojunran](https://github.com/gaojunran) in
[#616](#616)
- integrate Typer and Click by
[@gaojunran](https://github.com/gaojunran) in
[#619](#619)

### 🔍 Other Changes

- **(docs)** remove shrill.en.dev analytics script by
[@jdx](https://github.com/jdx) in
[#614](#614)
- **(release)** append en.dev sponsor blurb to release notes by
[@jdx](https://github.com/jdx) in
[#598](#598)
- switch analytics from gtm to plausible by
[@jdx](https://github.com/jdx) in
[#609](#609)
- pin taiki-e/install-action to commit SHA by
[@jdx](https://github.com/jdx) in
[#610](#610)
- rename CLAUDE.md to AGENTS.md and symlink by
[@jdx](https://github.com/jdx) in
[#618](#618)

### 📦️ Dependency Updates

- bump communique to 1.1.2 by [@jdx](https://github.com/jdx) in
[#605](#605)
- lock file maintenance by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#607](#607)
- update autofix-ci/action action to v1.3.4 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#611](#611)
- update apple-actions/import-codesign-certs action to v7 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#612](#612)
- update taiki-e/install-action digest to fc9eae0 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#613](#613)

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants