@rse/nunjucks-cli 2.2.0 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -0
- package/dst-stage1/nunjucks.js +213 -0
- package/dst-stage1/nunjucks.man +51 -0
- package/dst-stage1/package.json +65 -0
- package/dst-stage1/tsconfig.tsbuildinfo +1 -0
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/*
|
|
3
|
+
** nunjucks -- Nunjucks Template Rendering Command-Line Interface
|
|
4
|
+
** Copyright (c) 2019-2025 Dr. Ralf S. Engelschall <http://engelschall.com>
|
|
5
|
+
** Licensed under MIT <http://spdx.org/licenses/MIT.html>
|
|
6
|
+
*/
|
|
7
|
+
/* built-in requirements */
|
|
8
|
+
import fs from "node:fs";
|
|
9
|
+
import path from "node:path";
|
|
10
|
+
import { createRequire } from "node:module";
|
|
11
|
+
/* external requirements */
|
|
12
|
+
import { Command } from "commander";
|
|
13
|
+
import chalk from "chalk";
|
|
14
|
+
import jsYAML from "js-yaml";
|
|
15
|
+
import nunjucks from "nunjucks";
|
|
16
|
+
import deepmerge from "deepmerge";
|
|
17
|
+
import dotenvx from "@dotenvx/dotenvx";
|
|
18
|
+
import * as findup from "find-up";
|
|
19
|
+
/* internal requirements */
|
|
20
|
+
import pkg from "./package.json" with { type: "json" };
|
|
21
|
+
(async () => {
|
|
22
|
+
/* load my own information */
|
|
23
|
+
const my = pkg;
|
|
24
|
+
/* parse command-line arguments */
|
|
25
|
+
const program = new Command();
|
|
26
|
+
const reduceArray = (v, l) => l.concat([v]);
|
|
27
|
+
program.name("nunjucks")
|
|
28
|
+
.description("Nunjucks Template Rendering Command-Line Interface")
|
|
29
|
+
.showHelpAfterError("hint: use option --help for usage information")
|
|
30
|
+
.option("-h, --help", "show usage help", false)
|
|
31
|
+
.option("-V, --version", "show program version information", false)
|
|
32
|
+
.option("-e, --env <env-file>", "load environment key/value file", reduceArray, [])
|
|
33
|
+
.option("-E, --envs", "load all environment key/value files", false)
|
|
34
|
+
.option("-c, --config <config-file>", "load Nunjucks configuration YAML file", "")
|
|
35
|
+
.option("-C, --option <key>=<value>", "set Nunjucks configuration option", reduceArray, [])
|
|
36
|
+
.option("-d, --defines <context-file>", "load context definition YAML file", reduceArray, [])
|
|
37
|
+
.option("-D, --define <key>=<value>", "set context definition key/value", reduceArray, [])
|
|
38
|
+
.option("-p, --plugin <module-name>", "load Nunjucks JavaScript plugin module", reduceArray, [])
|
|
39
|
+
.option("-o, --output <output-file>", "save output file", "-")
|
|
40
|
+
.argument("[<input-file>]", "input file");
|
|
41
|
+
program.parse(process.argv);
|
|
42
|
+
const argv = {
|
|
43
|
+
...program.opts(),
|
|
44
|
+
_: program.args
|
|
45
|
+
};
|
|
46
|
+
/* handle special help request */
|
|
47
|
+
if (argv.help) {
|
|
48
|
+
console.log(program.helpInformation());
|
|
49
|
+
console.log("Example:\n $ echo \"Hello, {{ who }}!\" | nunjucks -Dwho=World -\n");
|
|
50
|
+
process.exit(0);
|
|
51
|
+
}
|
|
52
|
+
/* handle special version request */
|
|
53
|
+
if (argv.version) {
|
|
54
|
+
console.log(`${my.name} ${my.version} (Node.js ${process.versions.node}, Nunjucks: ${my.dependencies.nunjucks})`);
|
|
55
|
+
console.log(`${my.description}`);
|
|
56
|
+
console.log(`Copyright (c) 2019-2025 ${my.author.name} <${my.author.url}>`);
|
|
57
|
+
console.log(`Licensed under ${my.license} <http://spdx.org/licenses/${my.license}.html>`);
|
|
58
|
+
process.exit(0);
|
|
59
|
+
}
|
|
60
|
+
/* read input file */
|
|
61
|
+
let input = "";
|
|
62
|
+
if (argv._.length > 1) {
|
|
63
|
+
console.error(chalk.red("nunjucks: ERROR: invalid number of arguments (zero or one input file expected)"));
|
|
64
|
+
process.exit(1);
|
|
65
|
+
}
|
|
66
|
+
let inputFile = argv._[0] ?? "-";
|
|
67
|
+
if (inputFile === "-") {
|
|
68
|
+
inputFile = "<stdin>";
|
|
69
|
+
process.stdin.setEncoding("utf-8");
|
|
70
|
+
const BUFSIZE = 256;
|
|
71
|
+
const buf = Buffer.alloc(BUFSIZE);
|
|
72
|
+
while (true) {
|
|
73
|
+
let bytesRead = 0;
|
|
74
|
+
try {
|
|
75
|
+
bytesRead = fs.readSync(process.stdin.fd, buf, 0, BUFSIZE, null);
|
|
76
|
+
}
|
|
77
|
+
catch (ex) {
|
|
78
|
+
if (ex.code === "EAGAIN")
|
|
79
|
+
continue;
|
|
80
|
+
else if (ex.code === "EOF")
|
|
81
|
+
break;
|
|
82
|
+
else
|
|
83
|
+
throw ex;
|
|
84
|
+
}
|
|
85
|
+
if (bytesRead === 0)
|
|
86
|
+
break;
|
|
87
|
+
input += buf.toString("utf8", 0, bytesRead);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
else {
|
|
91
|
+
if (!fs.existsSync(inputFile)) {
|
|
92
|
+
console.error(chalk.red(`nunjucks: ERROR: failed to find input file: "${inputFile}"`));
|
|
93
|
+
process.exit(1);
|
|
94
|
+
}
|
|
95
|
+
input = fs.readFileSync(inputFile, { encoding: "utf8" });
|
|
96
|
+
}
|
|
97
|
+
/* provide context variables for template */
|
|
98
|
+
let context = {};
|
|
99
|
+
for (const define of argv.defines) {
|
|
100
|
+
try {
|
|
101
|
+
context = deepmerge(context, jsYAML.load(fs.readFileSync(define, { encoding: "utf8" })));
|
|
102
|
+
}
|
|
103
|
+
catch (ex) {
|
|
104
|
+
console.error(chalk.red(`nunjucks: ERROR: failed to load context YAML file: ${ex.toString()}`));
|
|
105
|
+
process.exit(1);
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
/* load environment variables from all default files */
|
|
109
|
+
if (argv.envs) {
|
|
110
|
+
const files = findup.findUpMultipleSync(".env");
|
|
111
|
+
if (files.length > 0)
|
|
112
|
+
dotenvx.config({ path: files, quiet: true });
|
|
113
|
+
}
|
|
114
|
+
/* load environment variables from environment files */
|
|
115
|
+
if (argv.env.length > 0) {
|
|
116
|
+
for (const env of argv.env) {
|
|
117
|
+
if (!fs.existsSync(env)) {
|
|
118
|
+
console.error(chalk.red(`nunjucks: ERROR: environment file not found: "${env}"`));
|
|
119
|
+
process.exit(1);
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
dotenvx.config({ path: argv.env, quiet: true });
|
|
123
|
+
}
|
|
124
|
+
/* expose environment variables to template */
|
|
125
|
+
context.env = process.env;
|
|
126
|
+
/* add context defines */
|
|
127
|
+
argv.define.forEach((define) => {
|
|
128
|
+
const match = define.match(/^([^=]+)(?:=(.*))?$/);
|
|
129
|
+
if (!match)
|
|
130
|
+
return;
|
|
131
|
+
let [, key, val] = match;
|
|
132
|
+
if (!key)
|
|
133
|
+
return;
|
|
134
|
+
if (val === undefined)
|
|
135
|
+
val = "true";
|
|
136
|
+
context[key] = val;
|
|
137
|
+
});
|
|
138
|
+
/* determine Nunjucks options */
|
|
139
|
+
let options = {};
|
|
140
|
+
if (argv.config) {
|
|
141
|
+
try {
|
|
142
|
+
options = jsYAML.load(fs.readFileSync(argv.config, { encoding: "utf8" }));
|
|
143
|
+
}
|
|
144
|
+
catch (ex) {
|
|
145
|
+
console.error(chalk.red(`nunjucks: ERROR: failed to load options YAML file: ${ex.toString()}`));
|
|
146
|
+
process.exit(1);
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
if (argv.option.length > 0)
|
|
150
|
+
options = Object.assign(options, argv.option);
|
|
151
|
+
options = {
|
|
152
|
+
autoescape: false,
|
|
153
|
+
throwOnUndefined: false,
|
|
154
|
+
trimBlocks: true,
|
|
155
|
+
lstripBlocks: true,
|
|
156
|
+
watch: false,
|
|
157
|
+
noCache: true,
|
|
158
|
+
...options
|
|
159
|
+
};
|
|
160
|
+
/* configure environment */
|
|
161
|
+
const env = nunjucks.configure(inputFile, options);
|
|
162
|
+
/* load external plugin modules */
|
|
163
|
+
for (const plugin of argv.plugin) {
|
|
164
|
+
let modpath = path.resolve(plugin);
|
|
165
|
+
if (!fs.existsSync(modpath)) {
|
|
166
|
+
try {
|
|
167
|
+
const require = createRequire(import.meta.url);
|
|
168
|
+
modpath = require.resolve(plugin);
|
|
169
|
+
}
|
|
170
|
+
catch (_ex) {
|
|
171
|
+
modpath = null;
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
if (modpath === null) {
|
|
175
|
+
console.error(chalk.red(`nunjucks: ERROR: failed to find plugin module: ${plugin}`));
|
|
176
|
+
process.exit(1);
|
|
177
|
+
}
|
|
178
|
+
/* dynamically import the module */
|
|
179
|
+
let mod;
|
|
180
|
+
try {
|
|
181
|
+
mod = await import(modpath);
|
|
182
|
+
/* handle both default and named exports */
|
|
183
|
+
mod = mod.default ?? mod;
|
|
184
|
+
}
|
|
185
|
+
catch (ex) {
|
|
186
|
+
console.error(chalk.red(`nunjucks: ERROR: failed to load plugin module: ${ex.toString()}`));
|
|
187
|
+
process.exit(1);
|
|
188
|
+
}
|
|
189
|
+
if (!(mod !== null && typeof mod === "function")) {
|
|
190
|
+
console.error(chalk.red(`nunjucks: ERROR: failed to call plugin file: "${modpath}"`));
|
|
191
|
+
process.exit(1);
|
|
192
|
+
}
|
|
193
|
+
mod(env);
|
|
194
|
+
}
|
|
195
|
+
/* render Nunjucks template */
|
|
196
|
+
let output;
|
|
197
|
+
try {
|
|
198
|
+
output = env.renderString(input, context);
|
|
199
|
+
}
|
|
200
|
+
catch (ex) {
|
|
201
|
+
console.error(chalk.red(`nunjucks: ERROR: failed to render template: ${ex.toString()}`));
|
|
202
|
+
process.exit(1);
|
|
203
|
+
}
|
|
204
|
+
/* write output */
|
|
205
|
+
if (argv.output === "-")
|
|
206
|
+
process.stdout.write(output);
|
|
207
|
+
else
|
|
208
|
+
fs.writeFileSync(argv.output, output, { encoding: "utf8" });
|
|
209
|
+
/* die gracefully */
|
|
210
|
+
process.exit(0);
|
|
211
|
+
})().catch((err) => {
|
|
212
|
+
console.error(chalk.red(`nunjucks: ERROR: ${err.toString()}`));
|
|
213
|
+
});
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
.TH "NUNJUCKS" "1" "December 2025" "" ""
|
|
2
|
+
.SH "NAME"
|
|
3
|
+
\fBnunjucks\fR - Template Rendering Engine
|
|
4
|
+
.SH "SYNOPSIS"
|
|
5
|
+
.P
|
|
6
|
+
\fBnunjucks\fR \[lB]\fB-h\fR|\fB--help\fR\[rB] \[lB]\fB-V\fR|\fB--version\fR\[rB] \[lB]\fB-e\fR|\fB--env\fR \fIenv-file\fR\[rB] \[lB]\fB-E\fR|\fB--envs\fR\[rB] \[lB]\fB-c\fR|\fB--config\fR \fIconfig-file\fR\[rB] \[lB]\fB-C\fR|\fB--option\fR \fIkey\fR=\fIvalue\fR\[rB] \[lB]\fB-d\fR|\fB--defines\fR \fIcontext-file\fR\[rB] \[lB]\fB-D\fR|\fB--define\fR \fIkey\fR=\fIvalue\fR\[rB] \[lB]\fB-p\fR|\fB--plugin\fR \fImodule-name\fR\[rB] \[lB]\fB-o\fR|\fB--output\fR \fIoutput-file\fR|\fB-\fR\[rB] \[lB]\fIinput-file\fR|\fB-\fR\[rB]
|
|
7
|
+
.SH "DESCRIPTION"
|
|
8
|
+
.P
|
|
9
|
+
\fBnunjucks\fR(1) is a small command-line utility to render templates with the rich and powerful templating language \fBMozilla Nunjucks\fR \fI\(lahttps://mozilla.github.io/nunjucks/\(ra\fR. 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 \fBNunjucks Addons\fR \fI\(lahttps://github.com/rse/nunjucks-addons\(ra\fR package.
|
|
10
|
+
.SH "OPTIONS"
|
|
11
|
+
.P
|
|
12
|
+
The following top-level options and arguments exist:
|
|
13
|
+
.RS 0
|
|
14
|
+
.IP \(bu 4
|
|
15
|
+
\[lB]\fB-h\fR|\fB--help\fR\[rB]: Show usage help.
|
|
16
|
+
.IP \(bu 4
|
|
17
|
+
\[lB]\fB-V\fR|\fB--version\fR\[rB]: Show program version information.
|
|
18
|
+
.IP \(bu 4
|
|
19
|
+
\[lB]\fB-e\fR|\fB--env\fR \fIenv-file\fR\[rB]: Load environment file with key/value definitions. These can later be accessed with the global \fBenv\fR variable.
|
|
20
|
+
.IP \(bu 4
|
|
21
|
+
\[lB]\fB-E\fR|\fB--envs\fR\[rB]: Automatically load environment files with key/value definitions from all \fB.env\fR files in current and all parent directories.
|
|
22
|
+
.IP \(bu 4
|
|
23
|
+
\[lB]\fB-c\fR|\fB--config\fR \fIconfig-file\fR\[rB]: Load Nunjucks configuration YAML file.
|
|
24
|
+
.IP \(bu 4
|
|
25
|
+
\[lB]\fB-C\fR|\fB--option\fR \fIkey\fR=\fIvalue\fR\[rB]: Set Nunjucks configuration option.
|
|
26
|
+
.IP \(bu 4
|
|
27
|
+
\[lB]\fB-d\fR|\fB--defines\fR \fIcontext-file\fR\[rB]: Load context definition YAML file. Can occur multiple times.
|
|
28
|
+
.IP \(bu 4
|
|
29
|
+
\[lB]\fB-D\fR|\fB--define\fR \fIkey\fR=\fIvalue\fR\[rB]: Set context definition key/value. Can occur multiple times.
|
|
30
|
+
.IP \(bu 4
|
|
31
|
+
\[lB]\fB-p\fR|\fB--plugin\fR \fImodule-name\fR\[rB]: Load Nunjucks JavaScript plugin module (installed via NPM).
|
|
32
|
+
.IP \(bu 4
|
|
33
|
+
\[lB]\fB-o\fR|\fB--output\fR \fIoutput-file\fR|\fB-\fR\[rB]: Save output file (or stdout).
|
|
34
|
+
.IP \(bu 4
|
|
35
|
+
\[lB]\fB<input-file>\fR|\fB-\fR\[rB]: Load input file (or stdin).
|
|
36
|
+
.RE 0
|
|
37
|
+
|
|
38
|
+
.SH "EXAMPLE"
|
|
39
|
+
.P
|
|
40
|
+
.RS 2
|
|
41
|
+
.nf
|
|
42
|
+
$ echo "Hello, {{who}}!" | nunjucks -D who=world -
|
|
43
|
+
Hello, world!
|
|
44
|
+
.fi
|
|
45
|
+
.RE
|
|
46
|
+
.SH "HISTORY"
|
|
47
|
+
.P
|
|
48
|
+
The \fBnunjucks\fR(1) utility was developed in August 2023 for being able to easily generate multiple configuration files for a complex \fIDocker-Compose\fR based setup.
|
|
49
|
+
.SH "AUTHOR"
|
|
50
|
+
.P
|
|
51
|
+
Dr. Ralf S. Engelschall \fI\(larse@engelschall.com\(ra\fR
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@rse/nunjucks-cli",
|
|
3
|
+
"publishConfig": { "access": "public" },
|
|
4
|
+
"version": "2.2.0",
|
|
5
|
+
"stdver": "2.2.0-GA",
|
|
6
|
+
"description": "Nunjucks Template Rendering Command-Line Interface",
|
|
7
|
+
"author": {
|
|
8
|
+
"name": "Dr. Ralf S. Engelschall",
|
|
9
|
+
"email": "rse@engelschall.com",
|
|
10
|
+
"url": "http://engelschall.com"
|
|
11
|
+
},
|
|
12
|
+
"license": "MIT",
|
|
13
|
+
"repository": {
|
|
14
|
+
"type": "git",
|
|
15
|
+
"url": "git+https://github.com/rse/nunjucks-cli.git"
|
|
16
|
+
},
|
|
17
|
+
"bugs": {
|
|
18
|
+
"url": "http://github.com/rse/nunjucks-cli/issues"
|
|
19
|
+
},
|
|
20
|
+
"bin": {
|
|
21
|
+
"nunjucks": "dst-stage1/nunjucks.js"
|
|
22
|
+
},
|
|
23
|
+
"man": "dst-stage1/nunjucks.1",
|
|
24
|
+
"type": "module",
|
|
25
|
+
"engines": {
|
|
26
|
+
"node": ">=22.18.0"
|
|
27
|
+
},
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"nunjucks": "3.2.4",
|
|
30
|
+
"chalk": "5.6.2",
|
|
31
|
+
"commander": "14.0.2",
|
|
32
|
+
"js-yaml": "4.1.1",
|
|
33
|
+
"deepmerge": "4.3.1",
|
|
34
|
+
"@dotenvx/dotenvx": "1.51.2",
|
|
35
|
+
"find-up": "8.0.0"
|
|
36
|
+
},
|
|
37
|
+
"devDependencies": {
|
|
38
|
+
"eslint": "9.39.2",
|
|
39
|
+
"@eslint/js": "9.39.2",
|
|
40
|
+
"neostandard": "0.12.2",
|
|
41
|
+
"eslint-plugin-promise": "7.2.1",
|
|
42
|
+
"eslint-plugin-import": "2.32.0",
|
|
43
|
+
"eslint-plugin-n": "17.23.1",
|
|
44
|
+
"globals": "16.5.0",
|
|
45
|
+
"remark-cli": "12.0.1",
|
|
46
|
+
"remark": "15.0.1",
|
|
47
|
+
"remark-man": "9.0.0",
|
|
48
|
+
"typescript": "5.9.3",
|
|
49
|
+
"typescript-eslint": "8.50.1",
|
|
50
|
+
"@rse/stx": "1.1.4",
|
|
51
|
+
"shx": "0.4.0",
|
|
52
|
+
"@yao-pkg/pkg": "6.11.0",
|
|
53
|
+
"vite": "7.3.0",
|
|
54
|
+
"@wroud/vite-plugin-tsc": "0.12.2",
|
|
55
|
+
"rollup-plugin-node-externals": "8.1.2",
|
|
56
|
+
"terser": "5.44.1",
|
|
57
|
+
"@types/node": "25.0.3",
|
|
58
|
+
"@types/js-yaml": "4.0.9",
|
|
59
|
+
"@types/nunjucks": "3.2.6"
|
|
60
|
+
},
|
|
61
|
+
"scripts": {
|
|
62
|
+
"start": "stx -v4 -c stx.conf",
|
|
63
|
+
"test": "npm start test"
|
|
64
|
+
}
|
|
65
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"root":["../nunjucks.ts"],"version":"5.9.3"}
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rse/nunjucks-cli",
|
|
3
3
|
"publishConfig": { "access": "public" },
|
|
4
|
-
"version": "2.2.
|
|
5
|
-
"stdver": "2.2.
|
|
4
|
+
"version": "2.2.1",
|
|
5
|
+
"stdver": "2.2.1-GA",
|
|
6
6
|
"description": "Nunjucks Template Rendering Command-Line Interface",
|
|
7
7
|
"author": {
|
|
8
8
|
"name": "Dr. Ralf S. Engelschall",
|