René's URL Explorer Experiment


Title: Do not rewrite JBang directives: //DEPS becomes // DEPS and the script loses its dependencies · Issue #24 · openjavaformat/open-java-format · GitHub

Open Graph Title: Do not rewrite JBang directives: //DEPS becomes // DEPS and the script loses its dependencies · Issue #24 · openjavaformat/open-java-format

X Title: Do not rewrite JBang directives: //DEPS becomes // DEPS and the script loses its dependencies · Issue #24 · openjavaformat/open-java-format

Description: What happens JBang reads its configuration from line comments that must start with // immediately followed by the keyword: //DEPS, //JAVA, //SOURCES, //FILES, //JAVA_OPTIONS and so on. A script usually also starts with ///usr/bin/env jba...

Open Graph Description: What happens JBang reads its configuration from line comments that must start with // immediately followed by the keyword: //DEPS, //JAVA, //SOURCES, //FILES, //JAVA_OPTIONS and so on. A script usu...

X Description: What happens JBang reads its configuration from line comments that must start with // immediately followed by the keyword: //DEPS, //JAVA, //SOURCES, //FILES, //JAVA_OPTIONS and so on. A script usu...

Opengraph URL: https://github.com/openjavaformat/open-java-format/issues/24

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Do not rewrite JBang directives: //DEPS becomes // DEPS and the script loses its dependencies","articleBody":"### What happens\n\n[JBang](https://www.jbang.dev) reads its configuration from line comments that must start with `//` immediately followed by the keyword: `//DEPS`, `//JAVA`, `//SOURCES`, `//FILES`, `//JAVA_OPTIONS` and so on. A script usually also starts with `///usr/bin/env jbang \"$0\" \"$@\" ; exit $?`, which makes the file runnable from a shell and is still a comment for javac.\n\nThe formatter rewrites all of them. Reproduced with 2.98.0.1, jar and native binary alike:\n\n```java\n///usr/bin/env jbang \"$0\" \"$@\" ; exit $?\n//JAVA 21+\n//DEPS info.picocli:picocli:4.7.6\n//DEPS com.fasterxml.jackson.core:jackson-databind:2.17.2 org.slf4j:slf4j-simple:2.0.13 com.squareup.okhttp3:okhttp:4.12.0 org.jsoup:jsoup:1.18.1\n//JAVA_OPTIONS -Xmx512m\n\n```\n\nbecomes\n\n```java\n/// usr/bin/env jbang \"$0\" \"$@\" ; exit $?\n// JAVA 21+\n// DEPS info.picocli:picocli:4.7.6\n// DEPS com.fasterxml.jackson.core:jackson-databind:2.17.2 org.slf4j:slf4j-simple:2.0.13\n// com.squareup.okhttp3:okhttp:4.12.0 org.jsoup:jsoup:1.18.1\n// JAVA_OPTIONS -Xmx512m\n\n```\n\nThree separate things go wrong:\n\n1. **A space is added after the slashes**, so `//DEPS` becomes `// DEPS`. JBang no longer sees the directive: the dependencies, the Java version and the options are silently dropped, and the script stops compiling.\n2. **The first line gets a space too**, `/// usr/bin/env …`, which breaks running the script directly from a shell.\n3. **A long directive is wrapped** at 120 columns. Even without the space, the second half of the dependency list would end up in an ordinary comment.\n\n### Why\n\n`JavaCommentsHelper.wrapLineComments` adds the missing space with `LINE_COMMENT_MISSING_SPACE_PREFIX`, which exempts only `//noinspection` and `//$NON-NLS-n$`, and then wraps every line comment that is too long. `doc/Comment.computeFlat()` adds the same space on the path where the helper is not called at all, see #23.\n\n### Today's workaround\n\nExclude the scripts. The GitHub Action and the pre-commit hook read `.open-java-format-exclude`, and their README uses exactly this case as the example. That keeps CI green but leaves JBang scripts unformatted.\n\n### Proposal\n\nLeave JBang directives and the `///usr/bin/env` line exactly as written: no inserted space, no wrapping.\n\nThe rule has to be narrow. A blanket \"do not touch `//WORD`\" would stop `//TODO` from becoming `// TODO` and change the output of ordinary code. Two ways to keep it narrow:\n\n- a fixed list of JBang keywords, taken from JBang's documentation, or\n- any `//KEYWORD` line, but only in a file that JBang would treat as a script, for example one that starts with the `///usr/bin/env jbang` line or contains `//DEPS` or `//JAVA`.\n\n### Compatibility\n\nFor a JBang script the current output is a broken script, so nobody depends on it. With a narrow rule nothing else changes. It still differs from palantir-java-format 2.98.0 for these files, which the 2.x promise has to allow for explicitly.\n\n### Related\n\n- google/google-java-format#1217, by JBang's author, asks for the same thing there and is open.\n- google/google-java-format#1218 and google/google-java-format#1215 are about the `///` first line.\n- jbangdev/jbang#1194 asked JBang to accept `// DEPS` instead. It was closed with the view that a formatter should not add a space where there was none.\n- #22 brings compact source files and instance `main` methods, which JBang scripts use a lot.\n","author":{"url":"https://github.com/abashev","@type":"Person","name":"abashev"},"datePublished":"2026-09-21T13:51:12Z","url":"https://github.com/openjavaformat/open-java-format/issues/24"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:6773fad0-b650-d6c0-2e68-8cb69a4b8fae
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id898A:8FDF6:5F429E:7EA69D:6AFBC73A
html-safe-nonceade72df9e6e876b5b491435b3c5b9c65774fb2dc37cd6023ddbba89c09c1e4b8
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4OThBOjhGREY2OjVGNDI5RTo3RUE2OUQ6NkFGQkM3M0EiLCJ2aXNpdG9yX2lkIjoiMzQ3NzIxMjc5OTI4NTE4NDU4IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac8ee488d0deb97801d3ad6223b74a07ff8f80d472ff8db8eab6cf9ada76f8a123
hovercard-subject-tagissue:5527893858
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/openjavaformat/open-java-format/24/issue_layout
twitter:imagehttps://opengraph.githubassets.com/0e3fe9babde87801629bcdfdf4c9045443e6027c8a54baed32ea0a536ea5b911/openjavaformat/open-java-format/issues/24
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/0e3fe9babde87801629bcdfdf4c9045443e6027c8a54baed32ea0a536ea5b911/openjavaformat/open-java-format/issues/24
og:image:altWhat happens JBang reads its configuration from line comments that must start with // immediately followed by the keyword: //DEPS, //JAVA, //SOURCES, //FILES, //JAVA_OPTIONS and so on. A script usu...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameabashev
hostnamegithub.com
expected-hostnamegithub.com
Noned440bda0d812801778b27bfe9f7c1ce9ff22420c73f6f95150c4fcbca311c50b
turbo-cache-controlno-preview
go-importgithub.com/openjavaformat/open-java-format git https://github.com/openjavaformat/open-java-format.git
octolytics-dimension-user_id325177626
octolytics-dimension-user_loginopenjavaformat
octolytics-dimension-repository_id1288055459
octolytics-dimension-repository_nwoopenjavaformat/open-java-format
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forktrue
octolytics-dimension-repository_parent_id214273098
octolytics-dimension-repository_parent_nwopalantir/palantir-java-format
octolytics-dimension-repository_network_root_id214273098
octolytics-dimension-repository_network_root_nwopalantir/palantir-java-format
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release2c43021aed8695990c86c0eaaedc600bfeffec36
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/openjavaformat/open-java-format/issues/24#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenjavaformat%2Fopen-java-format%2Fissues%2F24
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenjavaformat%2Fopen-java-format%2Fissues%2F24
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=openjavaformat%2Fopen-java-format
Reloadhttps://github.com/openjavaformat/open-java-format/issues/24
Reloadhttps://github.com/openjavaformat/open-java-format/issues/24
Reloadhttps://github.com/openjavaformat/open-java-format/issues/24
openjavaformathttps://github.com/openjavaformat
open-java-formathttps://github.com/openjavaformat/open-java-format
Codehttps://github.com/openjavaformat/open-java-format
Issues30 (30)https://github.com/openjavaformat/open-java-format/issues
Pull requests5 (5)https://github.com/openjavaformat/open-java-format/pulls
Discussionshttps://github.com/openjavaformat/open-java-format/discussions
Actionshttps://github.com/openjavaformat/open-java-format/actions
Security and qualityhttps://github.com/openjavaformat/open-java-format/security
Insightshttps://github.com/openjavaformat/open-java-format/pulse
https://github.com/openjavaformat/open-java-format
New issuehttps://github.com/login?return_to=https://github.com/openjavaformat/open-java-format/issues/24
New issuehttps://github.com/login?return_to=https://github.com/openjavaformat/open-java-format/issues/24
#91https://github.com/openjavaformat/open-java-format/pull/91
Do not rewrite JBang directives: //DEPS becomes // DEPS and the script loses its dependencieshttps://github.com/openjavaformat/open-java-format/issues/24#top
#91https://github.com/openjavaformat/open-java-format/pull/91
bugSomething isn't workinghttps://github.com/openjavaformat/open-java-format/issues?q=state%3Aopen%20label%3A%22bug%22
https://github.com/abashev
abashevhttps://github.com/abashev
on Sep 21, 2026https://github.com/openjavaformat/open-java-format/issues/24#issue-5527893858
JBanghttps://www.jbang.dev
#23https://github.com/openjavaformat/open-java-format/issues/23
avoid adding space on // comments? google/google-java-format#1217https://github.com/google/google-java-format/issues/1217
do not touch /// in first lines google/google-java-format#1218https://github.com/google/google-java-format/issues/1218
Comments starting with /// should not be reformatted as // / google/google-java-format#1215https://github.com/google/google-java-format/issues/1215
Allow detecting DEPS with the schema // DEPS jbangdev/jbang#1194https://github.com/jbangdev/jbang/issues/1194
Bring over upstream PRs #1707 (Java 25 syntax) and #1786 (JDK 27 end positions) #22https://github.com/openjavaformat/open-java-format/issues/22
abashevhttps://github.com/abashev
bugSomething isn't workinghttps://github.com/openjavaformat/open-java-format/issues?q=state%3Aopen%20label%3A%22bug%22
on Sep 21, 2026https://github.com/openjavaformat/open-java-format/issues/24#event-31532859269
abashevhttps://github.com/abashev
completedhttps://github.com/openjavaformat/open-java-format/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#91https://github.com/openjavaformat/open-java-format/pull/91
on Sep 28, 2026https://github.com/openjavaformat/open-java-format/issues/24#event-32017971006
abashevhttps://github.com/abashev
on Sep 28, 2026https://github.com/openjavaformat/open-java-format/issues/24#event-32021729577
Install open-java-format 2.98.0.5 and add JBang to the library ruleshttps://github.com/openjavaformat/docs/commit/fe294a545eff61c17c1b4167ab34132d139dc879
fe294a5https://github.com/openjavaformat/docs/commit/fe294a545eff61c17c1b4167ab34132d139dc879
Check with open-java-format 2.98.0.5https://github.com/openjavaformat/open-java-format-action/commit/80a52bb101f010597f329e72682c704feee3e8ce
80a52bbhttps://github.com/openjavaformat/open-java-format-action/commit/80a52bb101f010597f329e72682c704feee3e8ce
Sign up for freehttps://github.com/signup?return_to=https://github.com/openjavaformat/open-java-format/issues/24
Sign in to commenthttps://github.com/login?return_to=https://github.com/openjavaformat/open-java-format/issues/24
bugSomething isn't workinghttps://github.com/openjavaformat/open-java-format/issues?q=state%3Aopen%20label%3A%22bug%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.