10up
Local development docs should mention wp-scripts, or install as part of setup
Describe the bug
I'm installing this plugin to contribute a PR. When setting up the plugin, I noticed package.json and ran npm i. Checking package.json for commands, I ran npm run start. It appears that the local development workflow has an undocumented dependency on wp-scripts
Steps to Reproduce
- Clone this repo.
npm installnpm run start
Result:
$ npm run start
> [email protected] start
> wp-scripts start
sh: wp-scripts: command not found
Screenshots, screen recording, code snippet
No response
Environment information
- OS: macOS 14.6
- shell: bash, GNU bash version 3.2.57
- node: 18.18.0
- npm: 9.8.1
WordPress information
No response
Code of Conduct
- [X] I agree to follow this project's Code of Conduct
I think there are three logical places to find this documentation:
- https://github.com/10up/distributor/blob/develop/CONTRIBUTING.md
README.md- in a new top-level
DEVELOPING.md - in the repo wiki
We do already have developer documentation but it could be more explicit on the commands you need to run to get things ready.
I will say I can't reproduce the reported issue. You will need to use the proper node version, which is documented in the link above. Easiest way is to use nvm:
$ nvm use
$ npm install
$ npm run start
