@ikerin/build-readme - npm Package Compare versions

Comparing version 1.0.4 to 1.1.0

dist/index.js

@@ -11,3 +11,3 @@ "use strict";
     const escapedSection = section.replace('-', '\\-');
-    const result = content.match(new RegExp(`\/\/ << ${escapedSection}\n+(.*)\n+([ ]*)\/\/ ${escapedSection}`, 'msi'));
+    const result = content.match(new RegExp(`(?:\/\/|#) << ${escapedSection}\n+(.*)\n+([ ]*)(?:\/\/|#) ${escapedSection}`, 'msi'));
     if (!result) {
@@ -25,2 +25,3 @@ throw new Error(`Section ${section} does not exist.`);
             .map((line) => line.substr(indent.length))
+            .filter((row) => !row.match(/\/\/ (<< )?[0-9a-zA-Z\-]+/))
             .join('\n')
@@ -27,0 +28,0 @@ .trim(),

package.json

 {
   "name": "@ikerin/build-readme",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "main": "dist/index.js",
@@ -5,0 +5,0 @@ "types": "dist/index.d.ts",

README.md

@@ -35,2 +35,18 @@ # Build Readme
 
+There is also support for `#` style comments
+
+> [examples/oapi.yaml:(test-section)](examples/oapi.yaml)
+
+```yaml
+---
+openapi: 3.0.0
+info:
+  # << test-section
+  title: Simple API
+  version: 1.0.0
+  # test-section
+servers:
+  - url: 'http: //localhost:3333'
+```
+
 ## Running the tests
@@ -37,0 +53,0 @@

No alert changes

Improved metrics

Total package byte prevSize

176385

increased by0.24%

Lines of code

97

increased by1.04%

Number of lines in readme file

86

increased by22.86%

No dependency changes