@rse/nunjucks-cli 0.9.5

package/README.md

@@ -0,0 +1,89 @@
+
+nunjucks-cli
+============
+
+**Nunjucks Template Rendering Command-Line Interface**
+
+<p/>
+<img src="https://nodei.co/npm/nunjucks-cli.png?downloads=true&stars=true" alt=""/>
+
+<p/>
+<img src="https://david-dm.org/rse/nunjucks-cli.png" alt=""/>
+
+Abstract
+--------
+
+This is a small command-line utility to render templates with the rich
+and powerful templating language [Mozilla Nunjucks](https://mozilla.github.io/nunjucks/).
+This allows you to define your configuration in a YAML file and then render
+an output file based on a template input file where your configuration can be expanded.
+
+Installation
+------------
+
+```
+$ npm install -g @rse/nunjucks-cli
+```
+
+Usage
+-----
+
+```
+$ nunjucks
+  [-h|--help] [-V|--version]
+  [-c|--config <config-file>]
+  [-d|--defines <context-file>]
+  [-D|--define <key>=<value>]
+  [-e|--extension <extension-file>]
+  [-o|--output <output-file>|-]
+  <input-file>|-
+```
+
+- `-h`|`--help`:<br/>
+  show usage help.
+- `-V`|`--version`:<br/>
+  show program version information.
+- `-c`|`--config` `<config-file>`:<br/>
+  load Nunjucks configuration YAML file
+- `-d`|`--defines` `<context-file>`:<br/>
+  load context definition YAML file.
+- `-D`|`--define` `<key>=<value>`:<br/>
+  set context definition key/value.
+- `-e`|`--extension` `<extension-file>`:<br/>
+  load Nunjucks JavaScript extension file.
+- `-o`|`--output` `<output-file>`|`-`:<br/>
+  save output file (or stdout).
+- `<input-file>`|`-`:<br/>
+  load input file (or stdin).
+
+Example
+-------
+
+```sh
+$ echo "Hello, {{who}}!" | nunjucks -D who=world -
+```
+
+License
+-------
+
+Copyright (c) 2019-2023 Dr. Ralf S. Engelschall (http://engelschall.com/)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/eslint.yaml

@@ -0,0 +1,51 @@
+##
+##  nunjucks -- Nunjucks Template Rendering Command-Line Interface
+##  Copyright (c) 2019-2023 Dr. Ralf S. Engelschall <http://engelschall.com>
+##  Licensed under MIT <http://spdx.org/licenses/MIT.html>
+##
+
+---
+
+extends:
+    - eslint:recommended
+    - eslint-config-standard
+
+parserOptions:
+    ecmaVersion: 8
+    sourceType:  module
+    ecmaFeatures:
+        jsx:     false
+
+env:
+    browser:       false
+    node:          true
+    mocha:         false
+    commonjs:      true
+    worker:        false
+    serviceworker: false
+
+globals:
+    process:       true
+
+rules:
+    #   modified rules
+    indent:                              [ "error", 4, { "SwitchCase": 1 } ]
+    linebreak-style:                     [ "error", "unix" ]
+    semi:                                [ "error", "never" ]
+    operator-linebreak:                  [ "error", "after", { "overrides": { "&&": "before", "||": "before", ":": "after" } } ]
+    brace-style:                         [ "error", "stroustrup", { "allowSingleLine": true } ]
+    quotes:                              [ "error", "double" ]
+
+    #   disabled rules
+    no-multi-spaces:                     off
+    no-multiple-empty-lines:             off
+    key-spacing:                         off
+    object-property-newline:             off
+    curly:                               off
+    space-in-parens:                     off
+    array-bracket-spacing:               off
+    require-atomic-updates:              off
+    dot-notation:                        off
+    no-whitespace-before-property:       off
+    lines-between-class-members:         off
+

package/nunjucks.d/date.js

@@ -0,0 +1,38 @@
+/*
+**  nunjucks -- Nunjucks Template Rendering Command-Line Interface
+**  Copyright (c) 2019-2023 Dr. Ralf S. Engelschall <http://engelschall.com>
+**  Licensed under MIT <http://spdx.org/licenses/MIT.html>
+*/
+
+const moment = require("moment")
+const nlib   = require("nunjucks/src/lib")
+
+module.exports = (env) => {
+    /*  add a "date" formatting filter  */
+    env.addFilter("date", (date, format, ...args) => {
+        let result
+        const errs = []
+        let obj
+        try {
+            obj = moment(date)
+        }
+        catch (err) {
+            errs.push(err)
+        }
+        if (obj) {
+            try {
+                if (obj[format] && nlib.isFunction(obj[format]))
+                    result = obj[format](obj, ...args.slice(2))
+                else
+                    result = obj.format(format)
+            }
+            catch (err) {
+                errs.push(err)
+            }
+        }
+        if (errs.length)
+            return errs.join("\n")
+        return result
+    })
+}
+

package/nunjucks.d/default.js

@@ -0,0 +1,52 @@
+/*
+**  nunjucks -- Nunjucks Template Rendering Command-Line Interface
+**  Copyright (c) 2019-2023 Dr. Ralf S. Engelschall <http://engelschall.com>
+**  Licensed under MIT <http://spdx.org/licenses/MIT.html>
+*/
+
+module.exports = (env) => {
+    const globals = {
+        bool: (val) => {
+            if      (typeof val === "undefined") return false
+            else if (typeof val === "boolean")   return val
+            else if (typeof val === "number")    return !isNaN(val) && val !== 0
+            else if (typeof val === "string")    return val.match(/^(?:true|yes)$/i) !== null
+            else                                 return !!val
+        },
+        int: (val) => {
+            if      (typeof val === "undefined") return NaN
+            else if (typeof val === "boolean")   return val ? 1 : 0
+            else if (typeof val === "number")    return val
+            else if (typeof val === "string")    return parseInt(val, 10)
+            else                                 return 0
+        },
+        float: (val) => {
+            if      (typeof val === "undefined") return NaN
+            else if (typeof val === "boolean")   return val ? 1.0 : 0.0
+            else if (typeof val === "number")    return val
+            else if (typeof val === "string")    return parseFloat(val)
+            else                                 return 0.0
+        },
+        string: (val) => {
+            if      (typeof val === "undefined") return "undefined"
+            else if (typeof val === "boolean")   return val.toString()
+            else if (typeof val === "number")    return val.toString()
+            else if (typeof val === "string")    return val
+            else                                 return val.toString()
+        },
+        default: (val, def, type) => {
+            if (val === undefined)
+                val = def
+            if      (type === "bool")   val = globals.bool(val)
+            else if (type === "int")    val = globals.int(val)
+            else if (type === "float")  val = globals.float(val)
+            else if (type === "string") val = globals.string(val)
+            else throw new Error(`invalid coercion type "${type}"`)
+            return val
+        }
+    }
+    Object.keys(globals).forEach((name) => {
+        env.addGlobal(name, globals[name])
+    })
+}
+

package/nunjucks.d/eval.js

@@ -0,0 +1,29 @@
+/*
+**  nunjucks -- Nunjucks Template Rendering Command-Line Interface
+**  Copyright (c) 2019-2023 Dr. Ralf S. Engelschall <http://engelschall.com>
+**  Licensed under MIT <http://spdx.org/licenses/MIT.html>
+*/
+
+module.exports = (env) => {
+    /*  add a "set"-like "eval" extension  */
+    class EvalExtension {
+        constructor () {
+            this.tags = [ "eval" ]
+        }
+        parse (parser, nodes, lexer) {
+            const tok = parser.nextToken()
+            const args = parser.parseSignature(null, true)
+            parser.advanceAfterBlockEnd(tok.value)
+            return new nodes.CallExtension(this, "run", args)
+        }
+        run (context, args) {
+            for (const arg in args) {
+                if (arg !== "__keywords")
+                    /* eslint no-eval: off */
+                    context.ctx[arg] = eval(args[arg])
+            }
+        }
+    }
+    env.addExtension("EvalExtension", new EvalExtension())
+}
+

package/nunjucks.js

@@ -0,0 +1,175 @@
+#!/usr/bin/env node
+/*
+**  nunjucks -- Nunjucks Template Rendering Command-Line Interface
+**  Copyright (c) 2019-2023 Dr. Ralf S. Engelschall <http://engelschall.com>
+**  Licensed under MIT <http://spdx.org/licenses/MIT.html>
+*/
+
+/*  own information  */
+const my       = require("./package.json")
+
+/*  internal requirements  */
+const fs       = require("node:fs")
+const path     = require("node:path")
+
+/*  external requirements  */
+const yargs    = require("yargs")
+const chalk    = require("chalk")
+const jsYAML   = require("js-yaml")
+const nunjucks = require("nunjucks")
+
+/*  parse command-line arguments  */
+const argv = yargs
+    .usage("Usage: nunjucks " +
+        "[-h|--help] " +
+        "[-V|--version] " +
+        "[-c|--config <config-file>] " +
+        "[-d|--defines <context-file>] " +
+        "[-D|--define <key>=<value>] " +
+        "[-e|--extension <extension-file>] " +
+        "[-o|--output <output-file>|-] " +
+        "<input-file>|-")
+    .version(false)
+    .help("h").alias("h", "help").default("h", false).describe("h", "show usage help")
+    .boolean("V").alias("V", "version").describe("V", "show program version information")
+    .string("c").nargs("c", 1).alias("c", "config").describe("c", "load Nunjucks configuration YAML file")
+    .string("d").nargs("d", 1).alias("d", "defines").describe("d", "load context definition YAML file")
+    .string("D").nargs("D", 1).alias("D", "define").describe("D", "set context definition key/value")
+    .array("e").nargs("e", 1).alias("e", "extension").describe("e", "load Nunjucks JavaScript extension file")
+    .string("o").nargs("o", 1).alias("o", "output").default("o", "-").describe("o", "save output file")
+    .strict()
+    .showHelpOnFail(true)
+    .demand(0)
+    .parse(process.argv.slice(2))
+
+/*  handle special version request  */
+if (argv.version) {
+    console.log(`${my.name} ${my.version} (Node.js ${process.versions.node}, Nunjucks: ${my.dependencies.nunjucks})`)
+    console.log(`${my.description}`)
+    console.log(`Copyright (c) 2019-2023 ${my.author.name} <${my.author.url}>`)
+    console.log(`Licensed under ${my.license} <http://spdx.org/licenses/${my.license}.html>`)
+    process.exit(0)
+}
+
+/*  read input file  */
+let input = ""
+if (argv._.length !== 1) {
+    console.error(chalk.red("nunjucks: ERROR: missing input file"))
+    process.exit(1)
+}
+let inputFile = argv._[0]
+if (inputFile === "-") {
+    inputFile = "<stdin>"
+    process.stdin.setEncoding("utf-8")
+    const BUFSIZE = 256
+    const buf = Buffer.alloc(BUFSIZE)
+    while (true) {
+        let bytesRead = 0
+        try {
+            bytesRead = fs.readSync(process.stdin.fd, buf, 0, BUFSIZE)
+        }
+        catch (ex) {
+            if      (ex.code === "EAGAIN") continue
+            else if (ex.code === "EOF")    break
+            else                           throw ex
+        }
+        if (bytesRead === 0)
+            break
+        input += buf.toString("utf8", 0, bytesRead)
+    }
+}
+else {
+    if (!fs.existsSync(inputFile)) {
+        console.error(chalk.red(`nunjucks: ERROR: failed to find input file: ${inputFile}`))
+        process.exit(1)
+    }
+    input = fs.readFileSync(inputFile, { encoding: "utf8" })
+}
+
+/*  provide context variables for template  */
+let context = {}
+if (argv.defines) {
+    try {
+        context = jsYAML.safeLoad(fs.readFileSync(argv.defines, { encoding: "utf8" }))
+    }
+    catch (ex) {
+        console.error(chalk.red(`nunjucks: ERROR: failed to load context YAML file: ${ex.toString()}`))
+        process.exit(1)
+    }
+}
+
+/*  expose environment variables to template  */
+context.env = process.env
+
+/*  add context defines  */
+if (argv.define) {
+    if (typeof argv.define === "string")
+        argv.define = [ argv.define ]
+    argv.define.forEach((define) => {
+        let [ , key, val ] = define.match(/^([^=]+)(?:=(.*))?$/)
+        if (val === undefined)
+            val = true
+        context[key] = val
+    })
+}
+
+/*  determine Nunjucks options  */
+let options = {}
+if (argv.config) {
+    try {
+        options = jsYAML.safeLoad(fs.readFileSync(argv.config, { encoding: "utf8" }))
+    }
+    catch (ex) {
+        console.error(chalk.red(`nunjucks: ERROR: failed to load options YAML file: ${ex.toString()}`))
+        process.exit(1)
+    }
+}
+options = Object.assign({}, {
+    autoescape:       true,
+    throwOnUndefined: false,
+    trimBlocks:       true,
+    lstripBlocks:     true,
+    watch:            false,
+    noCache:          true
+}, options)
+
+/*  configure environment  */
+const env = nunjucks.configure(inputFile, options)
+
+/*  load external extension files  */
+if (typeof argv.extension === "object" && argv.extension instanceof Array) {
+    for (let extension of argv.extension) {
+        if (fs.existsSync(path.join(__dirname, "nunjucks.d", `${extension}.js`)))
+            extension = path.join(__dirname, "nunjucks.d", `${extension}.js`)
+        else if (!fs.existsSync(extension)) {
+            console.error(chalk.red(`nunjucks: ERROR: failed to find extension file: ${extension}`))
+            process.exit(1)
+        }
+        const ext = require(path.resolve(extension))
+        if (!(ext !== null && typeof ext === "function")) {
+            console.error(chalk.red(`nunjucks: ERROR: failed to call extension file: ${extension}`))
+            process.exit(1)
+        }
+        ext(env)
+    }
+}
+
+/*  render Nunjucks template  */
+let output
+try {
+    output = env.renderString(input, context)
+}
+catch (ex) {
+    console.error(chalk.red(`nunjucks: ERROR: failed to render template: ${ex.toString()}`))
+    process.exit(1)
+}
+
+/*  write output  */
+if (argv.output === "-")
+    process.stdout.write(output)
+else
+    fs.writeFileSync(argv.output, output, { encoding: "utf8" })
+
+/*  die gracefully  */
+process.exit(0)
+

package/package.json

@@ -0,0 +1,35 @@
+{
+    "name":                       "@rse/nunjucks-cli",
+    "publishConfig":              { "access": "public" },
+    "version":                    "0.9.5",
+    "description":                "Nunjucks Template Rendering Command-Line Interface",
+    "author": {
+        "name":                   "Dr. Ralf S. Engelschall",
+        "email":                  "rse@engelschall.com",
+        "url":                    "http://engelschall.com"
+    },
+    "license":                    "MIT",
+    "bin": {
+        "nunjucks":               "nunjucks.js"
+    },
+    "dependencies": {
+        "nunjucks":               "3.2.4",
+        "chalk":                  "4.1.0",
+        "yargs":                  "17.7.2",
+        "moment":                 "2.29.4",
+        "moment-timezone":        "0.5.43",
+        "js-yaml":                "4.1.0"
+    },
+    "devDependencies": {
+        "eslint":                 "8.47.0",
+        "eslint-config-standard": "17.1.0",
+        "eslint-plugin-promise":  "6.1.1",
+        "eslint-plugin-import":   "2.28.0",
+        "eslint-plugin-node":     "11.1.0"
+    },
+    "upd":                        [ "!chalk" ],
+    "scripts": {
+        "lint":                   "eslint --config eslint.yaml nunjucks.js",
+        "test":                   "echo 'Hello, {{who}}!' | node nunjucks.js -D who=world -"
+    }
+}

package/sample.txt

@@ -0,0 +1,153 @@
+##
+##  Composefile -- Docker Compose Configuration
+##
+
+{% set WITH_SRV_NAME       = default(WITH_SRV_NAME,   "ASE-K3S", "string") %}
+{% set WITH_SRV_DESC       = default(WITH_SRV_DESC,   "K3S Kubernetes Application Server (ASE)", "string") %}
+
+{% set WITH_URL_SCHEME     = default(WITH_URL_SCHEME, DOCKER_STACK_URL_SCHEME, "string") %}
+{% set WITH_URL_HOST       = default(WITH_URL_HOST,   DOCKER_STACK_URL_HOST,   "string") %}
+{% set WITH_URL_MODE       = default(WITH_URL_MODE,   DOCKER_STACK_URL_MODE,   "string") %}
+{% set WITH_URL_PATH       = default(WITH_URL_PATH,   DOCKER_STACK_URL_PATH,   "string") %}
+
+{% set WITH_WORKERS        = default(WITH_WORKERS,        3,        "int")  %}
+{% set WITH_SMI            = default(WITH_SMI,            "no",     "bool") %}
+{% set WITH_FAAS           = default(WITH_FAAS,           "no",     "bool") %}
+
+version: "3.7"
+
+services:
+
+    #   the K3S Proxy service
+    ase-k3s-proxy:
+        container_name: ase-k3s-proxy
+        image:          docker.msg.team/ps/std-nginx:1.19.3-20200930
+        init:           true
+        restart:        always
+        environment:
+            PROXY_SRV_NAME:    {{ WITH_SRV_NAME   }}
+            PROXY_SRV_DESC:    {{ WITH_SRV_DESC   }}
+            PROXY_URL_SCHEME:  {{ WITH_URL_SCHEME }}
+            PROXY_URL_HOST:    {{ WITH_URL_HOST   }}
+            PROXY_URL_MODE:    {{ WITH_URL_MODE   }}
+            PROXY_URL_PATH:    {{ WITH_URL_PATH   }}
+            PROXY_DST_PATH:    {{ WITH_URL_PATH   }}
+        volumes:
+            - ./nginx.conf:/conf/nginx.conf:ro
+        networks:
+            proxy:
+            ase-k3s: { aliases: [ proxy ] }
+        depends_on:
+            - ase-k3s-server
+
+    #   the K3S Server service
+    ase-k3s-server:
+        hostname:       node0
+        container_name: ase-k3s-server
+        image:          docker.msg.team/ps/ase-k3s:1.22.4-20211130
+        init:           true
+        command: >-
+            server
+            --bind-address=0.0.0.0
+            --https-listen-port=6443
+            --kube-apiserver-arg=external-hostname={{ WITH_URL_HOST }}
+            --data-dir=/data/k3s
+        restart:        always
+        privileged:     true
+        environment:
+            K3S_PROXY_URL_MODE:      {{ WITH_URL_MODE }}
+            K3S_CLUSTER_SECRET:      "{{ WITH_CLUSTER_SECRET }}"
+            K3S_NODE_NAME:           node0
+            K3S_KUBECONFIG_OUTPUT:   /conf/kubeconfig.yaml
+            K3S_KUBECONFIG_MODE:     666
+            KUBECONFIG_SERVER_URL:   "{{ WITH_URL_SCHEME }}://{{ WITH_URL_HOST }}{{ WITH_URL_PATH }}"
+            K3S_TOKEN:               "foobar"
+        ports:
+            - 6443:6443
+        volumes:
+            - ase-k3s-server:/data
+            - ./manifest-1-root.yaml:/data/k3s/server/manifests/ase-k3s-1-root.yaml
+            {% if WITH_WORKERS > 0 %}
+            - ./local-storage.yaml.skip:/data/k3s/server/manifests/local-storage.yaml.skip
+            - ./manifest-2-csi.yaml:/data/k3s/server/manifests/ase-k3s-2-csi.yaml
+            {% endif %}
+            {% if WITH_SMI %}
+            - ./manifest-3-smi.yaml:/data/k3s/server/manifests/ase-k3s-3-smi.yaml
+            {% endif %}
+            {% if WITH_FAAS %}
+            - ./manifest-4-faas.yaml:/data/k3s/server/manifests/ase-k3s-4-kubeless.yaml
+            {% endif %}
+            - ./manifest-5-ui.yaml:/data/k3s/server/manifests/ase-k3s-5-ui.yaml
+            - ./ps-kubernetes-dashboard-0.0.0.tgz:/data/k3s/server/static/charts/ps-kubernetes-dashboard-0.0.0.tgz
+        networks:
+            ase-k3s: { aliases: [ node0, api ] }
+        {% if WITH_WORKERS > 0 %}
+        depends_on:
+            - ase-k3s-storage
+        {% endif %}
+
+    {% if WITH_WORKERS > 0 %}
+
+    #   the K3S Node #1
+    {% for i in range(1, WITH_WORKERS + 1) %}
+    ase-k3s-node-{{ i }}:
+        hostname:       node{{ i }}
+        container_name: ase-k3s-node-{{ i }}
+        image:          docker.msg.team/ps/ase-k3s:1.22.4-20211130
+        init:           true
+        command: >-
+            agent
+            --data-dir=/data/k3s
+        restart:        always
+        privileged:     true
+        environment:
+            K3S_URL:                 https://api:6443
+            K3S_NODE_NAME:           node{{ i }}
+            K3S_TOKEN_FILE:          /data-server/k3s/server/token
+        volumes:
+            - ase-k3s-node-{{ i }}:/data
+            - ase-k3s-server:/data-server
+        networks:
+            ase-k3s: { aliases: [ node{{ i }} ] }
+        depends_on:
+            - ase-k3s-server
+            - ase-k3s-storage
+    {% endfor %}
+
+    #   the NFS storage service
+    ase-k3s-storage:
+        hostname:       nfs
+        container_name: ase-k3s-storage
+        image:          docker.msg.team/ps/std-nfs:12-20200111
+        init:           true
+        restart:        always
+        privileged:     true
+        environment:
+            SHARED_DIRECTORY:        /data/k3s
+        volumes:
+            - ase-k3s-storage:/data
+        networks:
+            ase-k3s: { aliases: [ nfs ] }
+
+    {% endif %}
+
+volumes:
+    ase-k3s-server:
+        name: ase-k3s-server
+    {% if WITH_WORKERS > 0 %}
+    {% for i in range(1, WITH_WORKERS + 1) %}
+    ase-k3s-node-{{ i }}:
+        name: ase-k3s-node-{{ i }}
+    {% endfor %}
+    ase-k3s-storage:
+        name: ase-k3s-storage
+    {% endif %}
+
+networks:
+    proxy:
+        name: proxy
+        external: true
+    ase-k3s:
+        name: ase-k3s
+        driver: bridge
+