dargstack_rgen 0.9.30 → 0.9.32

package/.dockerignore

@@ -1,5 +1,53 @@
-# Created by https://www.toptal.com/developers/gitignore/api/node
-# Edit at https://www.toptal.com/developers/gitignore?templates=node
+# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,node,windows
+# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,node,windows
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
 
 ### Node ###
 # Logs
@@ -9,6 +57,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+.pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -24,6 +73,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+*.lcov
 
 # nyc test coverage
 .nyc_output
@@ -44,8 +94,11 @@ build/Release
 node_modules/
 jspm_packages/
 
-# TypeScript v1 declaration files
-typings/
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
 
 # Optional npm cache directory
 .npm
@@ -53,6 +106,15 @@ typings/
 # Optional eslint cache
 .eslintcache
 
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
 # Optional REPL history
 .node_repl_history
 
@@ -62,22 +124,40 @@ typings/
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variables file
+# dotenv environment variable files
 .env
-.env.test
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
+.parcel-cache
 
-# next.js build output
+# Next.js build output
 .next
+out
 
-# nuxt.js build output
+# Nuxt.js build / generate output
 .nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
 
 # vuepress build output
 .vuepress/dist
 
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
 # Serverless directories
 .serverless/
 
@@ -87,4 +167,52 @@ typings/
 # DynamoDB Local files
 .dynamodb/
 
-# End of https://www.toptal.com/developers/gitignore/api/node
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/linux,macos,node,windows

package/.github/workflows/ci.yml

@@ -3,19 +3,47 @@ name: CI
 on:
   pull_request:
   push:
-  release:
-    types: [published]
+    branches:
+      - alpha
+      - beta
+      - master
+      - renovate/**
 
 jobs:
+  prepare_jobs:
+    name: "Prepare: job optimization"
+    runs-on: ubuntu-latest
+    outputs:
+      pr_found: ${{ steps.pr.outputs.pr_found }}
+    steps:
+      - name: Get current PR
+        id: pr
+        uses: 8BitJonny/gh-get-current-pr@3.0.0
+        with:
+          filterOutClosed: true
+          sha: ${{ github.event.pull_request.head.sha }}
+  release_semantic_dry:
+    needs: prepare_jobs
+    name: Release (semantic, dry)
+    uses: dargmuesli/github-actions/.github/workflows/release-semantic.yml@1.7.7
+    if: needs.prepare_jobs.outputs.pr_found == 'false' || github.event_name == 'pull_request'
+    permissions:
+      contents: write
+    secrets:
+      PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+    with:
+      DRY_RUN: true
   build:
     name: Build
-    uses: dargmuesli/github-actions/.github/workflows/docker.yml@1.7.6
+    uses: dargmuesli/github-actions/.github/workflows/docker.yml@1.7.7
+    needs: release_semantic_dry
     permissions:
       packages: write
   release-semantic:
     needs: build
     name: Release (semantic)
-    uses: dargmuesli/github-actions/.github/workflows/release-semantic.yml@1.7.6
+    uses: dargmuesli/github-actions/.github/workflows/release-semantic.yml@1.7.7
     permissions:
       contents: write
     secrets:

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

@@ -8,7 +8,7 @@ on:
 jobs:
   release-schedule:
     name: 'Release: Scheduled'
-    uses: dargmuesli/github-actions/.github/workflows/release-schedule.yml@1.7.6
+    uses: dargmuesli/github-actions/.github/workflows/release-schedule.yml@1.7.7
     secrets:
       PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
     with:

package/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "editorconfig.editorconfig",
+    "esbenp.prettier-vscode",
+    "timonwong.shellcheck"
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "eslint.workingDirectories": [
+    {
+      "directory": "./src/"
+    },
+    {
+      "directory": "./test/"
+    }
+  ],
+  "shellcheck.customArgs": ["-x"]
+}

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.9.32](https://github.com/dargstack/dargstack_rgen/compare/0.9.31...0.9.32) (2024-04-16)
+
+
+### Bug Fixes
+
+* correct imports ([2db545d](https://github.com/dargstack/dargstack_rgen/commit/2db545d9e1d5b122a4c2ae4a019b0f35df7deb98))
+
+## [0.9.31](https://github.com/dargstack/dargstack_rgen/compare/0.9.30...0.9.31) (2024-04-16)
+
+
+### Bug Fixes
+
+* schedule release ([17c4505](https://github.com/dargstack/dargstack_rgen/commit/17c45055cc06a4107eda0ab2218d13eee4c23256))
+
 ## [0.9.30](https://github.com/dargstack/dargstack_rgen/compare/0.9.29...0.9.30) (2024-04-02)
 
 

package/Dockerfile

@@ -1,13 +1,13 @@
-FROM node:20.12.0-alpine@sha256:ef3f47741e161900ddd07addcaca7e76534a9205e4cd73b2ed091ba339004a75 AS development
+FROM node:20.12.2-alpine@sha256:ec0c413b1d84f3f7f67ec986ba885930c57b5318d2eb3abc6960ee05d4f2eb28 AS development
 
 WORKDIR /srv/app/
 
 VOLUME /srv/app
 
-ENTRYPOINT ["node", "./src/generator.cjs"]
+ENTRYPOINT ["node", "./src/generator.js"]
 
 
-FROM node:20.12.0-alpine@sha256:ef3f47741e161900ddd07addcaca7e76534a9205e4cd73b2ed091ba339004a75 AS prepare
+FROM node:20.12.2-alpine@sha256:ec0c413b1d84f3f7f67ec986ba885930c57b5318d2eb3abc6960ee05d4f2eb28 AS prepare
 
 WORKDIR /srv/app/
 
@@ -21,11 +21,7 @@ COPY ./ ./
 RUN pnpm install --offline
 
 
-FROM node:20.12.0-alpine@sha256:ef3f47741e161900ddd07addcaca7e76534a9205e4cd73b2ed091ba339004a75 AS build
-
-WORKDIR /srv/app/
-
-COPY --from=prepare /srv/app/ ./
+FROM prepare AS build
 
 ENV NODE_ENV=production
 
@@ -33,28 +29,22 @@ RUN corepack enable && \
     pnpm install --offline --ignore-scripts
 
 
-FROM node:20.12.0-alpine@sha256:ef3f47741e161900ddd07addcaca7e76534a9205e4cd73b2ed091ba339004a75 AS test
-
-WORKDIR /srv/app/
-
-COPY --from=prepare /srv/app/ ./
+FROM prepare AS test
 
 RUN corepack enable && \
     pnpm run test
 
 
-FROM node:20.12.0-alpine@sha256:ef3f47741e161900ddd07addcaca7e76534a9205e4cd73b2ed091ba339004a75 AS collect
-
-WORKDIR /srv/app/
+FROM prepare AS collect
 
 COPY --from=build /srv/app/ /srv/app/
 COPY --from=test /srv/app/package.json /tmp/package.json
 
 
-FROM node:20.12.0-alpine@sha256:ef3f47741e161900ddd07addcaca7e76534a9205e4cd73b2ed091ba339004a75 AS production
+FROM node:20.12.2-alpine@sha256:ec0c413b1d84f3f7f67ec986ba885930c57b5318d2eb3abc6960ee05d4f2eb28 AS production
 
 WORKDIR /srv/app/
 
 COPY --from=collect /srv/app/ ./
 
-ENTRYPOINT ["node", "./src/generator.cjs"]
+ENTRYPOINT ["node", "./src/generator.js"]

package/eslint.config.js

@@ -0,0 +1,26 @@
+import eslint from '@eslint/js'
+import globals from 'globals'
+import prettierRecommended from 'eslint-plugin-prettier/recommended'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  prettierRecommended, // must be last
+  {
+    rules: {
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+        },
+      ],
+    },
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+    },
+  },
+)

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Jonas Thelemann <e-mail+dargstack/dargstack_rgen@jonas-thelemann.de>",
   "bin": {
-    "dargstack_rgen": "./src/generator.cjs"
+    "dargstack_rgen": "./src/generator.js"
   },
   "dependencies": {
     "deepmerge": "4.3.1",
@@ -12,28 +12,32 @@
   },
   "description": "Generates a DargStack stack project readme.",
   "devDependencies": {
-    "@commitlint/cli": "19.2.1",
-    "@commitlint/config-conventional": "19.1.0",
-    "eslint": "8.57.0",
+    "@commitlint/cli": "19.2.2",
+    "@commitlint/config-conventional": "19.2.2",
+    "@types/diff": "5.0.9",
+    "@types/json2md": "1.5.4",
+    "@types/yargs": "17.0.32",
+    "eslint": "9.0.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-n": "16.6.2",
     "eslint-plugin-prettier": "5.1.3",
+    "globals": "15.0.0",
     "husky": "9.0.11",
-    "prettier": "3.2.5"
+    "prettier": "3.2.5",
+    "typescript-eslint": "7.5.0"
   },
   "engines": {
     "node": "20"
   },
   "license": "GPL-3.0-only",
-  "main": "src/generator.cjs",
+  "main": "src/generator.js",
   "name": "dargstack_rgen",
-  "packageManager": "pnpm@8.15.5",
+  "packageManager": "pnpm@9.0.1",
   "repository": "https://github.com/dargstack/dargstack_rgen.git",
   "scripts": {
-    "lint": "eslint --ext .js,.cjs .",
+    "lint": "eslint --cache",
     "prepare": "husky",
-    "test": "node src/generator.cjs -p test/example_stack -v"
+    "test": "node src/generator.js -p test/example_stack -v"
   },
   "type": "module",
-  "version": "0.9.30"
+  "version": "0.9.32"
 }

package/src/{generator.cjs → generator.js}

@@ -1,21 +1,20 @@
-#!/usr/bin/env node
+import fs from 'node:fs'
+import path from 'node:path'
 
-const fs = require('fs')
-const path = require('path')
-
-const deepMerge = require('deepmerge')
-const diff = require('diff')
-const json2md = require('json2md')
-const yaml = require('yaml')
-const yargs = require('yargs')
+import deepMerge from 'deepmerge'
+import { diffLines } from 'diff'
+import json2md from 'json2md'
+import yaml from 'yaml'
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
 
 const DEVELOPMENT_ONLY_REGEX = /^\s*DARGSTACK-REMOVE\s*$/
 
-json2md.converters.vanilla = function (input, json2md) {
+json2md.converters.vanilla = function (input, _json2md) {
   return input
 }
 
-const argv = yargs
+const argv = yargs(hideBin(process.argv))
   .option('path', {
     alias: 'p',
     description: 'Path to a DargStack stack project',
@@ -27,7 +26,8 @@ const argv = yargs
     type: 'boolean',
   })
   .help()
-  .alias('help', 'h').argv
+  .alias('help', 'h')
+  .parse()
 
 const projectPath = argv.path || process.cwd()
 const validate = argv.validate || false
@@ -36,13 +36,13 @@ const stackDevelopmentPath = path.join(
   projectPath,
   'src',
   'development',
-  'stack.yml'
+  'stack.yml',
 )
 const stackProductionPath = path.join(
   projectPath,
   'src',
   'production',
-  'production.yml'
+  'production.yml',
 )
 
 // Read YAMLs.
@@ -52,31 +52,28 @@ let productionYaml
 
 if (fs.existsSync(stackDevelopmentPath)) {
   developmentYaml = yaml.parseDocument(
-    fs.readFileSync(stackDevelopmentPath, 'utf8')
+    fs.readFileSync(stackDevelopmentPath, 'utf8'),
   )
 } else {
-  console.error('Development stack file not found!')
-  process.exit(1)
+  throw new Error('Development stack file not found!')
 }
 
 if (fs.existsSync(stackProductionPath)) {
   productionYaml = yaml.parseDocument(
-    fs.readFileSync(stackProductionPath, 'utf8')
+    fs.readFileSync(stackProductionPath, 'utf8'),
   )
 } else {
   console.info('Production stack file not found!')
 }
 
 if (developmentYaml.commentBefore === null) {
-  console.error('YAML is missing metadata!')
-  process.exit(1)
+  throw new Error('YAML is missing metadata!')
 }
 
 const metadata = developmentYaml.commentBefore.split('\n')
 
 if (metadata.length !== 4) {
-  console.error('YAML metadata is missing keys!')
-  process.exit(1)
+  throw new Error('YAML metadata is missing keys!')
 }
 
 const webName = metadata[0].trim()
@@ -110,7 +107,7 @@ 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!`
+          `${documentItem.key.value}: ${elementItem.key.value} is missing a comment!`,
         )
         commentMissing = true
       }
@@ -158,7 +155,7 @@ for (let i = 0; i < documentItems.length; i++) {
         !(elementItem.key.value in content[documentItem.key.value])
       ) {
         console.error(
-          `${documentItem.key.value}: ${elementItem.key.value} is missing a comment!`
+          `${documentItem.key.value}: ${elementItem.key.value} is missing a comment!`,
         )
         commentMissing = true
       }
@@ -178,12 +175,12 @@ for (let i = 0; i < documentItems.length; i++) {
 
   content[documentItem.key.value] = deepMerge(
     content[documentItem.key.value],
-    contentElementItems
+    contentElementItems,
   )
 }
 
 if (commentMissing) {
-  process.exit(1)
+  throw new Error('Comment is missing!')
 }
 
 const mdjson = [
@@ -254,16 +251,15 @@ if (validate) {
   if (fs.existsSync(readmePath)) {
     readme = fs.readFileSync(readmePath, 'utf8')
   } else {
-    console.error('README.md file not found!')
-    process.exit(1)
+    throw new Error('README.md file not found!')
   }
 
-  const difference = diff.diffLines(md + '\n', readme)
+  const difference = 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."
+        "Remember that newline diffs aren't visibly highlighted.",
     )
 
     difference.forEach((part) => {
@@ -285,7 +281,7 @@ if (validate) {
       }
     })
 
-    process.exit(difference.length)
+    throw new Error(difference.length)
   }
 } else {
   console.log(md)

package/test/example_stack/src/development/stack.yml

@@ -31,7 +31,7 @@ services:
   # | Database | [postgres_db]       |
   #
   # Values in square brackets are [Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
-    image: adminer:4.8.1-standalone@sha256:b75eae89431e8469613b844e76382a26efc8601c17f446bcd81665bc87ca9a1f
+    image: adminer:4.8.1-standalone@sha256:ceca91abccc1fcd97d66cd4e8994e6f0a97a92c0e3dbdc8200d5d735e3088cd1
     volumes:
     - ../production/configurations/adminer/adminer.css:/var/www/html/adminer.css:ro
   postgres:

package/.eslintrc.json

@@ -1,10 +0,0 @@
-{
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:jest/recommended",
-    "plugin:jest/style",
-    "plugin:prettier/recommended"
-  ],
-  "parser": "@typescript-eslint/parser"
-}