Repository navigation
docs: document v13 build-system configuration and commands - #1486
Open
fhammerschmidt wants to merge 2 commits into
Open
fhammerschmidt wants to merge 2 commits into
fhammerschmidt wants to merge 2 commits into
Conversation
Update output defaults, production filtering, feature-gated sources and dependency features, and watch behavior in the existing build pages. Keep restored legacy configuration aliases accurately documented as deprecated compatibility, and clarify schema coverage and monorepo settings. Refs rescript-lang#1476.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Restore "You can mark" so marking source directories as dev-only reads as an optional configuration choice.
aspeddro
reviewed
Nov 4, 2026
aspeddro
left a comment
aspeddro
left a comment
Collaborator
There was a problem hiding this comment.
I left only one comment
Comment on lines
+285
to
+300
| ## Migrating Older Configurations | ||
|
|
||
| Use `rescript.json` for new projects. For compatibility, the build system also reads `bsconfig.json` when `rescript.json` is absent, with a deprecation warning. | ||
|
|
||
| Prefer these current configuration keys: | ||
|
|
||
| | Legacy key | Current key | | ||
| | --------------------- | ------------------ | | ||
| | `bs-dependencies` | `dependencies` | | ||
| | `bs-dev-dependencies` | `dev-dependencies` | | ||
| | `bsc-flags` | `compiler-flags` | | ||
|
|
||
| The legacy keys are still accepted with deprecation warnings. Remove `external-stdlib`; it is no longer supported. | ||
|
|
||
| Use `esmodule` instead of `es6` or `es6-global`, and `commonjs` instead of `cjs`. The `es6` and `cjs` aliases are still accepted with deprecation warnings; `es6-global` is unsupported. | ||
|
|
Collaborator
There was a problem hiding this comment.
Maybe we should move this to "Migrate to v13" page?
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The v13 build pages still describe CommonJS and out-of-source defaults and omit production filtering, feature selection, and the updated watch workflow. Update the existing overview, configuration, monorepo, and schema-reference pages.
--prod, feature-gated source directories, dependency feature selection, transitive feature implications,watch --clear-screen, and builds while a watcher is active. Compiler references: #8347, #8379, #8373, #8349.bsconfig.jsonand legacy field aliases were restored in #8368, after their initial removal; they remain accepted with deprecation warnings. Document the unsupportedexternal-stdliboption andes6-globalformat separately (#8175, #8205).Refs #1476. This PR targets
v13only. Behavior was checked against the published alpha.6 source, including compatibility reversals missing from the checklist's original wording.