Merge pull request adobe#5776 from adobe/jasonsanjose/yeoman

Add concat, compile and minify Grunt tasks
matiasbargas · Dec 5, 2013 · 39bac0b · 39bac0b
2 parents 5e6664a + ef1bac2
commit 39bac0b
Show file tree

Hide file tree

Showing 10 changed files with 225 additions and 39 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,4 @@
 Thumbs.db
-src/brackets.css
-src/brackets.min.css
 
 # ignore jenkins build info
 /build.prop
@@ -11,19 +9,22 @@ src/brackets.min.css
 
 # ignore compiled files
 /dist
+/src/.index.html
+/src/styles/brackets.min.css
+/src/styles/brackets.min.css.map
 
 # ignore everything in the dev extension directory EXCEPT the README
 # (so that the directory is non-empty and can be in git)
-src/extensions/dev/*
-!src/extensions/dev/README
+/src/extensions/dev/*
+!/src/extensions/dev/README
 
-src/extensions/disabled
+/src/extensions/disabled
 
 #OSX .DS_Store files
 .DS_Store
 
 # unit test working directory
-test/results
+/test/results
 
 # Netbeans
 /nbproject
@@ -32,4 +33,4 @@ test/results
 .idea
 
 # Files that can be automatically downloaded that we don't want to ship with our builds
-src/extensibility/node/node_modules/request/tests/
+/src/extensibility/node/node_modules/request/tests/
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -24,11 +24,152 @@
 module.exports = function (grunt) {
     'use strict';
 
+    // load dependencies
+    require('load-grunt-tasks')(grunt, {pattern: ['grunt-contrib-*', 'grunt-targethtml', 'grunt-usemin']});
+    grunt.loadTasks('tasks');
+
     var common = require("./tasks/lib/common")(grunt);
 
     // Project configuration.
     grunt.initConfig({
         pkg  : grunt.file.readJSON("package.json"),
+        clean: {
+            dist: {
+                files: [{
+                    dot: true,
+                    src: [
+                        'dist',
+                        'src/.index.html',
+                        'src/styles/brackets.css'
+                    ]
+                }]
+            }
+        },
+        copy: {
+            dist: {
+                files: [
+                    {
+                        'dist/index.html': 'src/.index.html'
+                    },
+                    /* static files */
+                    {
+                        expand: true,
+                        dest: 'dist/',
+                        cwd: 'src/',
+                        src: [
+                            'nls/{,*/}*.js',
+                            'xorigin.js',
+                            'dependencies.js',
+                            'thirdparty/requirejs/require.js',
+                            'LiveDevelopment/launch.html'
+                        ]
+                    },
+                    /* extensions and CodeMirror modes */
+                    {
+                        expand: true,
+                        dest: 'dist/',
+                        cwd: 'src/',
+                        src: [
+                            'extensibility/**/*',
+                            '!extensions/default/*/unittest-files/**/*',
+                            '!extensions/default/*/unittests.js',
+                            'extensions/default/*/**/*',
+                            'thirdparty/CodeMirror2/addon/{,*/}*',
+                            'thirdparty/CodeMirror2/keymap/{,*/}*',
+                            'thirdparty/CodeMirror2/lib/{,*/}*',
+                            'thirdparty/CodeMirror2/mode/{,*/}*',
+                            'thirdparty/CodeMirror2/theme/{,*/}*',
+                            'thirdparty/i18n/*.js',
+                            'thirdparty/text/*.js'
+                        ]
+                    },
+                    /* styles, fonts and images */
+                    {
+                        expand: true,
+                        dest: 'dist/styles',
+                        cwd: 'src/styles',
+                        src: ['jsTreeTheme.css', 'fonts/{,*/}*.*', 'images/*', 'brackets.min.css*']
+                    }
+                ]
+            }
+        },
+        less: {
+            dist: {
+                files: {
+                    "src/styles/brackets.min.css": "src/styles/brackets.less"
+                },
+                options: {
+                    compress: true,
+                    sourceMap: true,
+                    sourceMapFilename: 'src/styles/brackets.min.css.map',
+                    outputSourceFiles: true,
+                    sourceMapRootpath: '',
+                    sourceMapBasepath: 'src/styles'
+                }
+            }
+        },
+        requirejs: {
+            dist: {
+                // Options: https://github.com/jrburke/r.js/blob/master/build/example.build.js
+                options: {
+                    // `name` and `out` is set by grunt-usemin
+                    baseUrl: 'src',
+                    optimize: 'uglify2',
+                    // TODO: Figure out how to make sourcemaps work with grunt-usemin
+                    // https://github.com/yeoman/grunt-usemin/issues/30
+                    generateSourceMaps: true,
+                    useSourceUrl: true,
+                    // required to support SourceMaps
+                    // http://requirejs.org/docs/errors.html#sourcemapcomments
+                    preserveLicenseComments: false,
+                    useStrict: true,
+                    // Disable closure, we want define/require to be globals
+                    wrap: false,
+                    exclude: ["text!config.json"],
+                    uglify2: {} // https://github.com/mishoo/UglifyJS2
+                }
+            }
+        },
+        targethtml: {
+            dist: {
+                files: {
+                    'src/.index.html': 'src/index.html'
+                }
+            }
+        },
+        useminPrepare: {
+            options: {
+                dest: 'dist'
+            },
+            html: 'src/.index.html'
+        },
+        usemin: {
+            options: {
+                dirs: ['dist']
+            },
+            html: ['dist/{,*/}*.html']
+        },
+        htmlmin: {
+            dist: {
+                options: {
+                    /*removeCommentsFromCDATA: true,
+                    // https://github.com/yeoman/grunt-usemin/issues/44
+                    //collapseWhitespace: true,
+                    collapseBooleanAttributes: true,
+                    removeAttributeQuotes: true,
+                    removeRedundantAttributes: true,
+                    useShortDoctype: true,
+                    removeEmptyAttributes: true,
+                    removeOptionalTags: true*/
+                },
+                files: [{
+                    expand: true,
+                    cwd: 'src',
+                    src: '*.html',
+                    dest: 'dist'
+                }]
+            }
+        },
         meta : {
             src   : [
                 'src/**/*.js',
@@ -144,16 +285,9 @@ module.exports = function (grunt) {
             linux: "<%= shell.repo %>/installer/linux/debian/package-root/opt/brackets/brackets"
         }
     });
-
-    // load dependencies
-    grunt.loadTasks('tasks');
-    grunt.loadNpmTasks('grunt-contrib-jasmine');
-    grunt.loadNpmTasks('grunt-contrib-jshint');
-    grunt.loadNpmTasks('grunt-contrib-watch');
-    grunt.loadNpmTasks('grunt-jasmine-node');
 
     // task: install
-    grunt.registerTask('install', ['write-config']);
+    grunt.registerTask('install', ['write-config', 'less']);
 
     // task: test
     grunt.registerTask('test', ['jshint:all', 'jasmine']);
@@ -163,6 +297,24 @@ module.exports = function (grunt) {
     // Update sprint number in package.json and rewrite src/config.json
     grunt.registerTask('set-sprint', ['update-sprint-number', 'write-config']);
 
+    // task: build
+    grunt.registerTask('build', [
+        'jshint:src',
+        'jasmine',
+        'clean',
+        'less',
+        'targethtml',
+        'useminPrepare',
+        'htmlmin',
+        'requirejs',
+        'concat',
+        /*'cssmin',*/
+        /*'uglify',*/
+        'copy',
+        'usemin',
+        'build-config'
+    ]);
+
     // Default task.
     grunt.registerTask('default', ['test']);
 };
diff --git a/package.json b/package.json
@@ -23,6 +23,18 @@
         "grunt-contrib-watch": "0.3.1",
         "grunt-contrib-jasmine": "0.4.2",
         "grunt-template-jasmine-requirejs": "0.1.0",
+        "grunt-contrib-cssmin": "0.6.0",
+        "grunt-contrib-clean": "0.4.1",
+        "grunt-contrib-copy": "0.4.1",
+        "grunt-contrib-htmlmin": "0.1.3",
+        "grunt-contrib-less": "0.8.2",
+        "grunt-contrib-requirejs": "0.4.1",
+        "grunt-contrib-uglify": "0.2.0",
+        "grunt-contrib-concat": "0.3.0",
+        "grunt-contrib-watch": "0.4.3",
+        "grunt-targethtml": "0.2.6",
+        "grunt-usemin": "0.1.11",
+        "load-grunt-tasks": "0.2.0",
         "q": "0.9.2",
         "jshint": "2.1.4"
     },

diff --git a/src/brackets.js b/src/brackets.js
@@ -383,6 +383,5 @@ define(function (require, exports, module) {
     // Dispatch htmlReady event
     _beforeHTMLReady();
     AppInit._dispatchReady(AppInit.HTML_READY);
-
     $(window.document).ready(_onReady);
 });
diff --git a/src/config.json b/src/config.json
@@ -38,9 +38,20 @@
         "phantomjs": "1.9.0-1",
         "grunt-lib-phantomjs": "0.3.0",
         "grunt-contrib-jshint": "0.6.0",
-        "grunt-contrib-watch": "0.3.1",
+        "grunt-contrib-watch": "0.4.3",
         "grunt-contrib-jasmine": "0.4.2",
         "grunt-template-jasmine-requirejs": "0.1.0",
+        "grunt-contrib-cssmin": "0.6.0",
+        "grunt-contrib-clean": "0.4.1",
+        "grunt-contrib-copy": "0.4.1",
+        "grunt-contrib-htmlmin": "0.1.3",
+        "grunt-contrib-less": "0.8.2",
+        "grunt-contrib-requirejs": "0.4.1",
+        "grunt-contrib-uglify": "0.2.0",
+        "grunt-contrib-concat": "0.3.0",
+        "grunt-targethtml": "0.2.6",
+        "grunt-usemin": "0.1.11",
+        "load-grunt-tasks": "0.2.0",
         "q": "0.9.2",
         "jshint": "2.1.4"
     },

diff --git a/src/index.html b/src/index.html
@@ -32,18 +32,22 @@
     <!-- NOTE: All scripts must be external for Chrome App support: http://developer.chrome.com/apps/app_csp.html -->
 
     <!-- Warn about failed cross origin requests in Chrome -->
-    <script type="application/javascript" src="xorigin.js">
-    </script>
-
-    <!-- TODO (Issue #278): switch between runtime LESS compilation in dev mode and precompiled version -->
-    <link rel="stylesheet/less" href="styles/brackets.less">
-    <script src="thirdparty/less-1.4.2.min.js"></script>
-    <script src="thirdparty/mustache/mustache.js"></script>
-    <!-- <link rel="stylesheet" href="brackets.min.css"> -->
+    <script type="application/javascript" src="xorigin.js"></script>
 
+    <link rel="stylesheet" type="text/css" href="thirdparty/CodeMirror2/lib/codemirror.css">
+    <!--(if target dev)><!-->
+    <link rel="stylesheet" type="text/less" href="styles/brackets.less">
+    <!--<!(endif)-->
+    <!--(if target dist)>
+    <link rel="stylesheet" type="text/css" href="styles/brackets.min.css">
+    <!--<!(endif)-->
+
     <!-- JavaScript -->
 
     <!-- Pre-load third party scripts that cannot be async loaded. -->
+    <!-- build:js thirdparty/thirdparty.min.js -->
+    <script src="thirdparty/less-1.4.2.min.js"></script>
+    <script src="thirdparty/mustache/mustache.js"></script>
     <script src="thirdparty/jquery-2.0.1.min.js"></script>
     <script src="thirdparty/CodeMirror2/lib/codemirror.js"></script>
     <script src="thirdparty/CodeMirror2/addon/fold/xml-fold.js"></script>
@@ -59,6 +63,7 @@
 
     <!-- JS for CodeMirror search support -->
     <script src="thirdparty/CodeMirror2/addon/search/searchcursor.js"></script>
+    <!-- endbuild -->
 
 </head>
 <body>
@@ -70,7 +75,9 @@
     -->
 
     <!-- All other scripts are loaded through require. -->
+    <!-- build:js main.js -->
     <script src="thirdparty/requirejs/require.js" data-main="main"></script>
+    <!-- endbuild -->
 
     <!-- Verify that all dependencies are loaded. -->
     <script src="dependencies.js"></script>

diff --git a/src/main.js b/src/main.js
@@ -37,11 +37,16 @@ require.config({
         // The file system implementation. Change this value to use different 
         // implementations (e.g. cloud-based storage).
         "fileSystemImpl"    : "filesystem/impls/appshell/AppshellFileSystem"
-    },
-    // Use custom brackets property until CEF sets the correct navigator.language
-    // NOTE: When we change to navigator.language here, we also should change to
-    // navigator.language in ExtensionLoader (when making require contexts for each
-    // extension).
+    }
+});
+
+// hack for r.js optimization, move locale to another config call
+
+// Use custom brackets property until CEF sets the correct navigator.language
+// NOTE: When we change to navigator.language here, we also should change to
+// navigator.language in ExtensionLoader (when making require contexts for each
+// extension).
+require.config({
     locale: window.localStorage.getItem("locale") || (typeof (brackets) !== "undefined" ? brackets.app.language : navigator.language)
 });
 
@@ -51,4 +56,3 @@ define(function (require, exports, module) {
     // Load the brackets module. This is a self-running module that loads and runs the entire application.
     require("brackets");
 });
-
diff --git a/src/styles/brackets_shared.less b/src/styles/brackets_shared.less
@@ -31,12 +31,6 @@
  * processing order.
  */
 
-/* CSS imports */
-
-// CodeMirror
-// Must wrap in quotes to avoid issue #1015 (true for all relative URLs to non-LESS files)
-@import "../thirdparty/CodeMirror2/lib/codemirror.css";
-
 /* LESS imports */
 
 // Bootstrap @ v.2.3.1

diff --git a/src/utils/ExtensionLoader.js b/src/utils/ExtensionLoader.js
@@ -69,7 +69,11 @@ define(function (require, exports, module) {
      * C:\Users\<user>\AppData\Roaming\Brackets\extensions\user on windows.
      */
     function getUserExtensionPath() {
-        return brackets.app.getApplicationSupportDirectory() + "/extensions/user";
+        if (brackets.app.getApplicationSupportDirectory) {
+            return brackets.app.getApplicationSupportDirectory() + "/extensions/user";
+        }
+
+        return null;
     }
 
     /**

diff --git a/src/utils/ShellAPI.js b/src/utils/ShellAPI.js
@@ -56,7 +56,9 @@ define(function (require, exports, module) {
             // which we have to return true (issue #3152).
             return (eventName === Commands.FILE_CLOSE_WINDOW);
         }
-        var promise, e = new Error(), stackDepth = e.stack.split("\n").length;
+
+        // Use E for Error so that uglify doesn't change this to simply Error()
+        var promise, E = Error, e = new E(), stackDepth = e.stack.split("\n").length;
 
         // This function should *only* be called as a top-level function. If the current
         // stack depth is > 2, it is most likely because we are at a breakpoint.