live-guide - npm Package Compare versions

Comparing version 0.11.1 to 0.12.0

lib/build-navigation/index.js

@@ -9,2 +9,4 @@ 'use strict';
 
+  console.log('Generating Navigation...');
+
   styleguideArray.forEach((obj) => {
@@ -11,0 +13,0 @@ let fileName = (obj.writeName || obj.title).replace(/ /g, '_').toLowerCase() + '.html';

lib/copy-assets/index.js

@@ -11,3 +11,3 @@ 'use strict';
     path.resolve(__dirname, '../../node_modules/normalize.css/normalize.css'),
-    path.resolve(__dirname, '../../node_modules/highlight.js/styles/tomorrow-night-eighties.css'),
+    path.resolve(__dirname, '../../node_modules/highlight.js/styles/github.css'),
     path.resolve(__dirname, '../../assets/css/dist/app.css')
@@ -14,0 +14,0 @@ ],

lib/copy-resources/index.js

@@ -26,2 +26,4 @@ 'use strict';
 
+  console.log('Copying Resources...');
+
   allCopies = allCopies.map((r) => {
@@ -28,0 +30,0 @@ return copyPromise.call(options, r);

lib/extract-comments/index.js

@@ -17,6 +17,6 @@ 'use strict';
       return match
-        .replace(/^\/\*|\*\//, '').trim()
-        .replace(/^\*/, '').trim()
-        .replace(/^([\W\w]+)\*\//, '$1').trim()
-        .replace(/^\/\//, '').trim();
+        .replace(/^\/\*|\*\//, '')
+        .replace(/^\*/, '')
+        .replace(/^([\W\w]+)\*\//, '$1')
+        .replace(/^\/\//, '');
       });
@@ -31,5 +31,8 @@
 module.exports = function(sgArray) {
+  console.log('Extracting comments...');
+
   sgArray.forEach((obj) => {
     let _str = obj.rawFile;
 
+
     obj.rawComments = obj.filteredComments = extractComments(_str);
@@ -36,0 +39,0 @@ });

lib/filter-array/lib/syntax.js

@@ -83,6 +83,6 @@ 'use strict';
 
-  writeName: {
+  writename: {
     description: 'If you want the file name to be different than the title, for instance setting up an index page.',
     notes:  'There is no need to provide a file extension',
-    pattern: /@writeName(.+)/g,
+    pattern: /@writename(.+)/ig,
     task: function(obj) {
@@ -89,0 +89,0 @@ obj.filteredComments = obj.filteredComments.replace(this.pattern, (match, name) => {

lib/filter-raw-string/index.js

@@ -8,2 +8,4 @@ 'use strict';
 
+  console.log('Filtering comments...');
+
   cssData.forEach((obj) => {
@@ -10,0 +12,0 @@ filterArray(obj, options.syntax);

lib/read-files/index.js

@@ -8,2 +8,3 @@ 'use strict';
 const readFiles = (files) => {
+  console.log('Reading files...');
   let filesMap = files.map((f) => {
@@ -10,0 +11,0 @@ return new Promise((resolve, reject) => {

lib/styleguider.js

@@ -31,2 +31,4 @@ 'use strict';
 
+  console.log();
+
   return Promise.resolve(resolveDirs(options.input))
@@ -33,0 +35,0 @@ .then((files) => {

lib/write-html/index.js

@@ -7,2 +7,3 @@ 'use strict';
   Handlebars = require('handlebars'),
+  chalk = require('chalk'),
   markdownRender = require('../markdown-render');
@@ -35,5 +36,6 @@
       styleguideArray.forEach((obj) => {
+        let markdownTitle = obj.writeName ? obj.writeName : obj.title;
         obj.options = options;
         obj.resources = options.resources || [];
-        obj.parsedHTML = markdownRender(obj.filteredComments, obj.resources, obj.title, options.output);
+        obj.parsedHTML = markdownRender(obj.filteredComments, obj.resources, markdownTitle, options.output);
 
@@ -44,4 +46,5 @@ let result = template(obj),
         fs.writeFileSync(`${options.output}/${fileName}.html`, result);
+
+        console.log(`Writing page: ${chalk.cyan.bold(obj.title)}...`);
       });
-
       return resolve(styleguideArray);
@@ -48,0 +51,0 @@ });

package.json

 {
   "name": "live-guide",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "description": "Generate style guides based on commented style sheets.",
@@ -5,0 +5,0 @@ "author": {

README.md

@@ -180,3 +180,3 @@ live-guide
 
-#### @writeName
+#### @writename
 **Description:** If you want the file name to be different than the title, for instance setting up an index page.
@@ -183,0 +183,0 @@ *There is no need to provide a file extension*

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

44266

increased by10.11%

Lines of code

1155

increased by19.07%

No dependency changes