@rse/nunjucks-cli 1.2.1 → 1.3.0

package/README.md

@@ -14,22 +14,35 @@ 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.
+It optionally can load Nunjucks addons like the ones from the companion
+[Nunjucks Addons](https://github.com/rse/nunjucks-addons) package.
 
-Installation
-------------
+Installation & Usage
+--------------------
 
 ```sh
+# plain functionality
 $ npm install -g @rse/nunjucks-cli
+$ nunjucks [...]
+
+# with addon functionality
+$ npm install -g @rse/nunjucks-cli @rse/nunjucks-addons
+$ nunjucks -e @rse/nunjucks-addons [...]
 ```
 
-Alternatively, instead of globally installing it, let it be automatically installed on-the-fly:
+Alternatively, instead of globally installing it, you can also use it on-the-fly:
 
 ```sh
-$ npx @rse/nunjucks-cli [...]
+# plain functionality
+$ npx --yes @rse/nunjucks-cli [...]
+
+# with addon functionality
+$ npx --yes --package @rse/nunjucks-cli --package @rse/nunjucks-addons -- \
+  nunjucks -e @rse/nunjucks-addons [...]
 ```
 
-Usage
------
+Options
+-------
 
 ```
 $ nunjucks
@@ -52,8 +65,8 @@ $ nunjucks
   load context definition YAML file.
 - `-D`|`--define` `<key>=<value>`:<br/>
   set context definition key/value.
-- `-e`|`--extension` `default|date|eval|jsonpath|pad|sprintf|uuid|<module-name>`:<br/>
-  load Nunjucks JavaScript extension module (built-in or NPM installed).
+- `-e`|`--extension` `<module-name>`:<br/>
+  load Nunjucks JavaScript extension module (installed via NPM).
 - `-o`|`--output` `<output-file>`|`-`:<br/>
   save output file (or stdout).
 - `<input-file>`|`-`:<br/>

package/nunjucks.js

@@ -139,8 +139,6 @@ 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 (extension.match(/^(?:default|date|eval|jsonpath|pad|sprintf|uuid)$/))
-            extension = path.join(__dirname, "nunjucks.d", `${extension}.js`)
         let modpath = null
         try {
             modpath = require.resolve(extension)

package/package.json

@@ -1,7 +1,7 @@
 {
     "name":                       "@rse/nunjucks-cli",
     "publishConfig":              { "access": "public" },
-    "version":                    "1.2.1",
+    "version":                    "1.3.0",
     "description":                "Nunjucks Template Rendering Command-Line Interface",
     "author": {
         "name":                   "Dr. Ralf S. Engelschall",
@@ -9,6 +9,13 @@
         "url":                    "http://engelschall.com"
     },
     "license":                    "MIT",
+    "repository": {
+        "type": "git",
+        "url":  "git://github.com/rse/nunjucks-cli.git"
+    },
+    "bugs": {
+        "url":  "http://github.com/rse/nunjucks-cli/issues"
+    },
     "bin": {
         "nunjucks":               "nunjucks.js"
     },
@@ -16,11 +23,6 @@
         "nunjucks":               "3.2.4",
         "chalk":                  "4.1.0",
         "yargs":                  "17.7.2",
-        "moment":                 "2.29.4",
-        "moment-timezone":        "0.5.43",
-        "jsonpath":               "1.1.1",
-        "sprintfjs":              "1.2.17",
-        "pure-uuid":              "1.7.0",
         "js-yaml":                "4.1.0"
     },
     "devDependencies": {

package/nunjucks.d/date.js

@@ -1,38 +0,0 @@
-/*
-**  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

@@ -1,52 +0,0 @@
-/*
-**  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

@@ -1,29 +0,0 @@
-/*
-**  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.d/jsonpath.js

@@ -1,25 +0,0 @@
-/*
-**  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 jsonpath = require("jsonpath")
-
-module.exports = (env) => {
-    /*  add a "jsonpath" filter  */
-    env.addFilter("jsonpath", (obj, path, count) => {
-        let result
-        const errs = []
-        try {
-            result = jsonpath.query(obj, path, count)
-        }
-        catch (err) {
-            errs.push(err)
-        }
-        if (errs.length)
-            return errs.join("\n")
-        return result
-    })
-}
-

package/nunjucks.d/pad.js

@@ -1,24 +0,0 @@
-/*
-**  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 "pad" formatting filter  */
-    env.addFilter("pad", (input, num, char = " ", toRight = false) => {
-        if (typeof input !== "string") {
-            if (typeof input.toString === "function")
-                input = input.toString()
-            else
-                input = input + ''
-        }
-        let result = input
-        if (result.length < num) {
-            const pad = (new Array(num - result.length + 1)).join(char)
-            result = toRight ? result + pad : pad + result
-        }
-        return result
-    })
-}
-

package/nunjucks.d/sprintf.js

@@ -1,21 +0,0 @@
-/*
-**  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 sprintf = require("sprintfjs")
-
-module.exports = (env) => {
-    /*  add a "sprintf" formatting filter  */
-    env.addFilter("sprintf", (value, format, ...args) => {
-        return sprintf(format, value, ...args)
-    })
-
-    /*  add a "sprintf" global function  */
-    env.addGlobal("sprintf", (format, ...args) => {
-        console.log(format, args)
-        return sprintf(format, ...args)
-    })
-}
-

package/nunjucks.d/uuid.js

@@ -1,14 +0,0 @@
-/*
-**  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 UUID = require("pure-uuid")
-
-module.exports = (env) => {
-    env.addGlobal("uuid", (...args) => {
-        return (new UUID(...args)).format()
-    })
-}
-

package/sample.txt

@@ -1,153 +0,0 @@
-##
-##  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
-