@joinbox/build-task

Intro

Build task for Joinbox' Drupal projects that provides command line actions running with reasonable defaults for JavaScripts and SASS.

Tasks include multiple options, the ability to emit notifications on success and source maps.

Installation

npm i -D @joinbox/build-task core-js regenerator-runtime

core-js and regenerator-runtime are required to inline the corresponding polyfills.

Commands

Styles

• Converts SASS to CSS
• Adds autoprefixes through postcss
• Accepts globs for input files; use quotation marks around paths in this case
• Supports compression
• Generates source maps
• Creates output directory if it doesn't exist
• Displays notification on success
• Watches files

Command

npx @joinbox/build-task styles -n -c -s src/scss -d dist/css -w "**/*.scss, other-path/*.scss" "**/*.scss"

Make sure to use quotation marks around paths if you use globs (in order for them to be resolved through JS instead of CLI)

Options

To see all available options, call the styles build task with the help option (-h or --help):

npx @joinbox/build-task styles -h

Scripts

• Bundles JavaScript files
• Compiles code to previous ES versions
• Can watch source files for changes
• Accepts globs for input files; use quotation marks around paths in this case
• Builds for selected browsers and ES versions (esbuild and SWC)
• Supports minification (esbuild and SWC)
• Generates source maps
• Embedds core-js polyfills where needed
• Creates output directory if it doesn't exist
• Displays notification on success
• Watches files

Command

npx @joinbox/build-task scripts -m -t es5 -e "ie 11" -s src/js -d dist/js -w "**/*.js, other-path/*.js" "**/*.js"

Make sure to use quotation marks around paths if you use globs (in order for them to be resolved through JS instead of CLI)

Options

To see all available options, call the scripts build task with the help option (-h or --help):

npx @joinbox/build-task scripts -h

Complete Build Task for Projects

Use the following setup for Drupal projects:

1. Install all additional modules: npm i -D chokidar-cli npm-run-all @babel/eslint-parser @joinbox/eslint-config-joinbox eslint @joinbox/stylelint-config-joinbox stylelint svgo

2. Add the following scripts property to your package.json:

   "scripts": {
       "dev:styles": "npm run lint:styles ; npx @joinbox/build-task styles -n -s src/scss -d dist/css -w \"src/scss/**/*.scss, template-library/**/*.scss\" main.scss",
       "live:styles": "npx @joinbox/build-task styles -n -c -s src/scss -d dist/css main.scss",
       "dev:scripts": "npm run lint:scripts ; npx @joinbox/build-task scripts -n -s src/js -d dist/js -w \"src/js/**/*.js, template-library/**/*.js\" main.js",
       "live:scripts": "npx @joinbox/build-task scripts -n -m -s src/js -d dist/js main.js",
       "copy:fonts": "mkdir -p dist/webfonts && cp -r src/webfonts dist",
       "watch:fonts": "npx chokidar \"src/webfonts/**/*.*\" -c \"npm run copy:fonts\"",
       "copy:media": "mkdir -p dist/media && rsync -rq src/media dist/media --exclude=\"*.svg\" && svgo -f src/media -o dist/media -r -q",
       "watch:media": "npx chokidar \"src/media/**/*.*\" -c \"npm run copy:media\"",
       "clean": "(rm -r dist || true)",
       "lint:styles": "npx stylelint \"src/**/*.scss\" \"template-library/**/*.scss\" --config .stylelintrc",
       "lint:scripts": "npx eslint \"src/**/*.js\" \"template-library/**/*.js\" -c node_modules/@joinbox/eslint-config-joinbox/index.js",
       "dev": "npm-run-all clean -p copy:* dev:* watch:*",
       "live": "npm-run-all clean -s copy:* live:*"
   }
   

   Use -s option for live script because -p brings down Cyon servers.

3. Create a new file named .eslintrc in yout theme folder and add the following rules:

   {
      "extends": "@joinbox/joinbox",
      "root": true,
      "parser": "@babel/eslint-parser"
   }
   

4. Create a new file named svgo.config.js in your theme folder and add the following rules:

   module.exports = {
      plugins: [
          {
              name: 'preset-default',
              params: {
                  overrides: {
                      removeViewBox: false,
                  },
              },
          },
          'removeDimensions'
      ]
    };
   

Update from Earlier Versions

If you update from earlier versions, make sure to

• remove all unnecessary NPM packages from package.json (especially @babel/core, browser-sync, gulp, postcss)
• remove unnecessary scripts from package.json
• remove gulpfile.js
• update @joinbox/build-task to newest version and follow this README's instructions