live-guide - npm Package Compare versions

Comparing version 0.6.7 to 0.7.0

lib/filter-array/lib/syntax.js

@@ -22,4 +22,4 @@ 'use strict';
   author: {
-    description: 'Contribute the code to someone',
-    example: ['/* @example Jan Doe */', `// @author Jon Doe`],
+    description: 'Contribute the code to someone.',
+    example: ['/* @author Jan Doe */', `// @author Jon Doe`],
     pattern: /@author[^\S\n]+?(.+)/g,
@@ -38,3 +38,3 @@ filter: '<p class="author">**Authored by:** *$1*</p>',
     description: 'A code example, similar to writing code blocks in Markdown',
-    example: [`//@example\n//<button class="btn">Click me, I do stuff!</button>//\n`, `/*\n@example\n*<button class="btn">Click me, I do stuff!//</button>\n*/`],
+    example: [`//@example\n//<button class="btn">Click me, I do stuff!</button>\n//\n`, `/*\n@example\n*<button class="btn">Click me, I do stuff!</button>\n*/`],
     notes: 'Any example written in a single line comments will need a blank comment line `//` after it.',
@@ -66,3 +66,3 @@ pattern: /^@example(.*?)?$\s((?:^.+$\s?)+)/gm,
   todo: {
-    description: 'Let users know what needs to be done in this section of your style guide',
+    description: 'Let users know what needs to be done in this section of your styleguide',
     pattern: /^@(?:todo|task) (.*)$/gm,
@@ -79,3 +79,4 @@ filter: `**TODO:** *$1*`
   wrietName: {
-    description: 'If you want the file name to be different than the title, for instance setting up an index page. *There is no need to provide a file extension*',
+    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,
@@ -82,0 +83,0 @@ task: function(obj) {

package.json

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

README.md

@@ -29,11 +29,11 @@ live-guide
 ```shell
+styleguider --input **/*.css [options]
+
 Options:
-  --input, -i     file(s) (glob pattern) that should be evaulated and built into
-                  the Styleguide                                      [required]
-  --output, -o    Where should the output styleguide go? Defaults to current
-                  working directory /styleguide
-  --resource, -r  additional resources to be loaded into the code example
-                  iframes                                                [array]
+  --input, -i     file(s) (glob pattern) that should be evaulated and built into the Styleguide  [required]
+  --output, -o    Where should the output styleguide go? Defaults to current working directory /styleguide
+  --resource, -r  additional resources to be loaded into the code example iframes  [array]
   --name, -n      name for the style guide or product
-  --help, -h      Show help                                            [boolean]
+  --help, -h      Show help  [boolean]
+
 ```
@@ -44,9 +44,7 @@
 #### @author
-**Description:** Contribute the code to someone
+**Description:** Contribute the code to someone.
 
-
-
 **Example:**
 ```
-/* @example Jan Doe */
+/* @author Jan Doe */
 
@@ -60,4 +58,2 @@ // @author Jon Doe
 
-
-
 **Example:**
@@ -73,3 +69,2 @@ ```
 **Description:** A code example, similar to writing code blocks in Markdown
-
 *Any example written in a single line comments will need a blank comment line `//` after it.*
@@ -80,3 +75,4 @@
 //@example
-//<button class="btn">Click me, I do stuff!</button>//
+//<button class="btn">Click me, I do stuff!</button>
+//
 
@@ -86,3 +82,3 @@
 @example
-*<button class="btn">Click me, I do stuff!//</button>
+*<button class="btn">Click me, I do stuff!</button>
 */
@@ -98,6 +94,4 @@ ```
 
-
-
 #### @todo
-**Description:** Let users know what needs to be done in this section of your style guide
+**Description:** Let users know what needs to be done in this section of your styleguide
 
@@ -107,4 +101,2 @@
 
-
-
 #### @url
@@ -116,6 +108,8 @@ **Description:** Add a link to the styleguide, automatically opens in a new tab
 
+#### @wrietName
+**Description:** If you want the file name to be different than the title, for instance setting up an index page.
+*There is no need to provide a file extension*
 
 
-#### @wrietName
-**Description:** If you want the file name to be different than the title, for instance setting up an index page. *There is no need to provide a file extension*
+## Todo
 
@@ -125,3 +119,2 @@
 
-## Todo
 
@@ -132,2 +125,3 @@
 
+
 - Log whats happening.
@@ -134,0 +128,0 @@ - Internal Modules

scripts/build-readme.js

@@ -6,3 +6,3 @@ 'use strict';
   syntaxAPI = require(path.resolve(__dirname, '../lib/filter-array/lib/syntax')),
-  readmeRegex = /##(?:[\sa-z]+)api(.|\n)*## TODO/gi;
+  readmeRegex = /## module api(.|\n)*## TODO/gi;
 
@@ -9,0 +9,0 @@ const syntaxString = function(key, obj) {

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

32317

increased by0.47%

Lines of code

770

increased by0.13%

Worsened metrics

Number of lines in readme file

123

decreased by-4.65%

No dependency changes