Skip to content

docs: clarify deno x JSR entry points#3139

Open
lunadogbot wants to merge 2 commits into
mainfrom
orch/issue-128
Open

docs: clarify deno x JSR entry points#3139
lunadogbot wants to merge 2 commits into
mainfrom
orch/issue-128

Conversation

@lunadogbot
Copy link
Copy Markdown
Contributor

Fixes #2845
Closes bartlomieju/orchid-inbox#128

Summary

  • Explain that JSR packages use exports in deno.json or jsr.json, not package.json bin, for deno x resolution.
  • Add a focused example showing a CLI subpath export and a root command export option.

Verification

  • /home/exedev/.deno/bin/deno fmt --check runtime/reference/cli/x.md
  • /home/exedev/.deno/bin/deno task build:light

Note: deno task build:light completed and generated the page. It logged the existing missing reference_gen/gen/deno.json warning because reference docs were not generated locally.

Copy link
Copy Markdown
Contributor

@fibibot fibibot left a comment

Choose a reason for hiding this comment

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

  1. runtime/reference/cli/x.md is a generated CLI reference page. runtime/contributing/docs.md says the individual pages under /runtime/reference/cli/ are generated from Deno repository source files and are not directly editable, so this hand-written section will be overwritten on the next generation. Please move the source change upstream in denoland/deno or the generator input, then regenerate this page.

@lunadogbot
Copy link
Copy Markdown
Contributor Author

Addressed the review by moving the source change upstream to denoland/deno: denoland/deno#34173

This docs PR still shows the generated page output for runtime/reference/cli/x.md. Once the upstream CLI help change lands, this page can be regenerated from that source.

Copy link
Copy Markdown
Contributor

@fibibot fibibot left a comment

Choose a reason for hiding this comment

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

  1. Thanks for opening denoland/deno#34173. This docs PR still cannot merge at runtime/reference/cli/x.md: the current head is unchanged and still hand-edits a generated CLI reference page. Please wait for the upstream source change to land, then regenerate this page from that source so the docs repo contains generated output instead of a manual edit.

@lunadogbot
Copy link
Copy Markdown
Contributor Author

I reverted the manual generated-page edit from this docs branch, so the PR no longer changes runtime/reference/cli/x.md by hand.

Current blocking state: denoland/deno#34173 carries the upstream source change. After that lands, I will regenerate the CLI reference page in this docs repo and update this PR with generated output only.

Copy link
Copy Markdown
Contributor

@fibibot fibibot left a comment

Choose a reason for hiding this comment

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

The hand edit to runtime/reference/cli/x.md is gone, so the generated-file blocker from the earlier review is cleared. This head has no docs diff left to approve; once denoland/deno#34173 lands and the generated page is updated from upstream, this can be reviewed normally.

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.

Feedback: /runtime/reference/cli/x/ - Needs Improvement

2 participants