Patch 2: grunt #469

amroamroamro · 2017-01-18T15:10:37Z

Summary:

created package.json and bower.json for integrating with npm and Bower package managers. Note: I set the version to "1.0.0", feel free to change it to something else if needed.
replaced functionality of the makefile with grunt. I added grunt tasks to match make targets, including:
- grunt preprocess to process js-modules/*.js files and produce src/prettify.js and src/run_prettify.js bundles
- grunt gcc to compile/minify JS using Closure Compiler (also added a grunt uglify task as alternative, but it's not used by default)
- grunt cssmin to minify CSS files
- grunt aliases to create lang aliases
- grunt compress to produce a ZIP file for distribution
- grunt clean to clean generated files

To rebuild the project from scratch, first you need to install Node, then you simply run :

$ cd code-prettify
$ npm install
$ npm run grunt

(note: Closure Compiler requires Java JRE to run).

ran 'npm init' and 'bower init' and filled some fields

@include

we're a using package which processes @include directives (similar to server-side-includes) We also use @ifdef/@ifndef to customize prettify and run_prettify

replace PR.PR_PLAIN with "pln", etc.

This is needed because closure-compiler:langs will attempt to compile all 30+ lang files in parallel, each being a separate target. The concurrent Java processes will struggle for memory and crash. This task will split the multi-file target into separate targets, each with one file. This way the lang files are compiled one by one.

functionality replaced with grunt

this way we dont need to have grunt-cli globally installed, we can just use: "npm install && npm run grunt" (Note: npm sets the PATH correctly to find ./node_modules/.bin/grunt)

mikesamuel · 2017-01-20T02:45:18Z

js-modules/defs.js

 var IN_GLOBAL_SCOPE = true;
+/* @endif */
+/* @ifdef RUN_PRETTIFY */
+var IN_GLOBAL_SCOPE = false;


Doesn't this cause duplicate definition warnings under closure compiler?

it won't because the file is never fed directly to closure compiler, it only sees src/prettify.js and src/run_prettify.js by which time those directives are already "processed" and only one of the two alternatives survives (either true or false depending on wheather RUN_PRETTIFY was set in the context (see the grunt preprocess task options)).

In fact the value used here doesn't really matter (I set it here only as a form of documentation), because we later pass the closure-compiler option --define='IN_GLOBAL_SCOPE=??' which overrides the const anyway: https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#define-type-description

Understood. LGTM

mikesamuel · 2017-01-20T02:46:58Z

js-modules/regexpPrecederPatterns.pl

 print "$pattern;\n";
-
-print "
-// CAVEAT: this does not properly handle the case where a regular


Note to self. Caveat moved to top file comment.

yes, that way it shows up above the regex it's talking about when included in the final bundle.

mikesamuel · 2017-01-20T02:47:54Z

js-modules/prettify.js

-include("defs.js");
-
-var HACK_TO_FIX_JS_INCLUDE_PL;
+/* @ifndef RUN_PRETTIFY */


Note to self: run_prettify includes defs.js above its envelope.

From what I understand this is a limitation of closure compiler: https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#typedef-type, so I tried to keep things the same as what js_include.pl was doing, so that defs.js typedefs are always included top-level in both prettify.js and run_prettify.js

mikesamuel · 2017-01-20T02:48:38Z

package.json

+    "Mike Samuel <[email protected]>"
+  ],
+  "contributors": [
+    "Amro <[email protected]>"


I think it would be more accurate to put you down as a maintainer these days.

mikesamuel · 2017-01-20T02:51:01Z

tasks/gcc.js

+   * separate targets (one file per target) so that lang files are compiled
+   * sequentially (sync) instead of in parallel (async).
+   */
+  grunt.registerMultiTask('gcc', 'Override closure-compiler', function () {


It blows my mind that someone would use "gcc" as an abbreviation for Google Closure Compiler.

hehe, what other GNU compiler thing :)

graingert · 2017-01-21T13:10:00Z

@mikesamuel you forgot to publish this to npm. Now the package name has been stolen.

amroamroamro · 2017-01-21T13:17:30Z

I didn't realize this was the wild west!

graingert · 2017-01-24T21:18:21Z

@mikesamuel @amroamroamro is this going to be fixed?

amroamroamro · 2017-01-24T21:23:42Z

@graingert I noticed you published the package under the code-prettify name. Was that to protect the name before others grab it?

graingert · 2017-01-25T10:43:05Z

@amroamroamro it was to steal it! But yeah I'll hand it over if you promise to be more careful next time, and one of the members gives me their preferred npm ID.

tamj0rd2 · 2017-02-14T12:24:56Z

Can we get some details on how to use code-prettify with npm?

graingert · 2017-02-14T12:26:07Z

@amroamroamro you've not been forthcoming with any npm IDs...

graingert · 2017-02-14T12:26:41Z

@tamj0rd2 I would not recommend using the npm edition of this tool until the official team have some ownership over the module name.

amroamroamro · 2017-02-15T00:01:09Z

@graingert I ran npm adduser and created amroamroamro.

amroamroamro · 2017-02-15T00:08:23Z

@tamj0rd2 If I'm not mistaken, you can always install directly from GitHub repo:

npm install google/code-prettify

or specify the full URL: https://github.com/google/code-prettify

graingert · 2017-02-15T00:41:56Z

Yeah but that breaks npm shrinkwrap

amroamroamro added 16 commits January 18, 2017 16:38

run perl script and commit the output JS file

98d96cd

initialize NPM package

1788a65

ran 'npm init' and 'bower init' and filled some fields

add grunt as dependency and create initial Gruntfile

99aefbe

replace js_include.pl with a grunt task

1af2191

we're a using package which processes @include directives (similar to server-side-includes) We also use @ifdef/@ifndef to customize prettify and run_prettify

add grunt task to trim tailing spaces in processed files

6837954

add grunt task to minify using UglifyJS

571d3bf

add grunt task to minify using clean-css

55795c0

add task to inline token strings in minifed lang files

d03ae80

replace PR.PR_PLAIN with "pln", etc.

add grunt task to create distrbution zip file

173a9d7

add grunt clean task

17cdd73

add task to minify using Closure Compiler

896ce95

new custom task to create lang aliases

95e4c1e

remove old makefile and related build tools

95a55b3

functionality replaced with grunt

update git ignore patterns

db24f68

add an npm script to call the local grunt

1d9e1ad

this way we dont need to have grunt-cli globally installed, we can just use: "npm install && npm run grunt" (Note: npm sets the PATH correctly to find ./node_modules/.bin/grunt)

amroamroamro requested a review from mikesamuel January 19, 2017 08:42

mikesamuel approved these changes Jan 20, 2017

View reviewed changes

mikesamuel merged commit f6c4ce7 into googlearchive:master Jan 20, 2017

amroamroamro deleted the patch-grunt branch January 20, 2017 14:08

This was referenced Jan 21, 2017

Package.json for usage with npm #405

Closed

Add package.json #379

Closed

Add bower.json #432

Closed

Add main fileld to package.json #462

Closed

Patch 2: grunt #469

Patch 2: grunt #469

Uh oh!

Conversation

amroamroamro commented Jan 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

graingert commented Jan 21, 2017

Uh oh!

amroamroamro commented Jan 21, 2017

Uh oh!

graingert commented Jan 24, 2017

Uh oh!

amroamroamro commented Jan 24, 2017

Uh oh!

graingert commented Jan 25, 2017

Uh oh!

tamj0rd2 commented Feb 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

graingert commented Feb 14, 2017

Uh oh!

graingert commented Feb 14, 2017

Uh oh!

amroamroamro commented Feb 15, 2017

Uh oh!

amroamroamro commented Feb 15, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

graingert commented Feb 15, 2017

Uh oh!

Uh oh!

amroamroamro commented Jan 18, 2017 •

edited

Loading

tamj0rd2 commented Feb 14, 2017 •

edited

Loading

amroamroamro commented Feb 15, 2017 •

edited

Loading