dargstack_rgen 0.6.55 → 0.7.0

package/.github/workflows/docker.yml

@@ -22,20 +22,20 @@ jobs:
   docker:
     needs: test
     name: Docker
-    uses: dargmuesli/github-actions/.github/workflows/docker.yml@0.11.6
+    uses: dargmuesli/github-actions/.github/workflows/docker.yml@0.11.7
     secrets:
       DOCKER_HUB_ACCESS_TOKEN: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
       DOCKER_HUB_USER_NAME: ${{ secrets.DOCKER_HUB_USER_NAME }}
   release-semantic:
     needs: docker
     name: Semantic Release
-    uses: dargmuesli/github-actions/.github/workflows/release-semantic.yml@0.11.6
+    uses: dargmuesli/github-actions/.github/workflows/release-semantic.yml@0.11.7
     secrets:
       GH_TOKEN: ${{ secrets.GH_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
   release-assets:
     needs: release-semantic
     name: Release Assets
-    uses: dargmuesli/github-actions/.github/workflows/release-assets.yml@0.11.6
+    uses: dargmuesli/github-actions/.github/workflows/release-assets.yml@0.11.7
     with:
       TARGET: development

package/.github/workflows/release-schedule.yml

@@ -7,6 +7,6 @@ on:
 jobs:
   release-schedule:
     name: 'Release: Scheduled'
-    uses: dargmuesli/github-actions/.github/workflows/release-schedule.yml@0.11.6
+    uses: dargmuesli/github-actions/.github/workflows/release-schedule.yml@0.11.7
     secrets:
       GH_TOKEN: ${{ secrets.GH_TOKEN }}

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "semi": false,
+  "singleQuote": true
+}

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.7.0](https://github.com/dargmuesli/dargstack_rgen/compare/0.6.55...0.7.0) (2022-05-29)
+
+
+### Features
+
+* support development only properties ([79f093d](https://github.com/dargmuesli/dargstack_rgen/commit/79f093d160424affa2bea3c360397004a5cbd4eb))
+
 ## [0.6.55](https://github.com/dargmuesli/dargstack_rgen/compare/0.6.54...0.6.55) (2022-05-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dargstack_rgen",
-  "version": "0.6.55",
+  "version": "0.7.0",
   "scheduleVersion": "0.6.55",
   "description": "Generates a DargStack stack project readme.",
   "main": "src/generator.js",
@@ -12,13 +12,13 @@
   },
   "dependencies": {
     "deepmerge": "4.2.2",
-    "diff": "5.0.0",
+    "diff": "5.1.0",
     "json2md": "1.12.0",
     "yaml": "2.1.0",
     "yargs": "17.5.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.0.0",
+    "@commitlint/cli": "17.0.1",
     "@commitlint/config-conventional": "17.0.0",
     "eslint": "8.16.0",
     "eslint-config-standard": "17.0.0",

package/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
 }
@@ -17,22 +19,31 @@ const argv = yargs
   .option('path', {
     alias: 'p',
     description: 'Path to a DargStack stack project',
-    type: 'string'
+    type: 'string',
   })
   .option('validate', {
     alias: 'v',
     description: 'Flag that enabled validation only',
-    type: 'boolean'
+    type: 'boolean',
   })
   .help()
-  .alias('help', 'h')
-  .argv
+  .alias('help', 'h').argv
 
 const projectPath = argv.path || process.cwd()
 const validate = argv.validate || false
 
-const stackDevelopmentPath = path.join(projectPath, 'src', 'development', 'stack.yml')
-const stackProductionPath = path.join(projectPath, 'src', 'production', 'production.yml')
+const stackDevelopmentPath = path.join(
+  projectPath,
+  'src',
+  'development',
+  'stack.yml'
+)
+const stackProductionPath = path.join(
+  projectPath,
+  'src',
+  'production',
+  'production.yml'
+)
 
 // Read YAMLs.
 
@@ -40,14 +51,18 @@ let developmentYaml
 let productionYaml
 
 if (fs.existsSync(stackDevelopmentPath)) {
-  developmentYaml = yaml.parseDocument(fs.readFileSync(stackDevelopmentPath, 'utf8'))
+  developmentYaml = yaml.parseDocument(
+    fs.readFileSync(stackDevelopmentPath, 'utf8')
+  )
 } else {
   console.error('Development stack file not found!')
   process.exit(1)
 }
 
 if (fs.existsSync(stackProductionPath)) {
-  productionYaml = yaml.parseDocument(fs.readFileSync(stackProductionPath, 'utf8'))
+  productionYaml = yaml.parseDocument(
+    fs.readFileSync(stackProductionPath, 'utf8')
+  )
 } else {
   console.info('Production stack file not found!')
 }
@@ -94,11 +109,16 @@ for (let i = 0; i < documentItems.length; i++) {
 
     if (elementItem.value.commentBefore === undefined) {
       if (!process.argv.includes('--no-comments')) {
-        console.error(`${documentItem.key.value}: ${elementItem.key.value} is missing a comment!`)
+        console.error(
+          `${documentItem.key.value}: ${elementItem.key.value} is missing a comment!`
+        )
         commentMissing = true
       }
     } else {
-      contentElementItem.comment = elementItem.value.commentBefore.split('\n').map(element => element.trim()).join('\n')
+      contentElementItem.comment = elementItem.value.commentBefore
+        .split('\n')
+        .map((element) => element.trim())
+        .join('\n')
     }
 
     contentElementItems[elementItem.key.value] = contentElementItem
@@ -128,15 +148,25 @@ for (let i = 0; i < documentItems.length; i++) {
 
   for (let j = 0; j < elementItems.length; j++) {
     const elementItem = elementItems[j]
-    const contentElementItem = { production: !(elementItem.key.value in content[documentItem.key.value]) }
+    const contentElementItem = {
+      production: !(elementItem.key.value in content[documentItem.key.value]),
+    }
 
     if (elementItem.value.commentBefore === undefined) {
-      if (!process.argv.includes('--no-comments') && !(elementItem.key.value in content[documentItem.key.value])) {
-        console.error(`${documentItem.key.value}: ${elementItem.key.value} is missing a comment!`)
+      if (
+        !process.argv.includes('--no-comments') &&
+        !(elementItem.key.value in content[documentItem.key.value])
+      ) {
+        console.error(
+          `${documentItem.key.value}: ${elementItem.key.value} is missing a comment!`
+        )
         commentMissing = true
       }
     } else {
-      contentElementItem.comment = elementItem.value.commentBefore.split('\n').map(element => element.trim()).join('\n')
+      contentElementItem.comment = elementItem.value.commentBefore
+        .split('\n')
+        .map((element) => element.trim())
+        .join('\n')
     }
 
     contentElementItems[elementItem.key.value] = contentElementItem
@@ -146,7 +176,10 @@ for (let i = 0; i < documentItems.length; i++) {
     toc.push(documentItem.key.value)
   }
 
-  content[documentItem.key.value] = deepMerge(content[documentItem.key.value], contentElementItems)
+  content[documentItem.key.value] = deepMerge(
+    content[documentItem.key.value],
+    contentElementItems
+  )
 }
 
 if (commentMissing) {
@@ -158,32 +191,58 @@ const mdjson = [
   {
     p: [
       `The Docker stack configuration for [${webName}](${webUrl}).`,
-      `This project is deployed in accordance to the [DargStack template](https://github.com/dargmuesli/dargstack_template/) to make deployment a breeze. It is closely related to [${sourceName}'s source code](${sourceUrl}).`
-    ]
+      `This project is deployed in accordance to the [DargStack template](https://github.com/dargmuesli/dargstack_template/) to make deployment a breeze. It is closely related to [${sourceName}'s source code](${sourceUrl}).`,
+    ],
   },
   { h2: 'Table of Contents' },
   {
-    ol: toc.map(element => { return { link: { title: element, source: '#' + element } } })
+    ol: toc.map((element) => {
+      return { link: { title: element, source: '#' + element } }
+    }),
   },
-  Object.entries(content).map(contentElement => {
+  Object.entries(content).map((contentElement) => {
     return [
       { h2: contentElement[0] },
       {
         ul: [
-          ...Object.entries(contentElement[1]).sort().map(itemElement => {
-            const itemElementMarkdown = [{
-              h3: `\`${itemElement[0]}\`${'production' in itemElement[1] && itemElement[1].production ? ' ![production](https://img.shields.io/badge/-production-informational.svg?style=flat-square)' : ''}`
-            }]
-
-            if ('comment' in itemElement[1] && itemElement[1].comment) {
-              itemElementMarkdown.push({ vanilla: itemElement[1].comment.split('\n').map(comment => comment.trim()).join('\n') })
-            }
-
-            return itemElementMarkdown
-          })
-        ]
-      }]
-  })
+          ...Object.entries(contentElement[1])
+            .sort()
+            .map((itemElement) => {
+              const itemElementMarkdown = [
+                {
+                  h3: `\`${itemElement[0]}\`${
+                    '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)'
+                      : ''
+                  }`,
+                },
+              ]
+
+              if ('comment' in itemElement[1] && itemElement[1].comment) {
+                itemElementMarkdown.push({
+                  vanilla: itemElement[1].comment
+                    .split('\n')
+                    .filter((element) => !DEVELOPMENT_ONLY_REGEX.test(element))
+                    .map((comment) => comment.trim())
+                    .join('\n'),
+                })
+              }
+
+              return itemElementMarkdown
+            }),
+        ],
+      },
+    ]
+  }),
 ]
 
 const md = json2md(mdjson)
@@ -202,13 +261,13 @@ if (validate) {
   const difference = diff.diffLines(md + '\n', readme)
 
   if (difference.length > 1) {
-    console.error('The README is not up-2-date!\n' +
-      'Remember that newline diffs aren\'t visibly highlighted.')
+    console.error(
+      'The README is not up-2-date!\n' +
+        "Remember that newline diffs aren't visibly highlighted."
+    )
 
     difference.forEach((part) => {
-      let color = part.added
-        ? 'green'
-        : part.removed ? 'red' : 'grey'
+      let color = part.added ? 'green' : part.removed ? 'red' : 'grey'
 
       switch (color) {
         case 'green':

package/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.
     

package/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.
     {}