docs(scripts): refresh development scripts reference#10861
Open
yogeshwaran-c wants to merge 1 commit into
Open
docs(scripts): refresh development scripts reference#10861yogeshwaran-c wants to merge 1 commit into
yogeshwaran-c wants to merge 1 commit into
Conversation
The scripts table in docs/development/scripts.md drifted from package.json: it still listed scripts that were renamed (build-bundle, build-core, build-standalone) or removed (watch, e2e, e2e-cypress, dev-e2e-cypress, the per-bundle test:artifact entries) and was missing the cy:* Cypress runners, clean, build-all-bundles, the deps/security audit scripts, and serve-static/start. Update the page so each section matches the current scripts in package.json and groups them by purpose.
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
1 participant
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.
Description
The script table in
docs/development/scripts.mdwas last meaningfully updated several years ago and has drifted from the actualscriptsblock inpackage.json. The page still documents scripts that have been renamed or removed, and is missing many that exist today, which makes it misleading for new contributors trying to find the right command.Motivation and Context
Concretely, the doc currently lists the following scripts that no longer exist in
package.json:watchbuild-bundle,build-core,build-standalone(renamed tobuild:bundle,build:core,build:standalone)e2e(the Selenium runner is gone)e2e-cypress,dev-e2e-cypress(replaced by thecy:*family)test:artifact:umd:bundle,test:artifact:es:bundle,test:artifact:es:bundle:coreAnd it never mentions these scripts that currently exist:
start,serve-static,clean,build-all-bundlescy:mock-api,cy:server,cy:start,cy:open,cy:run,cy:ci,cy:devdeps-license,deps-sizesecurity-audit,security-audit:all,security-audit:prodThis PR rewrites the table so each section matches the current
package.jsonand groups scripts by purpose (Developing, Building, Testing, Security).How Has This Been Tested?
Pure documentation change — verified each row in the new table maps 1:1 to a script currently defined in
package.json. No code paths touched.Checklist