File tree Expand file tree Collapse file tree 5 files changed +45
-1
lines changed Expand file tree Collapse file tree 5 files changed +45
-1
lines changed Original file line number Diff line number Diff line change
1
+ language : node_js
2
+ node_js :
3
+ - ' 0.10'
4
+ - ' 0.8'
Original file line number Diff line number Diff line change 1
1
# gulp-documentation
2
2
3
+ [ ![ build status] ( https://secure.travis-ci.org/documentationjs/gulp-documentation.png )] ( http://travis-ci.org/documentationjs/gulp-documentation )
4
+
3
5
Use [ gulp] ( http://gulpjs.com/ ) with
4
6
[ documentation] ( https://github.com/documentationjs/documentation )
5
7
to generate great documentation for your JavaScript projects.
Original file line number Diff line number Diff line change 11
11
},
12
12
"devDependencies" : {
13
13
"gulp" : " ^3.8.11" ,
14
+ "prova" : " ^2.1.1" ,
14
15
"tape" : " ^3.5.0"
15
16
},
16
17
"keywords" : [
17
18
" documentation" ,
18
19
" gulp" ,
20
+ " gulpplugin" ,
19
21
" jsdoc"
20
22
],
21
23
"license" : " ISC" ,
25
27
"url" :
" [email protected] :documentationjs/gulp-documentation.git"
26
28
},
27
29
"scripts" : {
28
- "test" : " tape test.js"
30
+ "test" : " prova test/ test.js"
29
31
}
30
32
}
Original file line number Diff line number Diff line change
1
+ /**
2
+ * This plugin does foo
3
+ * @name foo
4
+ */
5
+ function foo ( ) {
6
+ return 1 ;
7
+ }
8
+
9
+ foo ( ) ;
Original file line number Diff line number Diff line change
1
+ var test = require ( 'prova' ) ,
2
+ path = require ( 'path' ) ,
3
+ gulp = require ( 'gulp' ) ,
4
+ documentation = require ( '../' ) ;
5
+
6
+ test ( 'gulp-documentation' , function ( t ) {
7
+ t . ok ( documentation ( ) ) ;
8
+ t . end ( ) ;
9
+ } ) ;
10
+
11
+ test ( 'gulp-documentation md' , function ( t ) {
12
+ gulp . src ( path . join ( __dirname , '/fixture.js' ) )
13
+ . pipe ( documentation ( { format : 'md' } ) )
14
+ . on ( 'data' , function ( d ) {
15
+ t . equal ( d . path , 'API.md' ) ;
16
+ t . end ( ) ;
17
+ } ) ;
18
+ } ) ;
19
+
20
+ test ( 'gulp-documentation md custom name' , function ( t ) {
21
+ gulp . src ( path . join ( __dirname , '/fixture.js' ) )
22
+ . pipe ( documentation ( { format : 'md' , filename : 'foo.md' } ) )
23
+ . on ( 'data' , function ( d ) {
24
+ t . equal ( d . path , 'foo.md' ) ;
25
+ t . end ( ) ;
26
+ } ) ;
27
+ } ) ;
You can’t perform that action at this time.
0 commit comments