5) Development - ChrisWinters/includes GitHub Wiki
View the package.json to view dependencies, commands, manage the development build, bump version numbers, zip the project, and to build translation strings.
Build commands
- Install the project:
npm install
- Build stylesheets:
npm run css
- Generate lang/includes.pot file:
npm run translate
- Bump plugin version:
npm run version
- Zip project for release:
npm run zip
All commands
npm run css
npm run css-build
npm run css-prefix
npm run css-minify
npm run translate
npm run version
npm run zip
npm run copy-files
npm run zip-files
npm run remove-zip
Sassy Cascading Style Sheets
- _custom-styling.scss Add custom styling to the project
- _custom-variables.scss Set custom variables for the project
- style.scss Required project imports, import stripped down Bootstrap 5
Build files
The _src/
directory contains all project build files.
├── _src/
│ ├── scss/
│ │ ├── _custom-styling.scss | Plugin admin styling
│ │ ├── _custom-variables.scss | Override Bootstrap 5 variables
│ │ ├── style.scss | Include stripped down Bootstrap 5 and plugin styling
├── configInquirer.js | Questions for inquirer - walks user through release questions
├── configLasUpdated.js | Sets the last updated date
├── configPluginVersions.js | Sets the entered version number
├── configRequiredPHP.js | Sets the entered version number
├── configTestedWP.js | Sets the entered version number
├── dateTime.js | Get the date and time for the release
├── postcss.config.js | Clean CSS configuration file
├── removeZip.js | Deletes temporary /zip/ directory
├── replacer.js | Run replace tasks (bump version number, etc)
├── version.js | Bumps plugin and WordPress tested versions, sets updated date
├── zipFiles.js | Copies project into /zip/ directory and compresses into includes.zip file