github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-01-22 13:28:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add grunt tasks to generate and lint docs

Browse Source 
Closes #604
This commit is contained in:
Kevin Sawicki
2013-06-26 19:25:50 -07:00
parent e67676b01c
commit dc6e624eda
2 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Gruntfile.coffee
View File

@@ -210,6 +210,7 @@ module.exports = (grunt) ->
nof = require.resolve('.bin/nof')
spawn({cmd: nof, args: ['spec', 'src']}, @async())
grunt.loadTasks('tasks')
grunt.registerTask('compile', ['coffee', 'less', 'cson'])
grunt.registerTask('lint', ['coffeelint', 'csslint', 'lesslint'])
grunt.registerTask('ci', ['lint', 'partial-clean', 'update-atom-shell', 'build', 'test'])

22
tasks/docs.coffee Normal file
View File

@@ -0,0 +1,22 @@
path = require 'path'
module.exports = (grunt) ->
cmd = path.join('node_modules', '.bin', 'coffee')
commonArgs = [path.join('node_modules', '.bin', 'biscotto'), '--']
opts =
stdio: 'inherit'
grunt.registerTask 'build-docs', 'Builds the API docs in src/app', ->
done = @async()
args = [commonArgs..., '-o', 'docs/api', 'src/app/']
grunt.util.spawn({cmd, args, opts}, done)
grunt.registerTask 'lint-docs', 'Generate stats about the doc coverage', ->
done = @async()
args = [commonArgs..., '--statsOnly', 'src/app/']
grunt.util.spawn({cmd, args, opts}, done)
grunt.registerTask 'missing-docs', 'Generate stats about the doc coverage', ->
done = @async()
args = [commonArgs..., '--listMissing', 'src/app/']
grunt.util.spawn({cmd, args, opts}, done)