feat: support development only properties

dargstack · May 29, 2022 · 79f093d · 79f093d
1 parent 8d9c13a
commit 79f093d
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/src/generator.js b/src/generator.js
@@ -9,6 +9,8 @@ const json2md = require('json2md')
 const yaml = require('yaml')
 const yargs = require('yargs')
 
+const DEVELOPMENT_ONLY_REGEX = /^\s*DARGSTACK-REMOVE\s*$/
+
 json2md.converters.vanilla = function (input, json2md) {
   return input
 }
@@ -212,6 +214,15 @@ const mdjson = [
                     'production' in itemElement[1] && itemElement[1].production
                       ? ' ![production](https://img.shields.io/badge/-production-informational.svg?style=flat-square)'
                       : ''
+                  }${
+                    'comment' in itemElement[1] &&
+                    itemElement[1].comment &&
+                    itemElement[1].comment
+                      .split('\n')
+                      .filter((element) => DEVELOPMENT_ONLY_REGEX.test(element))
+                      .length > 0
+                      ? ' ![development](https://img.shields.io/badge/-development-informational.svg?style=flat-square)'
+                      : ''
                   }`,
                 },
               ]
@@ -220,6 +231,7 @@ const mdjson = [
                 itemElementMarkdown.push({
                   vanilla: itemElement[1].comment
                     .split('\n')
+                    .filter((element) => !DEVELOPMENT_ONLY_REGEX.test(element))
                     .map((comment) => comment.trim())
                     .join('\n'),
                 })

diff --git a/test/example_stack/README.md b/test/example_stack/README.md
@@ -87,7 +87,7 @@ This project is deployed in accordance to the [DargStack template](https://githu
 
     The reverse proxy's certificate data.
 
- - ### `portainer_data`
+ - ### `portainer_data` ![development](https://img.shields.io/badge/-development-informational.svg?style=flat-square)
 
     The container manager's data.
 

diff --git a/test/example_stack/src/development/stack.yml b/test/example_stack/src/development/stack.yml
@@ -47,9 +47,9 @@ services:
     - postgres_data:/var/lib/postgresql/data/
 version: "3.6"
 volumes:
-  portainer_data:
+  portainer_data: #DARGSTACK-REMOVE
   # The container manager's data.
-    {}
+    {} #DARGSTACK-REMOVE
   postgres_data:
   # The database's data.
     {}