@rse/nunjucks-cli 2.1.0 → 2.2.1

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 ChangeLog
 =========
 
+2.2.1 (2025-12-26)
+------------------
+
+- CLEANUP: cleanups
+
+2.2.0 (2025-12-26)
+------------------
+
+- IMPROVEMENT: finally fix SEA packaging
+- IMPROVEMENT: provide Docker container publishing
+- CLEANUP: cleanup distribution archive packaging
+
 2.1.0 (2025-12-26)
 ------------------
 

package/Dockerfile

@@ -3,7 +3,7 @@
 ##
 
 #   build arguments (early)
-ARG         IMAGE_PREFIX=docker.io/engelschall/
+ARG         IMAGE_PREFIX=ghcr.io/rse/
 ARG         IMAGE_NAME=nunjucks-cli
 ARG         IMAGE_VERSION=2.1.0
 ARG         IMAGE_RELEASE=20251226
@@ -12,6 +12,10 @@ ARG         IMAGE_ALIAS=latest
 #   derive image from a certain base image
 FROM        node:24-alpine3.23
 
+#   link to Github repository
+LABEL       org.opencontainers.image.source=https://github.com/rse/nunjucks-cli
+LABEL       org.opencontainers.image.description="Nunjucks Template Rendering Command-Line Interface"
+
 #   add additional build tools
 RUN         apk update && \
             apk upgrade
@@ -27,9 +31,7 @@ WORKDIR     /app
 ENV         HOME=/app
 
 #   install tool
-RUN         npm install -g \
-                @rse/nunjucks-cli@1.5.2 \
-                @rse/nunjucks-addons@1.0.8
+RUN         npm install -g @rse/nunjucks-cli
 
 #   cleanup Alpine
 RUN         rm -rf /var/cache/apk/*

package/README.md

@@ -48,6 +48,14 @@ $ npx --yes --package @rse/nunjucks-cli --package @rse/nunjucks-addons -- \
   nunjucks -e @rse/nunjucks-addons [...]
 ```
 
+Furthermore, instead of using NPM at all, you can also use Docker (at
+least as long as you are working with stdin/stdout or perform the
+corresponding bind-mounts):
+
+```sh
+$ docker run -i --rm ghcr.io/rse/nunjucks-cli [...] -
+```
+
 Command-Line Interface (CLI)
 ----------------------------
 
@@ -57,6 +65,8 @@ Short excerpt of the CLI options and arguments from the companion [Unix manpage]
 $ nunjucks
   [-h|--help]
   [-V|--version]
+  [-e|--env <env-file>]
+  [-E|--envs]
   [-c|--config <config-file>]
   [-C|--option <key>=<value>]
   [-d|--defines <context-file>]
@@ -70,6 +80,12 @@ $ nunjucks
   Show usage help.
 - `-V`|`--version`:<br/>
   Show program version information.
+- `-e`|`--env` *env-file*:<br/>
+  Load environment file with key/value definitions.
+  These can later be accessed with the global `env` variable.
+- [`-E`|`--envs`]:<br/>
+  Automatically load environment files with key/value definitions
+  from all `.env` files in current and all parent directories.
 - `-c`|`--config` `<config-file>`:<br/>
   Load Nunjucks configuration YAML file.
 - `-C`|`--option` `<key>=<value>`:<br/>

package/dst-stage1/nunjucks.js

@@ -0,0 +1,213 @@
+#!/usr/bin/env node
+/*
+**  nunjucks -- Nunjucks Template Rendering Command-Line Interface
+**  Copyright (c) 2019-2025 Dr. Ralf S. Engelschall <http://engelschall.com>
+**  Licensed under MIT <http://spdx.org/licenses/MIT.html>
+*/
+/*  built-in requirements  */
+import fs from "node:fs";
+import path from "node:path";
+import { createRequire } from "node:module";
+/*  external requirements  */
+import { Command } from "commander";
+import chalk from "chalk";
+import jsYAML from "js-yaml";
+import nunjucks from "nunjucks";
+import deepmerge from "deepmerge";
+import dotenvx from "@dotenvx/dotenvx";
+import * as findup from "find-up";
+/*  internal requirements  */
+import pkg from "./package.json" with { type: "json" };
+(async () => {
+    /*  load my own information  */
+    const my = pkg;
+    /*  parse command-line arguments  */
+    const program = new Command();
+    const reduceArray = (v, l) => l.concat([v]);
+    program.name("nunjucks")
+        .description("Nunjucks Template Rendering Command-Line Interface")
+        .showHelpAfterError("hint: use option --help for usage information")
+        .option("-h, --help", "show usage help", false)
+        .option("-V, --version", "show program version information", false)
+        .option("-e, --env <env-file>", "load environment key/value file", reduceArray, [])
+        .option("-E, --envs", "load all environment key/value files", false)
+        .option("-c, --config <config-file>", "load Nunjucks configuration YAML file", "")
+        .option("-C, --option <key>=<value>", "set Nunjucks configuration option", reduceArray, [])
+        .option("-d, --defines <context-file>", "load context definition YAML file", reduceArray, [])
+        .option("-D, --define <key>=<value>", "set context definition key/value", reduceArray, [])
+        .option("-p, --plugin <module-name>", "load Nunjucks JavaScript plugin module", reduceArray, [])
+        .option("-o, --output <output-file>", "save output file", "-")
+        .argument("[<input-file>]", "input file");
+    program.parse(process.argv);
+    const argv = {
+        ...program.opts(),
+        _: program.args
+    };
+    /*  handle special help request  */
+    if (argv.help) {
+        console.log(program.helpInformation());
+        console.log("Example:\n  $ echo \"Hello, {{ who }}!\" | nunjucks -Dwho=World -\n");
+        process.exit(0);
+    }
+    /*  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-2025 ${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: invalid number of arguments (zero or one input file expected)"));
+        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, null);
+            }
+            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 = {};
+    for (const define of argv.defines) {
+        try {
+            context = deepmerge(context, jsYAML.load(fs.readFileSync(define, { encoding: "utf8" })));
+        }
+        catch (ex) {
+            console.error(chalk.red(`nunjucks: ERROR: failed to load context YAML file: ${ex.toString()}`));
+            process.exit(1);
+        }
+    }
+    /*  load environment variables from all default files  */
+    if (argv.envs) {
+        const files = findup.findUpMultipleSync(".env");
+        if (files.length > 0)
+            dotenvx.config({ path: files, quiet: true });
+    }
+    /*  load environment variables from environment files  */
+    if (argv.env.length > 0) {
+        for (const env of argv.env) {
+            if (!fs.existsSync(env)) {
+                console.error(chalk.red(`nunjucks: ERROR: environment file not found: "${env}"`));
+                process.exit(1);
+            }
+        }
+        dotenvx.config({ path: argv.env, quiet: true });
+    }
+    /*  expose environment variables to template  */
+    context.env = process.env;
+    /*  add context defines  */
+    argv.define.forEach((define) => {
+        const match = define.match(/^([^=]+)(?:=(.*))?$/);
+        if (!match)
+            return;
+        let [, key, val] = match;
+        if (!key)
+            return;
+        if (val === undefined)
+            val = "true";
+        context[key] = val;
+    });
+    /*  determine Nunjucks options  */
+    let options = {};
+    if (argv.config) {
+        try {
+            options = jsYAML.load(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);
+        }
+    }
+    if (argv.option.length > 0)
+        options = Object.assign(options, argv.option);
+    options = {
+        autoescape: false,
+        throwOnUndefined: false,
+        trimBlocks: true,
+        lstripBlocks: true,
+        watch: false,
+        noCache: true,
+        ...options
+    };
+    /*  configure environment  */
+    const env = nunjucks.configure(inputFile, options);
+    /*  load external plugin modules  */
+    for (const plugin of argv.plugin) {
+        let modpath = path.resolve(plugin);
+        if (!fs.existsSync(modpath)) {
+            try {
+                const require = createRequire(import.meta.url);
+                modpath = require.resolve(plugin);
+            }
+            catch (_ex) {
+                modpath = null;
+            }
+        }
+        if (modpath === null) {
+            console.error(chalk.red(`nunjucks: ERROR: failed to find plugin module: ${plugin}`));
+            process.exit(1);
+        }
+        /*  dynamically import the module  */
+        let mod;
+        try {
+            mod = await import(modpath);
+            /*  handle both default and named exports  */
+            mod = mod.default ?? mod;
+        }
+        catch (ex) {
+            console.error(chalk.red(`nunjucks: ERROR: failed to load plugin module: ${ex.toString()}`));
+            process.exit(1);
+        }
+        if (!(mod !== null && typeof mod === "function")) {
+            console.error(chalk.red(`nunjucks: ERROR: failed to call plugin file: "${modpath}"`));
+            process.exit(1);
+        }
+        mod(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);
+})().catch((err) => {
+    console.error(chalk.red(`nunjucks: ERROR: ${err.toString()}`));
+});

package/dst-stage1/package.json

@@ -0,0 +1,65 @@
+{
+    "name": "@rse/nunjucks-cli",
+    "publishConfig": { "access": "public" },
+    "version": "2.2.0",
+    "stdver": "2.2.0-GA",
+    "description": "Nunjucks Template Rendering Command-Line Interface",
+    "author": {
+        "name": "Dr. Ralf S. Engelschall",
+        "email": "rse@engelschall.com",
+        "url": "http://engelschall.com"
+    },
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/rse/nunjucks-cli.git"
+    },
+    "bugs": {
+        "url": "http://github.com/rse/nunjucks-cli/issues"
+    },
+    "bin": {
+        "nunjucks": "dst-stage1/nunjucks.js"
+    },
+    "man": "dst-stage1/nunjucks.1",
+    "type": "module",
+    "engines": {
+        "node": ">=22.18.0"
+    },
+    "dependencies": {
+        "nunjucks": "3.2.4",
+        "chalk": "5.6.2",
+        "commander": "14.0.2",
+        "js-yaml": "4.1.1",
+        "deepmerge": "4.3.1",
+        "@dotenvx/dotenvx": "1.51.2",
+        "find-up": "8.0.0"
+    },
+    "devDependencies": {
+        "eslint": "9.39.2",
+        "@eslint/js": "9.39.2",
+        "neostandard": "0.12.2",
+        "eslint-plugin-promise": "7.2.1",
+        "eslint-plugin-import": "2.32.0",
+        "eslint-plugin-n": "17.23.1",
+        "globals": "16.5.0",
+        "remark-cli": "12.0.1",
+        "remark": "15.0.1",
+        "remark-man": "9.0.0",
+        "typescript": "5.9.3",
+        "typescript-eslint": "8.50.1",
+        "@rse/stx": "1.1.4",
+        "shx": "0.4.0",
+        "@yao-pkg/pkg": "6.11.0",
+        "vite": "7.3.0",
+        "@wroud/vite-plugin-tsc": "0.12.2",
+        "rollup-plugin-node-externals": "8.1.2",
+        "terser": "5.44.1",
+        "@types/node": "25.0.3",
+        "@types/js-yaml": "4.0.9",
+        "@types/nunjucks": "3.2.6"
+    },
+    "scripts": {
+        "start": "stx -v4 -c stx.conf",
+        "test": "npm start test"
+    }
+}

package/dst-stage1/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../nunjucks.ts"],"version":"5.9.3"}