How do you build?

[pmcelhaney]

It looks like you're just concatenating and minifying all the files. Do they have the be in any particular order? Is there a command or build script I can run?

[luketw]

Hi Patrick,

You're correct - we don't provide a build script for use, but it's just concatenated across all the JS files in the repo [except the PhantomJS folder], and minified (we use Google Closure Compiler for the latter) so it should be simple enough to build one.

We also minify the CSS/images side of things by removing white space from the CSS and renaming the images to 1.jpg, 2.png, etc. so references to them take up less space in the CSS file.

The JS files don't have to be in any particular order, because it doesn't run itself - you then need to take the bookmarklet and just alter the path to your copy.

Minifying isn't crucial - it will run without it (as it will load up standards files as needed) but it does improve performance because the standards are already there.

[luketw]

Hi Patrick,

Now that #83 has been merged in, you can use node.js and Grunt to build a developer version of the auditor.

If you have node.js and/or Grunt you can ignore the first two steps, naturally.

• Install node.js through your package manager of choice
  • You may need to update the package manager itself (sudo npm update -g npm)
• Install Grunt using their Getting Started guide.
• cd $YOUR_HTMLCS_DIR and git pull as appropriate
• npm install to install the Grunt tasks' dependencies locally
• grunt --gruntfile Contrib/Grunt/gruntfile.coffee build to build it.
  • You should get an uglify and copy task come up.

If all is well, you should get a build directory with a HTMLCS.js, HTMLCS.css, an Images directory and the licence file. You can copy this into somewhere accessible through a browser.

Then grab or copy the auditor bookmarklet, and replace the directory at the start (//squizlabs.github.io/HTML_CodeSniffer/build) with your local URL.

[luketw]

I'm going to close this, because essentially the way it's built at the moment is still the same as above, and the official build (for the auditor etc) is done essentially the same way now. Still works correctly for me with the newest Node (6.0) that came out this week.

[luketw]

I will just finalise this with:

• As of today, I've moved the gruntfile to the top directory, so you no longer have to go to Contrib/Grunt for that: just run "grunt build" from the top.
• I'm going to put brief documentation into the README.markdown as to how to do this.

Thanks again~