@rse/nunjucks-cli 2.0.0 → 2.0.1

package/nunjucks.js

@@ -0,0 +1,187 @@
+#!/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";
+/*  load my own information  */
+const my = JSON.parse(await fs.promises.readFile(new URL("./package.json", import.meta.url), "utf-8"));
+/*  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("-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("-e, --extension <module-name>", "load Nunjucks JavaScript extension 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);
+    }
+}
+/*  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 extension files  */
+for (const extension of argv.extension) {
+    let modpath = path.resolve(extension);
+    if (!fs.existsSync(modpath)) {
+        try {
+            const require = createRequire(import.meta.url);
+            modpath = require.resolve(extension);
+        }
+        catch (_ex) {
+            modpath = null;
+        }
+    }
+    if (modpath === null) {
+        console.error(chalk.red(`nunjucks: ERROR: failed to find extension module: ${extension}`));
+        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 extension module: ${ex.toString()}`));
+        process.exit(1);
+    }
+    if (!(mod !== null && typeof mod === "function")) {
+        console.error(chalk.red(`nunjucks: ERROR: failed to call extension 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);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name":                       "@rse/nunjucks-cli",
     "publishConfig":              { "access": "public" },
-    "version":                    "2.0.0",
+    "version":                    "2.0.1",
     "stdver":                     "2.0.0-GA",
     "description":                "Nunjucks Template Rendering Command-Line Interface",
     "author": {
@@ -18,7 +18,7 @@
         "url":                    "http://github.com/rse/nunjucks-cli/issues"
     },
     "bin": {
-        "nunjucks":               "nunjucks.ts"
+        "nunjucks":               "nunjucks.js"
     },
     "man":                        "nunjucks.1",
     "type":                       "module",

package/stx.conf

@@ -7,6 +7,10 @@
 #   static code analysis
 lint
     eslint --config eslint.mjs nunjucks.ts && \
+    tsc --noEmit --project tsconfig.json
+
+#   build JavaScript from TypeScript
+build
     tsc --project tsconfig.json
 
 #   build manual page
@@ -14,20 +18,20 @@ man
     remark --quiet --use remark-man --output nunjucks.1 nunjucks.md
 
 #   execute simple smole test
-test
-    echo 'Hello, {{who}}!' | node nunjucks.ts -D who=world -
+test : build
+    echo 'Hello, {{who}}!' | node nunjucks.js -D who=world -
 
 #   build all-in-one packages
 build:pkg [hostname=en4.*]
 
 #   package distribution archives
-package : build:pkg [hostname=en4.*]
+package : build build:pkg [hostname=en4.*]
     VERSION=`sed -n '/"version":/ s/.*: *"\(.*\)".*/\1/p' package.json` && \
     targets="node24-linux-x64,node24-linux-arm64" && \
     targets="$targets,node24-win-x64,node24-win-arm64" && \
     targets="$targets,node24-macos-x64,node24-macos-arm64" && \
     sed -e 's;@rse/nunjucks-cli;nunjucks;' <package.json >nunjucks.json && \
-    pkg --sea --public -c nunjucks.json -t "$targets" nunjucks.ts && \
+    pkg --sea --public -c nunjucks.json -t "$targets" nunjucks.js && \
     rm -f nunjucks.json && \
     shx mv nunjucks-linux-x64     nunjucks-lnx-x64     && \
     shx mv nunjucks-linux-arm64   nunjucks-lnx-a64     && \
@@ -42,7 +46,7 @@ package : build:pkg [hostname=en4.*]
     mkdir -p nunjucks-$VERSION-mac-a64/ && \
     mkdir -p nunjucks-$VERSION-lnx-x64/ && \
     mkdir -p nunjucks-$VERSION-lnx-a64/ && \
-    cp -p nunjucks.ts             nunjucks-$VERSION/nunjucks.ts && \
+    cp -p nunjucks.js             nunjucks-$VERSION/nunjucks.js && \
     cp -p nunjucks-win-x64.exe    nunjucks-$VERSION-win-x64/nunjucks.exe && \
     cp -p nunjucks-win-a64.exe    nunjucks-$VERSION-win-a64/nunjucks.exe && \
     cp -p nunjucks-mac-x64        nunjucks-$VERSION-mac-x64/nunjucks && \
@@ -81,6 +85,7 @@ publish : package [hostname=en4.*]
 
 #   remove all generated artifacts
 clean
+    shx rm -f nunjucks.js && \
     shx rm -rf nunjucks-*.zip
 
 #   remove all generated artifacts

package/tsconfig.json

@@ -5,13 +5,13 @@
         "lib":                              [ "ES2024" ],
         "moduleResolution":                 "node16",
         "resolveJsonModule":                true,
-        "allowImportingTsExtensions":       true,
+        "declaration":                      false,
         "allowSyntheticDefaultImports":     true,
         "esModuleInterop":                  true,
         "forceConsistentCasingInFileNames": true,
         "strict":                           true,
         "skipLibCheck":                     true,
-        "noEmit":                           true,
+        "outDir":                           ".",
         "types":                            [ "node" ]
     },
     "include": [