// # Task automation for Ghost // // Run various tasks when developing for and working with Ghost. // // **Usage instructions:** can be found in the [Custom Tasks](#custom%20tasks) section or by running `grunt --help`. // // **Debug tip:** If you have any problems with any Grunt tasks, try running them with the `--verbose` command // jshint unused: false var overrides = require('./core/server/overrides'), _ = require('lodash'), chalk = require('chalk'), fs = require('fs-extra'), path = require('path'), Promise = require('bluebird'), Git = require('git-wrapper'), escapeChar = process.platform.match(/^win/) ? '^' : '\\', cwd = process.cwd().replace(/( |\(|\))/g, escapeChar + '$1'), buildDirectory = path.resolve(cwd, '.build'), distDirectory = path.resolve(cwd, '.dist'), // ## Grunt configuration configureGrunt = function (grunt) { // #### Load all grunt tasks // // Find all of the task which start with `grunt-` and load them, rather than explicitly declaring them all require('matchdep').filterDev(['grunt-*', '!grunt-cli']).forEach(grunt.loadNpmTasks); var cfg = { // #### Common paths used by tasks paths: { build: buildDirectory, releaseBuild: path.join(buildDirectory, 'release'), dist: distDirectory, releaseDist: path.join(distDirectory, 'release') }, // Standard build type, for when we have nightlies again. buildType: 'Build', // Load package.json so that we can create correctly versioned releases. pkg: grunt.file.readJSON('package.json'), clientFiles: [ 'server/views/default.hbs', 'built/assets/ghost.js', 'built/assets/ghost.css', 'built/assets/vendor.js', 'built/assets/vendor.css' ], // ### grunt-contrib-watch // Watch files and livereload in the browser during development. // See the [grunt dev](#live%20reload) task for how this is used. watch: { livereload: { files: [ 'content/themes/casper/assets/css/*.css', 'content/themes/casper/assets/js/*.js', 'core/built/assets/*.js', 'core/client/dist/index.html' ], options: { livereload: true } }, express: { files: ['core/ghost-server.js', 'core/server/**/*.js'], tasks: ['express:dev'], options: { spawn: false } } }, // ### grunt-express-server // Start a Ghost expess server for use in development and testing express: { options: { script: 'index.js', output: 'Ghost is running' }, dev: { options: {} }, test: { options: { node_env: 'testing' } } }, // ### grunt-contrib-jshint // Linting rules, run as part of `grunt validate`. See [grunt validate](#validate) and its subtasks for // more information. jshint: { options: { jshintrc: '.jshintrc' }, server: [ '*.js', '!config*.js', // note: i added this, do we want this linted? 'core/*.js', 'core/server/**/*.js', 'core/test/**/*.js', '!core/test/coverage/**', '!core/shared/vendor/**/*.js' ] }, jscs: { options: { config: true }, server: { files: { src: [ '*.js', '!config*.js', // note: i added this, do we want this linted? 'core/*.js', 'core/server/**/*.js', 'core/test/**/*.js', '!core/test/coverage/**', '!core/shared/vendor/**/*.js' ] } } }, // ### grunt-mocha-cli // Configuration for the mocha test runner, used to run unit, integration and route tests as part of // `grunt validate`. See [grunt validate](#validate) and its sub tasks for more information. mochacli: { options: { ui: 'bdd', reporter: grunt.option('reporter') || 'spec', timeout: '30000', save: grunt.option('reporter-output'), require: ['core/server/overrides'] }, // #### All Unit tests unit: { src: [ 'core/test/unit/**/*_spec.js', 'core/server/apps/**/tests/*_spec.js' ] }, // #### All Integration tests integration: { src: [ 'core/test/integration/**/*_spec.js', 'core/test/integration/*_spec.js' ] }, // #### All Route tests routes: { src: [ 'core/test/functional/routes/**/*_spec.js' ] }, // #### All Module tests module: { src: [ 'core/test/functional/module/**/*_spec.js' ] }, // #### Run single test (src is set dynamically, see grunt task 'test') single: {} }, // ### grunt-mocha-istanbul // Configuration for the mocha test coverage generator // `grunt coverage`. mocha_istanbul: { coverage: { // they can also have coverage generated for them & the order doesn't matter src: [ 'core/test/unit', 'core/server/apps' ], options: { mask: '**/*_spec.js', coverageFolder: 'core/test/coverage/unit', mochaOptions: ['--timeout=15000', '--require', 'core/server/overrides'], excludes: ['core/client', 'core/server/built'] } }, coverage_all: { src: [ 'core/test/integration', 'core/server/apps', 'core/test/functional', 'core/test/unit' ], options: { coverageFolder: 'core/test/coverage/all', mask: '**/*_spec.js', mochaOptions: ['--timeout=15000', '--require', 'core/server/overrides'], excludes: ['core/client', 'core/server/built'] } } }, bgShell: { client: { cmd: 'grunt subgrunt:watch', bg: true } }, // ### grunt-shell // Command line tools where it's easier to run a command directly than configure a grunt plugin shell: { shrinkwrap: { command: 'npm shrinkwrap' }, prune: { command: 'npm prune' }, dedupe: { command: 'npm dedupe' } }, // ### grunt-docker // Generate documentation from code docker: { docs: { dest: 'docs', src: ['.'], options: { onlyUpdated: true, exclude: 'node_modules,bower_components,content,core/client,*test,*doc*,' + '*vendor,config.js,*buil*,.dist*,.idea,.git*,.travis.yml,.bower*,.editorconfig,.js*,*.md', extras: ['fileSearch'] } } }, // ### grunt-contrib-clean // Clean up files as part of other tasks clean: { built: { src: [ 'core/built/**', 'core/client/dist/**', 'core/client/public/assets/img/contributors/**', 'core/client/app/templates/-contributors.hbs' ] }, release: { src: ['<%= paths.releaseBuild %>/**'] }, test: { src: ['content/data/ghost-test.db'] }, tmp: { src: ['.tmp/**'] }, dependencies: { src: ['node_modules/**', 'core/client/bower_components/**', 'core/client/node_modules/**'] } }, // ### grunt-contrib-compress // Zip up files for builds / releases compress: { release: { options: { archive: '<%= paths.releaseDist %>/Ghost-<%= pkg.version %>.zip' }, expand: true, cwd: '<%= paths.releaseBuild %>/', src: ['**'] } }, // ### grunt-update-submodules // Grunt task to update git submodules update_submodules: { default: { options: { params: '--init' } } }, uglify: { prod: { options: { sourceMap: false }, files: { 'core/shared/ghost-url.min.js': 'core/shared/ghost-url.js' } } }, // ### grunt-subgrunt // Run grunt tasks in submodule Gruntfiles subgrunt: { options: { npmInstall: false }, init: { options: { npmInstall: true }, projects: { 'core/client': 'init' } }, dev: { 'core/client': 'shell:ember:dev' }, prod: { 'core/client': 'shell:ember:prod' }, watch: { 'core/client': ['bgShell:ember', 'watch'] }, lint: { 'core/client': 'lint' }, test: { 'core/client': 'shell:test' } } }; // Load the configuration grunt.initConfig(cfg); // # Custom Tasks // Ghost has a number of useful tasks that we use every day in development. Tasks marked as *Utility* are used // by grunt to perform current actions, but isn't useful to developers. // // Skip ahead to the section on: // // * [Building assets](#building%20assets): // `grunt init`, `grunt` & `grunt prod` or live reload with `grunt dev` // * [Testing](#testing): // `grunt validate`, the `grunt test-*` sub-tasks or generate a coverage report with `grunt coverage`. // ### Help // Run `grunt help` on the commandline to get a print out of the available tasks and details of // what each one does along with any available options. This is an alias for `grunt --help` grunt.registerTask('help', 'Outputs help information if you type `grunt help` instead of `grunt --help`', function () { console.log('Type `grunt --help` to get the details of available grunt tasks.'); }); // ### Documentation // Run `grunt docs` to generate annotated source code using the documentation described in the code comments. grunt.registerTask('docs', 'Generate Docs', ['docker']); // Runun `grunt watch-docs` to setup livereload & watch whilst you're editing the docs grunt.registerTask('watch-docs', function () { grunt.config.merge({ watch: { docs: { files: ['core/server/**/*', 'index.js', 'Gruntfile.js', 'config.example.js'], tasks: ['docker'], options: { livereload: true } } } }); grunt.task.run('watch:docs'); }); // ## Testing // Ghost has an extensive set of test suites. The following section documents the various types of tests // and how to run them. // // TLDR; run `grunt validate` // #### Set Test Env *(Utility Task)* // Set the NODE_ENV to 'testing' unless the environment is already set to TRAVIS. // This ensures that the tests get run under the correct environment, using the correct database, and // that they work as expected. Trying to run tests with no ENV set will throw an error to do with `client`. grunt.registerTask('setTestEnv', 'Use "testing" Ghost config; unless we are running on travis (then show queries for debugging)', function () { process.env.NODE_ENV = process.env.TRAVIS ? process.env.NODE_ENV : 'testing'; cfg.express.test.options.node_env = process.env.NODE_ENV; }); // #### Reset Database to "New" state *(Utility Task)* // Drops all database tables and then runs the migration process to put the database // in a "new" state. grunt.registerTask('cleanDatabase', function () { var done = this.async(), models = require('./core/server/models'), migration = require('./core/server/data/migration'); migration.reset().then(function () { models.init(); return migration.init(); }).then(function () { done(); }).catch(function (err) { grunt.fail.fatal(err.stack); }); }); // ### Test // **Testing utility** // // `grunt test:unit/apps_spec.js` will run just the tests inside the apps_spec.js file // // It works for any path relative to the core/test folder. It will also run all the tests in a single directory // You can also run a test with grunt test:core/test/unit/... to get bash autocompletion // // `grunt test:integration/api` - runs the api integration tests // `grunt test:integration` - runs the integration tests in the root folder and excludes all api & model tests grunt.registerTask('test', 'Run a particular spec file from the core/test directory e.g. `grunt test:unit/apps_spec.js`', function (test) { if (!test) { grunt.fail.fatal('No test provided. `grunt test` expects a filename. e.g.: `grunt test:unit/apps_spec.js`. Did you mean `npm test` or `grunt validate`?'); } if (!test.match(/core\/test/)) { test = 'core/test/' + test; } // CASE: execute folder if (!test.match(/.js/)) { test += '/**'; } else if (!fs.existsSync(test)) { grunt.fail.fatal('This file does not exist!'); } cfg.mochacli.single.src = [test]; grunt.initConfig(cfg); grunt.task.run('test-setup', 'mochacli:single'); }); // #### Stub out ghost files *(Utility Task)* // Creates stub files in the built directory and the views directory // so that the test environments do not need to build out the client files grunt.registerTask('stubClientFiles', function () { _.each(cfg.clientFiles, function (file) { var filePath = path.resolve(cwd + '/core/' + file); fs.ensureFileSync(filePath); }); }); // ### Validate // **Main testing task** // // `grunt validate` will build, lint and test your local Ghost codebase. // // `grunt validate` is one of the most important and useful grunt tasks that we have available to use. It // manages the build of your environment and then calls `grunt test` // // `grunt validate` is called by `npm test` and is used by Travis. grunt.registerTask('validate', 'Run tests and lint code', function () { if (process.env.TEST_SUITE === 'server') { grunt.task.run(['stubClientFiles', 'test-server']); } else if (process.env.TEST_SUITE === 'lint') { grunt.task.run(['lint']); } else { grunt.task.run(['validate-all']); } }); grunt.registerTask('validate-all', 'Lint code and run all tests', ['init', 'lint', 'test-all']); // ### Test-All // **Main testing task** // // `grunt test-all` will lint and test your pre-built local Ghost codebase. // // `grunt test-all` runs all 6 test suites. See the individual sub tasks below for // details of each of the test suites. // grunt.registerTask('test-all', 'Run tests for both server and client', ['test-server', 'test-client']); grunt.registerTask('test-server', 'Run server tests', ['test-routes', 'test-module', 'test-unit', 'test-integration']); grunt.registerTask('test-client', 'Run client tests', ['subgrunt:test']); // ### Lint // // `grunt lint` will run the linter and the code style checker so you can make sure your code is pretty grunt.registerTask('lint', 'Run the code style checks and linter for server', ['jshint', 'jscs'] ); grunt.registerTask('lint-all', 'Run the code style checks and linter for server and client', ['lint', 'subgrunt:lint'] ); // ### test-setup *(utility)( // `grunt test-setup` will run all the setup tasks required for running tests grunt.registerTask('test-setup', 'Setup ready to run tests', ['clean:test', 'setTestEnv'] ); // ### Unit Tests *(sub task)* // `grunt test-unit` will run just the unit tests // // If you need to run an individual unit test file, you can use the `grunt test:` task: // // `grunt test:unit/config_spec.js` // // This also works for folders (although it isn't recursive), E.g. // // `grunt test:unit/server_helpers` // // Unit tests are run with [mocha](http://mochajs.org/) using // [should](https://github.com/visionmedia/should.js) to describe the tests in a highly readable style. // Unit tests do **not** touch the database. // A coverage report can be generated for these tests using the `grunt test-coverage` task. grunt.registerTask('test-unit', 'Run unit tests (mocha)', ['test-setup', 'mochacli:unit'] ); // ### Integration tests *(sub task)* // `grunt test-integration` will run just the integration tests // // Provided you already have a `config.js` file, you can run just the model integration tests by running: // // `grunt test:integration/model` // // Or just the api integration tests by running: // // `grunt test:integration/api` // // Integration tests are run with [mocha](http://mochajs.org/) using // [should](https://github.com/visionmedia/should.js) to describe the tests in a highly readable style. // Integration tests are different to the unit tests because they make requests to the database. // // If you need to run an individual integration test file you can use the `grunt test:` task: // // `grunt test:integration/api/api_tags_spec.js` // // Their purpose is to test that both the api and models behave as expected when the database layer is involved. // These tests are run against sqlite3, mysql and pg on travis and ensure that differences between the databases // don't cause bugs. At present, pg often fails and is not officially supported. // // A coverage report can be generated for these tests using the `grunt test-coverage` task. grunt.registerTask('test-integration', 'Run integration tests (mocha + db access)', ['test-setup', 'mochacli:integration'] ); // ### Route tests *(sub task)* // `grunt test-routes` will run just the route tests // // If you need to run an individual route test file, you can use the `grunt test:` task: // // `grunt test:functional/routes/admin_spec.js` // // Route tests are run with [mocha](http://mochajs.org/) using // [should](https://github.com/visionmedia/should.js) and [supertest](https://github.com/visionmedia/supertest) // to describe and create the tests. // // Supertest enables us to describe requests that we want to make, and also describe the response we expect to // receive back. It works directly with express, so we don't have to run a server to run the tests. // // The purpose of the route tests is to ensure that all of the routes (pages, and API requests) in Ghost // are working as expected, including checking the headers and status codes received. It is very easy and // quick to test many permutations of routes / urls in the system. grunt.registerTask('test-routes', 'Run functional route tests (mocha)', ['test-setup', 'mochacli:routes'] ); // ### Module tests *(sub task)* // `grunt test-module` will run just the module tests // // The purpose of the module tests is to ensure that Ghost can be used as an npm module and exposes all // required methods to interact with it. grunt.registerTask('test-module', 'Run functional module tests (mocha)', ['test-setup', 'mochacli:module'] ); // ### Coverage // `grunt coverage` will generate a report for the Unit Tests. // // This is not currently done as part of CI or any build, but is a tool we have available to keep an eye on how // well the unit and integration tests are covering the code base. // Ghost does not have a minimum coverage level - we're more interested in ensuring important and useful areas // of the codebase are covered, than that the whole codebase is covered to a particular level. // // Key areas for coverage are: helpers and theme elements, apps / GDK, the api and model layers. grunt.registerTask('coverage', 'Generate unit and integration (mocha) tests coverage report', ['test-setup', 'mocha_istanbul:coverage'] ); grunt.registerTask('coverage-all', 'Generate unit and integration tests coverage report', ['test-setup', 'mocha_istanbul:coverage_all'] ); // #### Master Warning *(Utility Task)* // Warns git users not ot use the `master` branch in production. // `master` is an unstable branch and shouldn't be used in production as you run the risk of ending up with a // database in an unrecoverable state. Instead there is a branch called `stable` which is the equivalent of the // release zip for git users. grunt.registerTask('master-warn', 'Outputs a warning to runners of grunt prod, that master shouldn\'t be used for live blogs', function () { console.log(chalk.red( 'Use the ' + chalk.bold('stable') + ' branch for live blogs. ' + chalk.bold.underline('Never') + ' master!' )); console.log('>', 'Always two there are, no more, no less. A master and a ' + chalk.bold('stable') + '.'); }); // ## Building assets // // Ghost's GitHub repository contains the un-built source code for Ghost. If you're looking for the already // built release zips, you can get these from the [release page](https://github.com/TryGhost/Ghost/releases) on // GitHub or from https://ghost.org/download. These zip files are created using the [grunt release](#release) // task. // // If you want to work on Ghost core, or you want to use the source files from GitHub, then you have to build // the Ghost assets in order to make them work. // // There are a number of grunt tasks available to help with this. Firstly after fetching an updated version of // the Ghost codebase, after running `npm install`, you will need to run [grunt init](#init%20assets). // // For production blogs you will need to run [grunt prod](#production%20assets). // // For updating assets during development, the tasks [grunt](#default%20asset%20build) and // [grunt dev](#live%20reload) are available. // ### Init assets // `grunt init` - will run an initial asset build for you // // Grunt init runs `npm install && bower install` inside `core/client` as well as the standard asset build // tasks which occur when you run just `grunt`. This fetches the latest client-side dependencies. // // This task is very important, and should always be run when fetching down an updated code base just after // running `npm install`. // // `bower` does have some quirks, such as not running as root. If you have problems please try running // `grunt init --verbose` to see if there are any errors. grunt.registerTask('init', 'Prepare the project for development', ['update_submodules', 'subgrunt:init', 'clean:tmp', 'default']); // ### Build assets // `grunt build` - will build client assets (without updating the submodule) // // This task is identical to `grunt init`, except it does not build client dependencies grunt.registerTask('build', 'Build client app', ['subgrunt:init', 'clean:tmp', 'default']); // ### Default asset build // `grunt` - default grunt task // // Build assets and dev version of the admin app. grunt.registerTask('default', 'Build JS & templates for development', ['subgrunt:dev']); // ### Production assets // `grunt prod` - will build the minified assets used in production. // // It is otherwise the same as running `grunt`, but is only used when running Ghost in the `production` env. grunt.registerTask('prod', 'Build JS & templates for production', ['subgrunt:prod', 'uglify:prod', 'master-warn']); grunt.registerTask('deps', 'Prepare dependencies', ['shell:dedupe', 'shell:prune', 'shell:shrinkwrap'] ); // ### Live reload // `grunt dev` - build assets on the fly whilst developing // // If you want Ghost to live reload for you whilst you're developing, you can do this by running `grunt dev`. // This works hand-in-hand with the [livereload](http://livereload.com/) chrome extension. // // `grunt dev` manages starting an express server and restarting the server whenever core files change (which // require a server restart for the changes to take effect) and also manage reloading the browser whenever // frontend code changes. // // Note that the current implementation of watch only works with casper, not other themes. grunt.registerTask('dev', 'Dev Mode; watch files and restart server on changes', ['bgShell:client', 'express:dev', 'watch']); // ### Contributors // `grunt contributors:` - generate a comma-separated list of contributors for a Ghost release. // // You must supply a tag name to us // grunt.registerTask('contributors', 'Generate a list of contributors for a release', function () { var getContribList = require('gh-contrib-list'), oauthKey = process.env.GITHUB_OAUTH_KEY, thisGit = new Git(), clientGit = new Git({'git-dir': path.resolve(cwd + '/core/client/.git')}), done = this.async(); function mergeContribs(first, second) { _.each(second, function (contributor) { var contributorInFirst = _.find(first, ['id', contributor.id]); if (contributorInFirst) { contributorInFirst.commitCount += contributor.commitCount; } else { first.push(contributor); } }); return _.orderBy(first, ['commitCount'], ['desc']); } if (!this.args) { grunt.log.error('You must supply a tag name. Please run like this: `grunt contributors:`'); } return Promise.props({ ghost: Promise.promisify(thisGit.exec, {context: thisGit})('rev-list', {n: 1}, this.args), admin: Promise.promisify(clientGit.exec, {context: clientGit})('rev-list', {n: 1}, this.args) }).then(function (props) { return Promise.join( getContribList({ user: 'tryghost', repo: 'ghost', oauthKey: oauthKey, commit: props.ghost.trim(), removeGreenkeeper: true, retry: true }), getContribList({ user: 'tryghost', repo: 'ghost-admin', oauthKey: oauthKey, commit: props.admin.trim(), removeGreenkeeper: true, retry: true }) ); }).then(function (results) { var contributors = mergeContribs(results[0], results[1]); grunt.log.writeln(_.map(contributors, 'name').join(', ')); done(); }).catch(function (error) { grunt.log.error(error); if (error.http_status) { grunt.log.writeln('GitHub API request returned status: ' + error.http_status); } if (error.ratelimit_limit) { grunt.log.writeln('Rate limit data: limit: %d, remaining: %d, reset: %s', error.ratelimit_limit, error.ratelimit_remaining, require('moment').unix(error.ratelimit_reset).fromNow()); } done(false); }); }); // ### Release // Run `grunt release` to create a Ghost release zip file. // Uses the files specified by `.npmignore` to know what should and should not be included. // Runs the asset generation tasks for both development and production so that the release can be used in // either environment, and packages all the files up into a zip. grunt.registerTask('release', 'Release task - creates a final built zip\n' + ' - Do our standard build steps \n' + ' - Copy files to release-folder/#/#{version} directory\n' + ' - Clean out unnecessary files (travis, .git*, etc)\n' + ' - Zip files in release-folder to dist-folder/#{version} directory', function () { grunt.config.set('copy.release', { expand: true, // #### Build File Patterns // A list of files and patterns to include when creating a release zip. // This is read from the `.npmignore` file and all patterns are inverted as the `.npmignore` // file defines what to ignore, whereas we want to define what to include. src: fs.readFileSync('.npmignore', 'utf8').split('\n').filter(Boolean).map(function (pattern) { return pattern[0] === '!' ? pattern.substr(1) : '!' + pattern; }), dest: '<%= paths.releaseBuild %>/' }); grunt.task.run(['init', 'prod', 'clean:release', 'deps', 'copy:release', 'compress:release']); } ); }; module.exports = configureGrunt;