Docs: DO-0 add Dara JS build redesign proposal#623
Draft
krzysztof-causalens wants to merge 9 commits into
Draft
Conversation
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.
Motivation and Context
Dara's current JS build flow relies on a generated
dist/workspace,dara.config.json, machine-dependent Node setup, and a separate UMD / auto-JS path for non-custom-JS apps.This PR does not change runtime behavior yet. It adds an internal proposal document so the team can review a concrete redesign direction in-repo rather than keeping the design only in chat notes.
The current proposal covers:
dara.lockto avoid cross-platform lock churnpackage.json,pnpm-lock.yaml, anddara.lockthe checked-in reproducibility surface for every app.dara/,dist/, andnode_modules/as generated or installed state that should not be checked indara lockdara ejectthe point where the root JS workspace becomes user-owned, with a warning and a narrow merge of Dara-required dependencies@darajs/vite-pluginboundary so ejected configs stay stable and simpledara.config.jsonvia compatibility, warn, and enforce phases, with deterministic handling of legacy package-manager settingsImplementation Description
Added a new top-level internal docs area and a draft design proposal at
docs-internal/proposals/dara-js-build-redesign.md.The proposal is intentionally opinionated enough to be actionable, but still leaves a few explicit open questions around the compatibility window for
dara.config.jsonand where ejected source/config files should live by default.This PR only updates internal documentation. The earlier draft changelog note was removed because this proposal is not a user-facing package change.
Tradeoffs:
package.jsonandpnpm-lock.yamlas checked-in files for reproducibility, whiledara lockremains the normal way for less experienced users to refresh them.DO-0placeholder because no real ticket identifier was provided, but the repo's PR lint requires a ticket-shaped prefix.Any new dependencies Introduced
None.
How Has This Been Tested?
git diff --check.No runtime tests were run because this PR only updates an internal proposal document.
PR Checklist:
Screenshots (if appropriate):
N/A