Build system overhaul.

[bardiharborow]

This PR switches every build task to a NPM script, except saucelabs (this is surprisingly non-trivial, and I'm pushing it to a later PR as this has taken way too long as it is). Closes #20332.

List of tasks that need to included. A ticked checkbox indicates that the task has been tested.

• CSS
  • Linting (scss-lint)
    • Core
    • Docs
  • Compile (node-sass)
    • Core
    • Docs
  • Prefix (postcss)
    • Core
    • Docs
  • Minify (cleancss)
    • Core
    • Docs
• JavaScript
  • Linting (eslint)
    • Core
    • Docs
  • Concatenate + Transpile (Babel)
    • Bundle
    • Individual plugins
  • Minify (uglifyjs)
    • Core
    • Docs
  • Test (qunit + PhantomJS)
    • Local
    • SauceLabs (punting conversion to npm)
• Docs
  • Clean (cp -r dist/* docs/dist/)
  • Linting (htmlhint + htmllint)
  • Compile (Jekyll)
    • Local
    • GitHub
  • Serve (Jekyll)
  • Push to GitHub (punting)
• Maintenance
  • Update dependencies (npm-check-update)
  • Shrinkwrap (npm)
• Release
  • Change version number (custom node script)
  • Package zip file (GNU zip)
  • Push to npm, etc. (punting)

[mdo]

How best can I give feedback on this @bardiharborow? Do you have a checklist of remaining todos, or specific things that need testing?

[bardiharborow]

@mdo I've added a list of tasks and their review status. A local npm test now works (finally!). I have to work on replacing grunt-stamp, grunt-saucelabs and grunt-build-control, and then we might actually be done!

[mdo]

grunt-build-control can probably go away. I don't use it right now and just manually copy-pasta our generated docs and stuff :). I'd love something that actual worked, but in the spirit of moving this forward, we can do that later.

[hanakin]

Pls consider using stylelint over scss lint as it offers far more control and flexibility in code control with plugin support for additional control

[bardiharborow]

@hanakin We'll be shipping that after this PR merges. It's just going to require a lot of config wrangling, and I'm juggling enough changes in this PR as it is.

[bardiharborow]

Preparing to ship this. I have every expectation that something will go wrong and I'll be thoroughly trouted for it, but anyway...

[Johann-S]

Hi @bardiharborow,

I have an error when this task is runned see :

I know my screenshot is in french, but it said :
'popover).js'' isn't known at an intern or extern command

[bardiharborow]

Okay. I thought that shx was performing the glob expansion, but maybe bash is doing it, and that obviously won't work on Windows. I'll replace this with a static list for now.

[patrickhlauke]

not sure if it's something broken at my end, but: i fetched and rebased my fork on my machine, did a new npm install...but now when i try to run grunt i simply get Warning: Task "default" not found. Use --force to continue.

[edit: ah, don't mind me...i guess the whole way of building is now different and i should build the local docs and read them...]

[Johann-S]

They are just one task on our Gruntfile.js the other are in package.json

And for example to run the css task you have to do :
npm run css

[patrickhlauke]

so forgive me being thick, but...what's the equivalent now of the old grunt which built everything, followed by bundle exec jekyll serve

[Johann-S]

It seems it's test task and after you can call docs-serve task which will call bundle exec jekyll serve

[patrickhlauke]

tried npm run test on a hunch, and it errors out with "Could not find jekyll-sitemap-1.1.1 in any of the sources". joys of running this on windows...

(every time the build process changes subtly i end up with not being able to do anything on my windows machine until i uninstall everything and then reinstall everything based on the docs...so if the relevant docs could also be updated to reflect anything that needs to be done, and in what order, that'd be super)

[edit: rerunning gem install bundler and bundle install - hopefully that'll fix that]

[Johann-S]

Yes it seems they are several bugs on Windows (I'm on Windows too) a PR is open here #22477 we should report any issues here

[mdo]

Awesome to see this merged! You're amazing @bardiharborow. Super happy to see things consolidated :). Only hiccup has been some Sauce failures with running the Sauce grunt task. See #22395 and #22496. Unsure what's going on there just yet.

[silverwind]

Would it make sense to have a npm run dist? I've been using the old grunt dist to just build CSS+JS, and found this to be roughly equal in the new build system (thought it does not do parallelism):

npm-run-all css-compile css-prefix css-minify js-compile-bundle js-compile-plugins js-minify