Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

suggestion: format JSDoc code blocks in scripts #16160

Open
iuioiua opened this issue Oct 5, 2022 · 3 comments
Open

suggestion: format JSDoc code blocks in scripts #16160

iuioiua opened this issue Oct 5, 2022 · 3 comments
Labels
cli related to cli/ dir feat new feature (which has been agreed to/accepted) fmt related to the fmt subcommand/dprint

Comments

@iuioiua
Copy link
Collaborator

iuioiua commented Oct 5, 2022 •
edited

It'd be great if deno fmt formatted code within JSDoc code blocks in scripts. This'd come in handy when writing examples, etc. For example, @crowlKats is currently reorganizing and cleaning up documentation of deno_std in denoland/deno_std#2658. Part of his work includes the manual tidying up code examples to match the actual code of the repo. This new functionality would take care of this work automatically.

This issue continues the discussion in denoland/deno_std#2736.
@iuioiua iuioiua mentioned this issue Oct 5, 2022
Closed
@bartlomieju
Copy link
Member

I thought this is already the case? @dsherret isn't that supported?

@lucacasonato
Copy link
Member

It is working for me: https://gist.github.com/lucacasonato/60311fb6e00ccd9e6be63ff95adb6fb0

@lucacasonato lucacasonato reopened this Jan 12, 2023
@lucacasonato
Copy link
Member

Oh I see this is about code blocks in JSDoc blocks in TS files

@lucacasonato lucacasonato added feat new feature (which has been agreed to/accepted) cli related to cli/ dir fmt related to the fmt subcommand/dprint labels Jan 12, 2023
@iuioiua iuioiua changed the title suggestion: format code blocks in scripts suggestion: format JSDoc code blocks in scripts Jan 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cli related to cli/ dir feat new feature (which has been agreed to/accepted) fmt related to the fmt subcommand/dprint
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lucacasonato @bartlomieju @iuioiua