feat(docs): add SassDoc option

Closes #13

Author: meriadec

app/index.js

@@ -74,6 +74,15 @@ var BangularGenerator = yeoman.generators.Base.extend({
         value: 'browsersync',
         name: 'BrowserSync'
       }]
+    }, {
+      type: 'checkbox',
+      name: 'docs',
+      message: 'Do you want to add some documentation generators?',
+      choices: [{
+        value: 'sassdoc',
+        name: 'SassDoc',
+        checked: false
+      }]
     }, {
       type: 'checkbox',
       name: 'tests',
@@ -127,6 +136,14 @@ var BangularGenerator = yeoman.generators.Base.extend({
         });
       }
 
+      if (props.docs && props.docs.length) {
+        props.docs.forEach(function (doc) {
+          self.filters[doc] = true;
+        });
+      }
+
+      self.filters.hasDocs = !!self.filters.sassdoc;
+
       if (props.tests && props.tests.length) {
         props.tests.forEach(function (test) {
           self.filters[test] = true;

app/templates/_.gitignore

@@ -4,4 +4,5 @@ client/styles/css
 .idea/
 dist/
 .sass-cache/
-.bangular-refresh
+.bangular-refresh<% if (filters.hasDocs) { %>
+docs/<% } %>

app/templates/gulpfile.js

@@ -17,4 +17,5 @@ gulp.task('version',                  require('./tasks/chore').version);<% if (f
 gulp.task('control',                  require('./tasks/control'));<% } if (filters.e2e) { %>
 gulp.task('e2e:update',               require('./tasks/test').e2eUpdate);
 gulp.task('e2e',        ['serve'],    require('./tasks/test').e2eTests);<% } if (filters.karma || filters.mocha) { %>
-gulp.task('test',                     require('./tasks/test').test);<% } %>
+gulp.task('test',                     require('./tasks/test').test);<% } if (filters.sassdoc) { %>
+gulp.task('sassdoc',                  require('./tasks/doc').sassdoc);<% } %>

app/templates/package.json

@@ -37,7 +37,8 @@
     "karma-ng-html2js-preprocessor": "^0.1.2",
     "karma-phantomjs-launcher": "^0.1.4",<% } %>
     "main-bower-files": "^2.5.0",
-    "run-sequence": "^1.0.2",<% if (filters.mocha) { %>
+    "run-sequence": "^1.0.2",<% if (filters.sassdoc) { %>
+    "sassdoc": "^2.1.8",<% } if (filters.mocha) { %>
     "should": "^5.1.0",<% } %>
     "streamqueue": "^0.1.2"<% if (filters.karma) { %>,
     "supertest": "^0.15.0"<% } %>

app/templates/tasks/doc.js(hasDocs)

@@ -0,0 +1,15 @@
+'use strict';
+
+/**
+ * Documentation tasks
+ */
+
+var gulp    = require('gulp');<% if (filters.sassdoc) { %>
+var sassdoc = require('sassdoc');<% } %><% if (filters.sassdoc) { %>
+
+exports.sassdoc = function () {
+  gulp.src('client/styles/**/*.scss')
+    .pipe(sassdoc({
+      dest: 'docs/sass'
+    }));
+};<% } %>

test/app.js

@@ -358,6 +358,35 @@ describe('Launching app generator tests', function () {
 
   describe('', function () {
 
+    before(function (done) {
+
+      utils.scaffold({
+        name: 'Test',
+        backend: 'json',
+        reload: 'livereload',
+        modules: [],
+        docs: ['sassdoc']
+      }, done);
+
+    });
+
+    it('should create all the files', basicFileCheck);
+
+    it('should check sassdoc dependency', function () {
+      assert.fileContent('package.json', 'sassdoc');
+    });
+
+    it('should check sassdoc task is present', function () {
+      assert.file('tasks/doc.js');
+      assert.fileContent('tasks/doc.js', 'exports.sassdoc = function () {');
+      assert.fileContent('gulpfile.js', 'gulp.task(\'sassdoc\', ');
+      assert.fileContent('.gitignore', 'docs/');
+    });
+
+  });
+
+  /*describe('', function () {
+
     before(function (done) {
 
       this.timeout(240000);
@@ -443,6 +472,6 @@ describe('Launching app generator tests', function () {
       });
     });
 
-  });
+  });*/
 
 });