Skip to content

Document the repository formatting command (#58458) - #58458

Open
cortinico wants to merge 10 commits into
mainfrom
export-D119487619
Open

Document the repository formatting command (#58458)#58458
cortinico wants to merge 10 commits into
mainfrom
export-D119487619

Conversation

@cortinico

@cortinico cortinico commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Summary:

Document yarn format, yarn format-check, every format-<language> / format-check-<language> command, and the prerequisite checks that warn and skip unavailable language toolchains.

Changelog: [Internal]

Differential Revision: D119487619

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Sep 10, 2026
@meta-codesync

meta-codesync Bot commented Sep 10, 2026

Copy link
Copy Markdown

@cortinico has exported this pull request. If you are a Meta employee, you can view the originating Diff in D119487619.

meta-codesync Bot pushed a commit that referenced this pull request Sep 10, 2026
Summary:
Pull Request resolved: #58458

Document `yarn format`, `yarn format-check`, every `format-<language>` / `format-check-<language>` command, and the prerequisite checks that warn and skip unavailable language toolchains.

Changelog: [Internal]

Differential Revision: D119487619
@meta-codesync meta-codesync Bot changed the title Document the repository formatting command Document the repository formatting command (#58458) Sep 10, 2026
meta-codesync Bot pushed a commit that referenced this pull request Sep 10, 2026
Summary:
Pull Request resolved: #58458

Document `yarn format`, `yarn format-check`, every `format-<language>` / `format-check-<language>` command, and the prerequisite checks that warn and skip unavailable language toolchains.

Changelog: [Internal]

Differential Revision: D119487619
meta-codesync Bot pushed a commit that referenced this pull request Sep 10, 2026
Summary:
Pull Request resolved: #58458

Document `yarn format`, `yarn format-check`, every `format-<language>` / `format-check-<language>` command, and the prerequisite checks that warn and skip unavailable language toolchains.

Changelog: [Internal]

Differential Revision: D119487619
meta-codesync Bot pushed a commit that referenced this pull request Sep 10, 2026
Summary:
Pull Request resolved: #58458

Document `yarn format`, `yarn format-check`, every `format-<language>` / `format-check-<language>` command, and the prerequisite checks that warn and skip unavailable language toolchains.

Changelog: [Internal]

Differential Revision: D119487619
Summary:
Use the public Prettier configuration for the complete OSS JavaScript and documentation surface. Expose `yarn format-javascript` and `yarn format-check-javascript`, and compose them into the repository-wide commands.

Changelog: [Internal]

Differential Revision: D119487610
Summary:
Add npm-driven clang-format commands for exported C-family sources. Expose `yarn format-cpp` and `yarn format-check-cpp`, and compose them into the repository-wide commands. The wrapper automatically selects the repository-provided formatter for its environment.

Changelog: [Internal]

Differential Revision: D119487611
Summary:
Add `yarn format-kotlin` and `yarn format-check-kotlin` using the npm `ktfmt` package and its bundled formatter jar. This adds the offline package mirror and workspace lock entry without changing existing Kotlin source formatting or Gradle configuration. The wrapper discovers a suitable JDK when available and otherwise prints environment-specific Java 17 setup guidance before skipping Kotlin.

allow-large-files: The npm package intentionally contains the upstream ktfmt executable jar so offline and public installs use the same formatter.

Changelog: [Internal]

Differential Revision: D119487612
Summary:
Remove the ktfmt Gradle plugin and its task wiring now that Kotlin formatting is provided by the repository npm command.

Changelog: [Internal]

Differential Revision: D119504761
Summary:
Add `yarn format-java` and `yarn format-check-java` using the npm `google-java-format` package, which bundles google-java-format 1.23.0. This removes the Gradle build dependency and adds the offline package mirror and workspace lock entries. The wrapper discovers a suitable JDK when available and otherwise prints environment-specific Java 17 setup guidance before skipping Java.

Changelog: [Internal]

Differential Revision: D119487613
Summary:
Add `yarn format-python` and `yarn format-check-python` using Ruff, and compose them into the repository-wide commands. The wrapper selects a repository-provided Ruff binary when available or bootstraps pinned Ruff through Python 3 and pip. Missing tools produce environment-specific setup guidance before Python is skipped.

Changelog: [Internal]

Differential Revision: D119487614
Summary:
Add `yarn format-swift` and `yarn format-check-swift` using Apple swift-format, and compose them into the repository-wide commands. The wrapper selects a repository-provided formatter when available or uses swift-format 6.3 or newer from the Swift toolchain. Missing tools produce environment-specific setup guidance before Swift is skipped.

Changelog: [Internal]

Differential Revision: D119487615
Summary:
Reformat the Kotlin and Kotlin Gradle sources with the npm-backed ktfmt 0.59.0 command after Arcanist formatting has been disabled for OSS-exported sources.

Changelog: [Internal]

Differential Revision: D119504762
Summary:
Add a GitHub Actions formatting check that runs the repository-wide formatter check and posts line-level suggested fixes through the GitHub API for files that need reformatting.

Changelog: [Internal]

Differential Revision: D119487616
Summary:
Pull Request resolved: #58458

Document `yarn format`, `yarn format-check`, every `format-<language>` / `format-check-<language>` command, and the prerequisite checks that warn and skip unavailable language toolchains.

Changelog: [Internal]

Differential Revision: D119487619
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. meta-exported p: Facebook Partner: Facebook Partner

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant