-
-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Goals: * Use the new 0.17.0 Yeoman Generator * Better testing overall * Support customizing almost everything in the Karma config * Installs requested Karma plugins (and required ones not specified) * Writes Gruntfile config block and task Notes: * Doesn't support CoffeeScript Gruntfiles BREAKING CHANGES: * No longer adds Angular specific libraries * Default plugins, files have changed Closes #44
- Loading branch information
1 parent
7f3175b
commit ceb21c5
Showing
14 changed files
with
605 additions
and
350 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,23 @@ | ||
{ | ||
"node": true, | ||
"es5": true, | ||
"esnext": true, | ||
"bitwise": false, | ||
"curly": false, | ||
"bitwise": true, | ||
"camelcase": true, | ||
"curly": true, | ||
"eqeqeq": true, | ||
"eqnull": true, | ||
"es5": true, | ||
"esnext": true, | ||
"immed": true, | ||
"indent": 2, | ||
"latedef": true, | ||
"newcap": true, | ||
"noarg": true, | ||
"undef": true, | ||
"strict": false, | ||
"node": true, | ||
"quotmark": "single", | ||
"regexp": true, | ||
"smarttabs": true, | ||
"strict": true, | ||
"trailing": true, | ||
"smarttabs": true | ||
"undef": true, | ||
"unused": true, | ||
"white": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,255 @@ | ||
'use strict'; | ||
|
||
var yeoman = require('yeoman-generator'); | ||
var path = require('path'); | ||
var fs = require('fs'); | ||
|
||
module.exports = yeoman.generators.Base.extend({ | ||
init: function () { | ||
var notEmpty = function(str) { | ||
return str.split(',').filter(function(check) { | ||
return check && check !== ''; | ||
}); | ||
}; | ||
|
||
this.pkg = require('../package.json'); | ||
|
||
this.option('coffee', { | ||
type: Boolean, | ||
desc: 'Use CoffeeScript instead of JavaScript', | ||
defaults: false | ||
}); | ||
this.options.format = this.options.coffee ? 'coffee' : 'js'; | ||
|
||
this.option('base-path', { | ||
type: String, | ||
desc: 'Will be used to resolve files and exclude', | ||
defaults: '' | ||
}); | ||
|
||
this.option('web-port', { | ||
type: Number, | ||
desc: 'Web server port to run Karma from', | ||
defaults: 8080 | ||
}); | ||
|
||
this.option('test-framework', { | ||
type: String, | ||
desc: 'Specifies which testing framework to use', | ||
defaults: 'jasmine' | ||
}); | ||
this.options['test-framework'] = this.options['test-framework'].toLowerCase(); | ||
|
||
this.option('browsers', { | ||
type: String, | ||
desc: 'What browsers to test in (comma separated)', | ||
defaults: 'PhantomJS' | ||
}); | ||
this.options.browsers = notEmpty(this.options.browsers); | ||
|
||
this.option('app-files', { | ||
type: String, | ||
desc: 'List of application files (comma separated)', | ||
defaults: '' | ||
}); | ||
this.options['app-files'] = notEmpty(this.options['app-files']); | ||
|
||
this.option('bower-components', { | ||
type: String, | ||
desc: 'Optional components to use for testing (comma separated of components)', | ||
defaults: '' | ||
}); | ||
this.options['bower-components'] = notEmpty(this.options['bower-components']); | ||
|
||
this.option('bower-components-path', { | ||
type: String, | ||
desc: 'Directory where Bower components are installed', | ||
defaults: 'bower_components' | ||
}); | ||
|
||
this.option('test-files', { | ||
type: String, | ||
desc: 'List of test files (comma separated)', | ||
defaults: '' | ||
}); | ||
this.options['test-files'] = notEmpty(this.options['test-files']); | ||
|
||
this.option('exclude-files', { | ||
type: String, | ||
desc: 'List of files to exclude (comma separated)', | ||
defaults: '' | ||
}); | ||
this.options['exclude-files'] = notEmpty(this.options['exclude-files']); | ||
|
||
var files = this.options['bower-components'].map(function(component) { | ||
return this.options['bower-components-path'] + ( | ||
this.options['bower-components-path'].slice(-1) === '/' ? '' : '/' | ||
) + component; | ||
}.bind(this)); | ||
|
||
this.configFiles = [].concat( | ||
files, | ||
this.options['app-files'], | ||
this.options['test-files'] | ||
); | ||
|
||
this.option('plugins', { | ||
type: String, | ||
desc: 'Specify Karma plugins (npm modules)', | ||
defaults: '' | ||
}); | ||
this.options.plugins = this.options.plugins ? this.options.plugins.split(',') : []; | ||
|
||
// Add browsers to the plugins list | ||
if (this.options.browsers.length) { | ||
this.options.browsers.forEach(function(browser) { | ||
this.options.plugins.push('karma-' + browser.toLowerCase() + '-launcher'); | ||
}.bind(this)); | ||
} | ||
|
||
// Add test-framework to the plugins list | ||
if (this.options['test-framework']) { | ||
this.options.plugins.push('karma-' + this.options['test-framework']); | ||
} | ||
|
||
this.option('travis', { | ||
type: Boolean, | ||
desc: 'Adds a .travis.yaml file', | ||
defaults: false | ||
}); | ||
|
||
this.option('template-path', { | ||
type: String, | ||
desc: 'Path where the config files should be read from', | ||
hide: true, | ||
defaults: '../templates' | ||
}); | ||
this.option('config-path', { | ||
type: String, | ||
desc: 'Path where the config files should be written to', | ||
hide: true, | ||
defaults: './test' | ||
}); | ||
|
||
this.option('config-file', { | ||
type: String, | ||
desc: 'The config file to populate', | ||
hide: true, | ||
defaults: '' | ||
}); | ||
|
||
this.option('gruntfile-path', { | ||
type: String, | ||
desc: 'Path to a Gruntfile to edit', | ||
defaults: '' | ||
}); | ||
|
||
if (!this.options['config-file']) { | ||
this.options['config-file'] = 'karma.conf.' + this.options.format; | ||
} | ||
}, | ||
|
||
makeConfig: function () { | ||
this.sourceRoot(path.join(__dirname, this.options['template-path'])); | ||
|
||
this.templateArray = function(list, coffee) { | ||
var str = []; | ||
list.forEach(function(item, index) { | ||
str.push('\n \'' + item + '\''); | ||
if (index + 1 === list.length) { | ||
str.push('\n '); | ||
} else { | ||
if (!coffee) { | ||
str.push(','); | ||
} | ||
} | ||
}); | ||
return str.join(''); | ||
}; | ||
|
||
this.template( | ||
this.options['config-file'], | ||
path.join(this.options['config-path'], this.options['config-file']) | ||
); | ||
}, | ||
|
||
writeGruntFile: function () { | ||
if (!this.options['gruntfile-path']) { | ||
return; | ||
} | ||
|
||
this.gruntfile.insertConfig( | ||
'karma', | ||
JSON.stringify({ | ||
unit: { | ||
options: { | ||
'autoWatch': false, | ||
'browsers': this.options.browsers, | ||
'config-file': [ | ||
this.options['config-path'], | ||
'/', | ||
this.options['config-file'] | ||
].join(''), | ||
'singleRun': true | ||
} | ||
} | ||
}) | ||
); | ||
this.gruntfile.registerTask('test', ['karma']); | ||
}, | ||
|
||
setupTravis: function () { | ||
if (!this.options.travis) { | ||
return; | ||
} | ||
|
||
this.copy('travis.yml', '.travis.yml'); | ||
|
||
var done = this.async(); | ||
var packageJson = path.join( | ||
this.options.cwd || process.cwd(), | ||
'package.json' | ||
); | ||
|
||
fs.readFile(packageJson, { encoding: 'utf-8' }, function (err, content) { | ||
var data; | ||
if (err) { | ||
this.log.error('Could not open package.json for reading.', err); | ||
done(); | ||
return; | ||
} | ||
|
||
try { | ||
data = JSON.parse(content); | ||
} catch (err) { | ||
this.log.error('Could not parse package.json.', err); | ||
done(); | ||
return; | ||
} | ||
|
||
if (data.scripts && data.scripts.test) { | ||
this.log.writeln( | ||
'Test script already present in package.json. Skipping rewriting.' | ||
); | ||
done(); | ||
return; | ||
} | ||
|
||
data.scripts = data.scripts || {}; | ||
data.scripts.test = 'grunt test'; | ||
|
||
fs.writeFile(packageJson, JSON.stringify(data, null, 2), done); | ||
}.bind(this)); | ||
}, | ||
|
||
installDeps: function () { | ||
if (!this.options['skip-install']) { | ||
this.on('end', function () { | ||
this.options.plugins.push('grunt-karma'); | ||
this.npmInstall(this.options.plugins, { | ||
saveDev: true | ||
}); | ||
}); | ||
} | ||
} | ||
}); |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.