@rse/nunjucks-cli 2.1.0 → 2.2.0

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 CHANGED
@@ -2,6 +2,13 @@
2
2
  ChangeLog
3
3
  =========
4
4
 
5
+ 2.2.0 (2025-12-26)
6
+ ------------------
7
+
8
+ - IMPROVEMENT: finally fix SEA packaging
9
+ - IMPROVEMENT: provide Docker container publishing
10
+ - CLEANUP: cleanup distribution archive packaging
11
+
5
12
  2.1.0 (2025-12-26)
6
13
  ------------------
7
14
 
package/Dockerfile CHANGED
@@ -3,7 +3,7 @@
3
3
  ##
4
4
 
5
5
  # build arguments (early)
6
- ARG IMAGE_PREFIX=docker.io/engelschall/
6
+ ARG IMAGE_PREFIX=ghcr.io/rse/
7
7
  ARG IMAGE_NAME=nunjucks-cli
8
8
  ARG IMAGE_VERSION=2.1.0
9
9
  ARG IMAGE_RELEASE=20251226
@@ -12,6 +12,10 @@ ARG IMAGE_ALIAS=latest
12
12
  # derive image from a certain base image
13
13
  FROM node:24-alpine3.23
14
14
 
15
+ # link to Github repository
16
+ LABEL org.opencontainers.image.source=https://github.com/rse/nunjucks-cli
17
+ LABEL org.opencontainers.image.description="Nunjucks Template Rendering Command-Line Interface"
18
+
15
19
  # add additional build tools
16
20
  RUN apk update && \
17
21
  apk upgrade
@@ -27,9 +31,7 @@ WORKDIR /app
27
31
  ENV HOME=/app
28
32
 
29
33
  # install tool
30
- RUN npm install -g \
31
- @rse/nunjucks-cli@1.5.2 \
32
- @rse/nunjucks-addons@1.0.8
34
+ RUN npm install -g @rse/nunjucks-cli
33
35
 
34
36
  # cleanup Alpine
35
37
  RUN rm -rf /var/cache/apk/*
package/README.md CHANGED
@@ -48,6 +48,14 @@ $ npx --yes --package @rse/nunjucks-cli --package @rse/nunjucks-addons -- \
48
48
  nunjucks -e @rse/nunjucks-addons [...]
49
49
  ```
50
50
 
51
+ Furthermore, instead of using NPM at all, you can also use Docker (at
52
+ least as long as you are working with stdin/stdout or perform the
53
+ corresponding bind-mounts):
54
+
55
+ ```sh
56
+ $ docker run -i --rm ghcr.io/rse/nunjucks-cli [...] -
57
+ ```
58
+
51
59
  Command-Line Interface (CLI)
52
60
  ----------------------------
53
61
 
@@ -57,6 +65,8 @@ Short excerpt of the CLI options and arguments from the companion [Unix manpage]
57
65
  $ nunjucks
58
66
  [-h|--help]
59
67
  [-V|--version]
68
+ [-e|--env <env-file>]
69
+ [-E|--envs]
60
70
  [-c|--config <config-file>]
61
71
  [-C|--option <key>=<value>]
62
72
  [-d|--defines <context-file>]
@@ -70,6 +80,12 @@ $ nunjucks
70
80
  Show usage help.
71
81
  - `-V`|`--version`:<br/>
72
82
  Show program version information.
83
+ - `-e`|`--env` *env-file*:<br/>
84
+ Load environment file with key/value definitions.
85
+ These can later be accessed with the global `env` variable.
86
+ - [`-E`|`--envs`]:<br/>
87
+ Automatically load environment files with key/value definitions
88
+ from all `.env` files in current and all parent directories.
73
89
  - `-c`|`--config` `<config-file>`:<br/>
74
90
  Load Nunjucks configuration YAML file.
75
91
  - `-C`|`--option` `<key>=<value>`:<br/>
package/nunjucks.ts CHANGED
@@ -19,6 +19,9 @@ import deepmerge from "deepmerge"
19
19
  import dotenvx from "@dotenvx/dotenvx"
20
20
  import * as findup from "find-up"
21
21
 
22
+ /* internal requirements */
23
+ import pkg from "./package.json" with { type: "json" }
24
+
22
25
  /* type definitions */
23
26
  type PackageInfo = {
24
27
  name: string
@@ -51,207 +54,212 @@ type CLIOptions = {
51
54
  _: string[]
52
55
  }
53
56
 
54
- /* load my own information */
55
- const my: PackageInfo = JSON.parse(await fs.promises.readFile(new URL("./package.json", import.meta.url), "utf-8"))
57
+ /* establish asynchronous environment */
58
+ ;(async () => {
59
+ /* load my own information */
60
+ const my = pkg as PackageInfo
56
61
 
57
- /* parse command-line arguments */
58
- const program = new Command()
59
- const reduceArray = (v: string, l: string[]) => l.concat([ v ])
60
- program.name("nunjucks")
61
- .description("Nunjucks Template Rendering Command-Line Interface")
62
- .showHelpAfterError("hint: use option --help for usage information")
63
- .option("-h, --help", "show usage help", false)
64
- .option("-V, --version", "show program version information", false)
65
- .option("-e, --env <env-file>", "load environment key/value file", reduceArray, [])
66
- .option("-E, --envs", "load all environment key/value files", false)
67
- .option("-c, --config <config-file>", "load Nunjucks configuration YAML file", "")
68
- .option("-C, --option <key>=<value>", "set Nunjucks configuration option", reduceArray, [])
69
- .option("-d, --defines <context-file>", "load context definition YAML file", reduceArray, [])
70
- .option("-D, --define <key>=<value>", "set context definition key/value", reduceArray, [])
71
- .option("-p, --plugin <module-name>", "load Nunjucks JavaScript plugin module", reduceArray, [])
72
- .option("-o, --output <output-file>", "save output file", "-")
73
- .argument("[<input-file>]", "input file")
74
- program.parse(process.argv)
75
- const argv: CLIOptions = {
76
- ...program.opts(),
77
- _: program.args
78
- } as CLIOptions
62
+ /* parse command-line arguments */
63
+ const program = new Command()
64
+ const reduceArray = (v: string, l: string[]) => l.concat([ v ])
65
+ program.name("nunjucks")
66
+ .description("Nunjucks Template Rendering Command-Line Interface")
67
+ .showHelpAfterError("hint: use option --help for usage information")
68
+ .option("-h, --help", "show usage help", false)
69
+ .option("-V, --version", "show program version information", false)
70
+ .option("-e, --env <env-file>", "load environment key/value file", reduceArray, [])
71
+ .option("-E, --envs", "load all environment key/value files", false)
72
+ .option("-c, --config <config-file>", "load Nunjucks configuration YAML file", "")
73
+ .option("-C, --option <key>=<value>", "set Nunjucks configuration option", reduceArray, [])
74
+ .option("-d, --defines <context-file>", "load context definition YAML file", reduceArray, [])
75
+ .option("-D, --define <key>=<value>", "set context definition key/value", reduceArray, [])
76
+ .option("-p, --plugin <module-name>", "load Nunjucks JavaScript plugin module", reduceArray, [])
77
+ .option("-o, --output <output-file>", "save output file", "-")
78
+ .argument("[<input-file>]", "input file")
79
+ program.parse(process.argv)
80
+ const argv: CLIOptions = {
81
+ ...program.opts(),
82
+ _: program.args
83
+ } as CLIOptions
79
84
 
80
- /* handle special help request */
81
- if (argv.help) {
82
- console.log(program.helpInformation())
83
- console.log("Example:\n $ echo \"Hello, {{ who }}!\" | nunjucks -Dwho=World -\n")
84
- process.exit(0)
85
- }
85
+ /* handle special help request */
86
+ if (argv.help) {
87
+ console.log(program.helpInformation())
88
+ console.log("Example:\n $ echo \"Hello, {{ who }}!\" | nunjucks -Dwho=World -\n")
89
+ process.exit(0)
90
+ }
86
91
 
87
- /* handle special version request */
88
- if (argv.version) {
89
- console.log(`${my.name} ${my.version} (Node.js ${process.versions.node}, Nunjucks: ${my.dependencies.nunjucks})`)
90
- console.log(`${my.description}`)
91
- console.log(`Copyright (c) 2019-2025 ${my.author.name} <${my.author.url}>`)
92
- console.log(`Licensed under ${my.license} <http://spdx.org/licenses/${my.license}.html>`)
93
- process.exit(0)
94
- }
92
+ /* handle special version request */
93
+ if (argv.version) {
94
+ console.log(`${my.name} ${my.version} (Node.js ${process.versions.node}, Nunjucks: ${my.dependencies.nunjucks})`)
95
+ console.log(`${my.description}`)
96
+ console.log(`Copyright (c) 2019-2025 ${my.author.name} <${my.author.url}>`)
97
+ console.log(`Licensed under ${my.license} <http://spdx.org/licenses/${my.license}.html>`)
98
+ process.exit(0)
99
+ }
95
100
 
96
- /* read input file */
97
- let input = ""
98
- if (argv._.length > 1) {
99
- console.error(chalk.red("nunjucks: ERROR: invalid number of arguments (zero or one input file expected)"))
100
- process.exit(1)
101
- }
102
- let inputFile: string = argv._[0] ?? "-"
103
- if (inputFile === "-") {
104
- inputFile = "<stdin>"
105
- process.stdin.setEncoding("utf-8")
106
- const BUFSIZE = 256
107
- const buf = Buffer.alloc(BUFSIZE)
108
- while (true) {
109
- let bytesRead = 0
101
+ /* read input file */
102
+ let input = ""
103
+ if (argv._.length > 1) {
104
+ console.error(chalk.red("nunjucks: ERROR: invalid number of arguments (zero or one input file expected)"))
105
+ process.exit(1)
106
+ }
107
+ let inputFile: string = argv._[0] ?? "-"
108
+ if (inputFile === "-") {
109
+ inputFile = "<stdin>"
110
+ process.stdin.setEncoding("utf-8")
111
+ const BUFSIZE = 256
112
+ const buf = Buffer.alloc(BUFSIZE)
113
+ while (true) {
114
+ let bytesRead = 0
115
+ try {
116
+ bytesRead = fs.readSync(process.stdin.fd, buf, 0, BUFSIZE, null)
117
+ }
118
+ catch (ex: any) {
119
+ if (ex.code === "EAGAIN") continue
120
+ else if (ex.code === "EOF") break
121
+ else throw ex
122
+ }
123
+ if (bytesRead === 0)
124
+ break
125
+ input += buf.toString("utf8", 0, bytesRead)
126
+ }
127
+ }
128
+ else {
129
+ if (!fs.existsSync(inputFile)) {
130
+ console.error(chalk.red(`nunjucks: ERROR: failed to find input file: "${inputFile}"`))
131
+ process.exit(1)
132
+ }
133
+ input = fs.readFileSync(inputFile, { encoding: "utf8" })
134
+ }
135
+
136
+ /* provide context variables for template */
137
+ let context: ContextType = {}
138
+ for (const define of argv.defines) {
110
139
  try {
111
- bytesRead = fs.readSync(process.stdin.fd, buf, 0, BUFSIZE, null)
140
+ context = deepmerge(context, jsYAML.load(fs.readFileSync(define, { encoding: "utf8" })) as ContextType)
112
141
  }
113
142
  catch (ex: any) {
114
- if (ex.code === "EAGAIN") continue
115
- else if (ex.code === "EOF") break
116
- else throw ex
143
+ console.error(chalk.red(`nunjucks: ERROR: failed to load context YAML file: ${ex.toString()}`))
144
+ process.exit(1)
117
145
  }
118
- if (bytesRead === 0)
119
- break
120
- input += buf.toString("utf8", 0, bytesRead)
121
- }
122
- }
123
- else {
124
- if (!fs.existsSync(inputFile)) {
125
- console.error(chalk.red(`nunjucks: ERROR: failed to find input file: "${inputFile}"`))
126
- process.exit(1)
127
146
  }
128
- input = fs.readFileSync(inputFile, { encoding: "utf8" })
129
- }
130
147
 
131
- /* provide context variables for template */
132
- let context: ContextType = {}
133
- for (const define of argv.defines) {
134
- try {
135
- context = deepmerge(context, jsYAML.load(fs.readFileSync(define, { encoding: "utf8" })) as ContextType)
148
+ /* load environment variables from all default files */
149
+ if (argv.envs) {
150
+ const files = findup.findUpMultipleSync(".env")
151
+ if (files.length > 0)
152
+ dotenvx.config({ path: files, quiet: true })
136
153
  }
137
- catch (ex: any) {
138
- console.error(chalk.red(`nunjucks: ERROR: failed to load context YAML file: ${ex.toString()}`))
139
- process.exit(1)
140
- }
141
- }
142
-
143
- /* load environment variables from all default files */
144
- if (argv.envs) {
145
- const files = findup.findUpMultipleSync(".env")
146
- if (files.length > 0)
147
- dotenvx.config({ path: files, quiet: true })
148
- }
149
154
 
150
- /* load environment variables from environment files */
151
- if (argv.env.length > 0) {
152
- for (const env of argv.env) {
153
- if (!fs.existsSync(env)) {
154
- console.error(chalk.red(`nunjucks: ERROR: environment file not found: "${env}"`))
155
- process.exit(1)
155
+ /* load environment variables from environment files */
156
+ if (argv.env.length > 0) {
157
+ for (const env of argv.env) {
158
+ if (!fs.existsSync(env)) {
159
+ console.error(chalk.red(`nunjucks: ERROR: environment file not found: "${env}"`))
160
+ process.exit(1)
161
+ }
156
162
  }
163
+ dotenvx.config({ path: argv.env, quiet: true })
157
164
  }
158
- dotenvx.config({ path: argv.env, quiet: true })
159
- }
160
165
 
161
- /* expose environment variables to template */
162
- context.env = process.env
166
+ /* expose environment variables to template */
167
+ context.env = process.env
163
168
 
164
- /* add context defines */
165
- argv.define.forEach((define: string) => {
166
- const match = define.match(/^([^=]+)(?:=(.*))?$/)
167
- if (!match)
168
- return
169
- let [ , key, val ]: (string | undefined)[] = match
170
- if (!key)
171
- return
172
- if (val === undefined)
173
- val = "true"
174
- context[key] = val
175
- })
169
+ /* add context defines */
170
+ argv.define.forEach((define: string) => {
171
+ const match = define.match(/^([^=]+)(?:=(.*))?$/)
172
+ if (!match)
173
+ return
174
+ let [ , key, val ]: (string | undefined)[] = match
175
+ if (!key)
176
+ return
177
+ if (val === undefined)
178
+ val = "true"
179
+ context[key] = val
180
+ })
176
181
 
177
- /* determine Nunjucks options */
178
- let options: OptionsType = {}
179
- if (argv.config) {
180
- try {
181
- options = jsYAML.load(fs.readFileSync(argv.config, { encoding: "utf8" })) as OptionsType
182
+ /* determine Nunjucks options */
183
+ let options: OptionsType = {}
184
+ if (argv.config) {
185
+ try {
186
+ options = jsYAML.load(fs.readFileSync(argv.config, { encoding: "utf8" })) as OptionsType
187
+ }
188
+ catch (ex: any) {
189
+ console.error(chalk.red(`nunjucks: ERROR: failed to load options YAML file: ${ex.toString()}`))
190
+ process.exit(1)
191
+ }
182
192
  }
183
- catch (ex: any) {
184
- console.error(chalk.red(`nunjucks: ERROR: failed to load options YAML file: ${ex.toString()}`))
185
- process.exit(1)
193
+ if (argv.option.length > 0)
194
+ options = Object.assign(options, argv.option)
195
+ options = {
196
+ autoescape: false,
197
+ throwOnUndefined: false,
198
+ trimBlocks: true,
199
+ lstripBlocks: true,
200
+ watch: false,
201
+ noCache: true,
202
+ ...options
186
203
  }
187
- }
188
- if (argv.option.length > 0)
189
- options = Object.assign(options, argv.option)
190
- options = {
191
- autoescape: false,
192
- throwOnUndefined: false,
193
- trimBlocks: true,
194
- lstripBlocks: true,
195
- watch: false,
196
- noCache: true,
197
- ...options
198
- }
199
204
 
200
- /* configure environment */
201
- const env = nunjucks.configure(inputFile, options)
205
+ /* configure environment */
206
+ const env = nunjucks.configure(inputFile, options)
202
207
 
203
- /* load external plugin modules */
204
- for (const plugin of argv.plugin) {
205
- let modpath: string | null = path.resolve(plugin)
206
- if (!fs.existsSync(modpath)) {
208
+ /* load external plugin modules */
209
+ for (const plugin of argv.plugin) {
210
+ let modpath: string | null = path.resolve(plugin)
211
+ if (!fs.existsSync(modpath)) {
212
+ try {
213
+ const require = createRequire(import.meta.url)
214
+ modpath = require.resolve(plugin)
215
+ }
216
+ catch (_ex) {
217
+ modpath = null
218
+ }
219
+ }
220
+ if (modpath === null) {
221
+ console.error(chalk.red(`nunjucks: ERROR: failed to find plugin module: ${plugin}`))
222
+ process.exit(1)
223
+ }
224
+
225
+ /* dynamically import the module */
226
+ let mod: any
207
227
  try {
208
- const require = createRequire(import.meta.url)
209
- modpath = require.resolve(plugin)
228
+ mod = await import(modpath)
229
+
230
+ /* handle both default and named exports */
231
+ mod = mod.default ?? mod
210
232
  }
211
- catch (_ex) {
212
- modpath = null
233
+ catch (ex: any) {
234
+ console.error(chalk.red(`nunjucks: ERROR: failed to load plugin module: ${ex.toString()}`))
235
+ process.exit(1)
213
236
  }
214
- }
215
- if (modpath === null) {
216
- console.error(chalk.red(`nunjucks: ERROR: failed to find plugin module: ${plugin}`))
217
- process.exit(1)
237
+ if (!(mod !== null && typeof mod === "function")) {
238
+ console.error(chalk.red(`nunjucks: ERROR: failed to call plugin file: "${modpath}"`))
239
+ process.exit(1)
240
+ }
241
+ mod(env)
218
242
  }
219
243
 
220
- /* dynamically import the module */
221
- let mod: any
244
+ /* render Nunjucks template */
245
+ let output: string
222
246
  try {
223
- mod = await import(modpath)
224
-
225
- /* handle both default and named exports */
226
- mod = mod.default ?? mod
247
+ output = env.renderString(input, context)
227
248
  }
228
249
  catch (ex: any) {
229
- console.error(chalk.red(`nunjucks: ERROR: failed to load plugin module: ${ex.toString()}`))
250
+ console.error(chalk.red(`nunjucks: ERROR: failed to render template: ${ex.toString()}`))
230
251
  process.exit(1)
231
252
  }
232
- if (!(mod !== null && typeof mod === "function")) {
233
- console.error(chalk.red(`nunjucks: ERROR: failed to call plugin file: "${modpath}"`))
234
- process.exit(1)
235
- }
236
- mod(env)
237
- }
238
253
 
239
- /* render Nunjucks template */
240
- let output: string
241
- try {
242
- output = env.renderString(input, context)
243
- }
244
- catch (ex: any) {
245
- console.error(chalk.red(`nunjucks: ERROR: failed to render template: ${ex.toString()}`))
246
- process.exit(1)
247
- }
254
+ /* write output */
255
+ if (argv.output === "-")
256
+ process.stdout.write(output)
257
+ else
258
+ fs.writeFileSync(argv.output, output, { encoding: "utf8" })
248
259
 
249
- /* write output */
250
- if (argv.output === "-")
251
- process.stdout.write(output)
252
- else
253
- fs.writeFileSync(argv.output, output, { encoding: "utf8" })
254
-
255
- /* die gracefully */
256
- process.exit(0)
260
+ /* die gracefully */
261
+ process.exit(0)
262
+ })().catch((err: any) => {
263
+ console.error(chalk.red(`nunjucks: ERROR: ${err.toString()}`))
264
+ })
257
265
 
package/package.json CHANGED
@@ -1,63 +1,66 @@
1
1
  {
2
- "name": "@rse/nunjucks-cli",
3
- "publishConfig": { "access": "public" },
4
- "version": "2.1.0",
5
- "stdver": "2.1.0-GA",
6
- "description": "Nunjucks Template Rendering Command-Line Interface",
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
7
  "author": {
8
- "name": "Dr. Ralf S. Engelschall",
9
- "email": "rse@engelschall.com",
10
- "url": "http://engelschall.com"
8
+ "name": "Dr. Ralf S. Engelschall",
9
+ "email": "rse@engelschall.com",
10
+ "url": "http://engelschall.com"
11
11
  },
12
- "license": "MIT",
12
+ "license": "MIT",
13
13
  "repository": {
14
- "type": "git",
15
- "url": "git+https://github.com/rse/nunjucks-cli.git"
14
+ "type": "git",
15
+ "url": "git+https://github.com/rse/nunjucks-cli.git"
16
16
  },
17
17
  "bugs": {
18
- "url": "http://github.com/rse/nunjucks-cli/issues"
18
+ "url": "http://github.com/rse/nunjucks-cli/issues"
19
19
  },
20
20
  "bin": {
21
- "nunjucks": "nunjucks.js"
21
+ "nunjucks": "dst-stage1/nunjucks.js"
22
22
  },
23
- "man": "nunjucks.1",
24
- "type": "module",
23
+ "man": "dst-stage1/nunjucks.1",
24
+ "type": "module",
25
25
  "engines": {
26
- "node": ">=22.18.0"
26
+ "node": ">=22.18.0"
27
27
  },
28
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"
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
36
  },
37
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",
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",
53
57
 
54
- "@types/node": "25.0.3",
55
- "@types/js-yaml": "4.0.9",
56
- "@types/nunjucks": "3.2.6",
57
- "@types/find-up": "4.0.2"
58
+ "@types/node": "25.0.3",
59
+ "@types/js-yaml": "4.0.9",
60
+ "@types/nunjucks": "3.2.6"
58
61
  },
59
62
  "scripts": {
60
- "start": "stx -v4 -c stx.conf",
61
- "test": "npm start test"
63
+ "start": "stx -v4 -c stx.conf",
64
+ "test": "npm start test"
62
65
  }
63
66
  }
package/stx.conf CHANGED
@@ -11,25 +11,47 @@ lint
11
11
 
12
12
  # build JavaScript from TypeScript
13
13
  build
14
- tsc --project tsconfig.json && \
15
- remark --quiet --use remark-man --output nunjucks.1 nunjucks.md
14
+ vite --config vite.mts build --mode production &&
15
+ remark --quiet --use remark-man --output dst-stage1/nunjucks.man nunjucks.md
16
16
 
17
17
  # execute simple smole test
18
18
  test : build
19
19
  echo 'Hello, {{who}}!' | node nunjucks.js -D who=world -
20
20
 
21
- # build all-in-one packages
22
- build:pkg [hostname=en4.*]
23
-
24
21
  # package distribution archives
25
- package : build build:pkg [hostname=en4.*]
26
- VERSION=`sed -n '/"version":/ s/.*: *"\(.*\)".*/\1/p' package.json` && \
22
+ package : package:docker package:sea [hostname=en4.*]
23
+
24
+ # package as Docker container image
25
+ package:docker [hostname=en4.*]
26
+ IMAGE_PREFIX=`egrep "ARG.*IMAGE_PREFIX" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
27
+ IMAGE_NAME=`egrep "ARG.*IMAGE_NAME" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
28
+ IMAGE_VERSION=`egrep "ARG.*IMAGE_VERSION" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
29
+ IMAGE_RELEASE=`egrep "ARG.*IMAGE_RELEASE" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
30
+ IMAGE_ALIAS=`egrep "ARG.*IMAGE_ALIAS" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
31
+ docker buildx build \
32
+ --progress plain \
33
+ --pull \
34
+ --no-cache \
35
+ --platform linux/amd64,linux/arm64 \
36
+ -t $IMAGE_PREFIX$IMAGE_NAME:$IMAGE_ALIAS \
37
+ -t $IMAGE_PREFIX$IMAGE_NAME:$IMAGE_VERSION \
38
+ -t $IMAGE_PREFIX$IMAGE_NAME:$IMAGE_VERSION-$IMAGE_RELEASE \
39
+ -f Dockerfile . && \
40
+ docker image ls $IMAGE_PREFIX$IMAGE_NAME:$IMAGE_VERSION-$IMAGE_RELEASE
41
+
42
+ # package as Single Excecutable Application (SEA)
43
+ package:sea [hostname=en4.*]
44
+ rm -rf dst-stage3 && \
45
+ mkdir dst-stage3 && \
46
+ cd dst-stage3 && \
47
+ VERSION=`sed -n '/"version":/ s/.*: *"\(.*\)".*/\1/p' ../package.json` && \
27
48
  targets="node24-linux-x64,node24-linux-arm64" && \
28
49
  targets="$targets,node24-win-x64,node24-win-arm64" && \
29
50
  targets="$targets,node24-macos-x64,node24-macos-arm64" && \
30
- sed -e 's;@rse/nunjucks-cli;nunjucks;' <package.json >nunjucks.json && \
31
- pkg --sea --public -c nunjucks.json -t "$targets" nunjucks.js && \
32
- rm -f nunjucks.json && \
51
+ sed -e 's;@rse/nunjucks-cli;nunjucks;' -e '/"type"/d' <../package.json >package.json && \
52
+ cp ../dst-stage2/nunjucks.cjs nunjucks.cjs && \
53
+ cp ../dst-stage1/nunjucks.man nunjucks.man && \
54
+ pkg --public --no-bytecode -c package.json -t "$targets" nunjucks.cjs && \
33
55
  shx mv nunjucks-linux-x64 nunjucks-lnx-x64 && \
34
56
  shx mv nunjucks-linux-arm64 nunjucks-lnx-a64 && \
35
57
  shx mv nunjucks-win-x64.exe nunjucks-win-x64.exe && \
@@ -43,20 +65,20 @@ package : build build:pkg [hostname=en4.*]
43
65
  mkdir -p nunjucks-$VERSION-mac-a64/ && \
44
66
  mkdir -p nunjucks-$VERSION-lnx-x64/ && \
45
67
  mkdir -p nunjucks-$VERSION-lnx-a64/ && \
46
- cp -p nunjucks.js nunjucks-$VERSION/nunjucks.js && \
68
+ cp -p nunjucks.cjs nunjucks-$VERSION/nunjucks.cjs && \
47
69
  cp -p nunjucks-win-x64.exe nunjucks-$VERSION-win-x64/nunjucks.exe && \
48
70
  cp -p nunjucks-win-a64.exe nunjucks-$VERSION-win-a64/nunjucks.exe && \
49
71
  cp -p nunjucks-mac-x64 nunjucks-$VERSION-mac-x64/nunjucks && \
50
72
  cp -p nunjucks-mac-a64 nunjucks-$VERSION-mac-a64/nunjucks && \
51
73
  cp -p nunjucks-lnx-x64 nunjucks-$VERSION-lnx-x64/nunjucks && \
52
74
  cp -p nunjucks-lnx-a64 nunjucks-$VERSION-lnx-a64/nunjucks && \
53
- cp -p nunjucks.1 nunjucks-$VERSION/nunjucks.man && \
54
- cp -p nunjucks.1 nunjucks-$VERSION-win-x64/nunjucks.man && \
55
- cp -p nunjucks.1 nunjucks-$VERSION-win-a64/nunjucks.man && \
56
- cp -p nunjucks.1 nunjucks-$VERSION-mac-x64/nunjucks.man && \
57
- cp -p nunjucks.1 nunjucks-$VERSION-mac-a64/nunjucks.man && \
58
- cp -p nunjucks.1 nunjucks-$VERSION-lnx-x64/nunjucks.man && \
59
- cp -p nunjucks.1 nunjucks-$VERSION-lnx-a64/nunjucks.man && \
75
+ cp -p nunjucks.man nunjucks-$VERSION/nunjucks.man && \
76
+ cp -p nunjucks.man nunjucks-$VERSION-win-x64/nunjucks.man && \
77
+ cp -p nunjucks.man nunjucks-$VERSION-win-a64/nunjucks.man && \
78
+ cp -p nunjucks.man nunjucks-$VERSION-mac-x64/nunjucks.man && \
79
+ cp -p nunjucks.man nunjucks-$VERSION-mac-a64/nunjucks.man && \
80
+ cp -p nunjucks.man nunjucks-$VERSION-lnx-x64/nunjucks.man && \
81
+ cp -p nunjucks.man nunjucks-$VERSION-lnx-a64/nunjucks.man && \
60
82
  zip -9 -r nunjucks-$VERSION.zip nunjucks-$VERSION/ && \
61
83
  zip -9 -r nunjucks-$VERSION-win-x64.zip nunjucks-$VERSION-win-x64/ && \
62
84
  zip -9 -r nunjucks-$VERSION-win-a64.zip nunjucks-$VERSION-win-a64/ && \
@@ -66,24 +88,37 @@ package : build build:pkg [hostname=en4.*]
66
88
  zip -9 -r nunjucks-$VERSION-lnx-a64.zip nunjucks-$VERSION-lnx-a64/
67
89
 
68
90
  # publish distribution archives
69
- publish : package [hostname=en4.*]
91
+ publish : publish:docker publish:sea [hostname=en4.*]
92
+
93
+ # publish Docker container image
94
+ publish:docker [hostname=en4.*]
95
+ IMAGE_PREFIX=`egrep "ARG.*IMAGE_PREFIX" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
96
+ IMAGE_NAME=`egrep "ARG.*IMAGE_NAME" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
97
+ IMAGE_VERSION=`egrep "ARG.*IMAGE_VERSION" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
98
+ IMAGE_RELEASE=`egrep "ARG.*IMAGE_RELEASE" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
99
+ IMAGE_ALIAS=`egrep "ARG.*IMAGE_ALIAS" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
100
+ docker push $IMAGE_PREFIX$IMAGE_NAME:$IMAGE_VERSION-$IMAGE_RELEASE && \
101
+ docker push $IMAGE_PREFIX$IMAGE_NAME:$IMAGE_VERSION && \
102
+ docker push $IMAGE_PREFIX$IMAGE_NAME:$IMAGE_ALIAS
103
+
104
+ # publish Single Excecutable Application (SEA)
105
+ publish:sea [hostname=en4.*]
70
106
  VERSION=`sed -n '/"version":/ s/.*: *"\(.*\)".*/\1/p' package.json` && \
71
107
  V=`echo "$VERSION" | sed -e 's;\.;\\.;g'` && \
72
108
  sed -n -e "/^${V} /, /^[0-9]\\./ { /^${V} /p; /^[0-9]\\./!p; }" <CHANGELOG.md >.notes.md && \
73
109
  gh release create --title "Nunjucks $VERSION" --notes-file .notes.md --verify-tag $VERSION \
74
- nunjucks-$VERSION.zip \
75
- nunjucks-$VERSION-win-x64.zip \
76
- nunjucks-$VERSION-win-a64.zip \
77
- nunjucks-$VERSION-mac-x64.zip \
78
- nunjucks-$VERSION-mac-a64.zip \
79
- nunjucks-$VERSION-lnx-x64.zip \
80
- nunjucks-$VERSION-lnx-a64.zip && \
110
+ dst-stage3/nunjucks-$VERSION.zip \
111
+ dst-stage3/nunjucks-$VERSION-win-x64.zip \
112
+ dst-stage3/nunjucks-$VERSION-win-a64.zip \
113
+ dst-stage3/nunjucks-$VERSION-mac-x64.zip \
114
+ dst-stage3/nunjucks-$VERSION-mac-a64.zip \
115
+ dst-stage3/nunjucks-$VERSION-lnx-x64.zip \
116
+ dst-stage3/nunjucks-$VERSION-lnx-a64.zip && \
81
117
  rm -f .notes.md
82
118
 
83
119
  # remove all generated artifacts
84
120
  clean
85
- shx rm -f nunjucks.js && \
86
- shx rm -rf nunjucks-*.zip
121
+ shx rm -rf dst-stage*
87
122
 
88
123
  # remove all generated artifacts
89
124
  distclean: clean
package/tsconfig.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "compilerOptions": {
3
3
  "target": "ES2024",
4
- "module": "node20",
4
+ "module": "nodenext",
5
5
  "lib": [ "ES2024" ],
6
- "moduleResolution": "node16",
6
+ "moduleResolution": "nodenext",
7
7
  "resolveJsonModule": true,
8
8
  "declaration": false,
9
9
  "allowSyntheticDefaultImports": true,
@@ -11,7 +11,7 @@
11
11
  "forceConsistentCasingInFileNames": true,
12
12
  "strict": true,
13
13
  "skipLibCheck": true,
14
- "outDir": ".",
14
+ "outDir": "dst-stage1",
15
15
  "types": [ "node" ]
16
16
  },
17
17
  "include": [
package/vite.mts ADDED
@@ -0,0 +1,59 @@
1
+ /*
2
+ ** nunjucks -- Nunjucks Template Rendering Command-Line Interface
3
+ ** Copyright (c) 2019-2025 Dr. Ralf S. Engelschall <http://engelschall.com>
4
+ ** Licensed under MIT <http://spdx.org/licenses/MIT.html>
5
+ */
6
+
7
+ import * as Vite from "vite"
8
+ import { tscPlugin } from "@wroud/vite-plugin-tsc"
9
+ import nodeExternals from "rollup-plugin-node-externals"
10
+
11
+ export default Vite.defineConfig(({ command, mode }) => ({
12
+ logLevel: "info",
13
+ appType: "custom",
14
+ base: "",
15
+ root: "",
16
+ plugins: [
17
+ tscPlugin({
18
+ tscArgs: [ "--project", "tsconfig.json", ...(mode === "development" ? [ "--sourceMap" ] : []) ],
19
+ packageManager: "npx" as "npm",
20
+ prebuild: true
21
+ }),
22
+ nodeExternals({
23
+ builtins: true,
24
+ devDeps: false,
25
+ deps: false,
26
+ optDeps: false,
27
+ peerDeps: false
28
+ })
29
+ ],
30
+ resolve: {
31
+ mainFields: [ "module", "jsnext:main", "jsnext" ],
32
+ conditions: [ "node" ],
33
+ },
34
+ build: {
35
+ lib: {
36
+ entry: "dst-stage1/nunjucks.js",
37
+ formats: [ "cjs" ],
38
+ name: "Nunjucks",
39
+ fileName: () => "nunjucks.cjs"
40
+ },
41
+ target: "esnext",
42
+ outDir: "dst-stage2",
43
+ assetsDir: "",
44
+ emptyOutDir: (mode === "production"),
45
+ chunkSizeWarningLimit: 5000,
46
+ assetsInlineLimit: 0,
47
+ sourcemap: (mode === "development"),
48
+ minify: (mode === "production" ? "terser" : false),
49
+ reportCompressedSize: true,
50
+ rollupOptions: {
51
+ onwarn (warning, warn) {
52
+ if (warning.message.match(/Use of eval.*?is strongly discouraged/))
53
+ return
54
+ warn(warning)
55
+ }
56
+ }
57
+ }
58
+ }))
59
+
package/Dockerfile.mk DELETED
@@ -1,104 +0,0 @@
1
- ##
2
- ## Makefile: Docker Build Procedure
3
- ##
4
-
5
- # ==== DEFAULT ====
6
- # default build target
7
- TARGETS ?= build
8
- all: $(TARGETS)
9
-
10
- # ==== COMMON ====
11
- # configuration of container image
12
- DOCKER_IMAGE_CONFIG ?= __dummy=1
13
- IMAGE_CONFIG = \
14
- IMAGE_PREFIX=`egrep "ARG.*IMAGE_PREFIX" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
15
- IMAGE_NAME=`egrep "ARG.*IMAGE_NAME" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
16
- IMAGE_VERSION=`egrep "ARG.*IMAGE_VERSION" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
17
- IMAGE_RELEASE=`egrep "ARG.*IMAGE_RELEASE" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
18
- IMAGE_ALIAS=`egrep "ARG.*IMAGE_ALIAS" Dockerfile | sed -e 's;^.*=;;' | head -1` && \
19
- $(DOCKER_IMAGE_CONFIG)
20
-
21
- # ==== BUILD ====
22
- # (re)build a container image
23
- DOCKER_BUILD_FLAGS ?= --pull --no-cache
24
- build: Dockerfile
25
- @$(IMAGE_CONFIG) && \
26
- echo "++ building Docker image $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE} ($${IMAGE_ALIAS})" && \
27
- docker build \
28
- $(DOCKER_BUILD_FLAGS) \
29
- --build-arg "IMAGE_PREFIX=$${IMAGE_PREFIX}" \
30
- --build-arg "IMAGE_NAME=$${IMAGE_NAME}" \
31
- --build-arg "IMAGE_VERSION=$${IMAGE_VERSION}" \
32
- --build-arg "IMAGE_RELEASE=$${IMAGE_RELEASE}" \
33
- --build-arg "IMAGE_ALIAS=$${IMAGE_ALIAS}" \
34
- -t $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_ALIAS} \
35
- -t $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION} \
36
- -t $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE} \
37
- -f Dockerfile . && \
38
- docker image ls $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE}
39
-
40
- # ==== RUN ====
41
- # run a container image
42
- DOCKER_RUN_FLAGS ?= --rm -i -t -e TERM --init
43
- DOCKER_RUN_ARGS ?=
44
- run:
45
- @$(IMAGE_CONFIG) && \
46
- echo "++ running Docker image $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE}" && \
47
- docker run \
48
- --name "$${IMAGE_NAME}-temp" \
49
- $(DOCKER_RUN_FLAGS) \
50
- $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE} \
51
- $(DOCKER_RUN_ARGS)
52
-
53
- # ==== INSPECT ====
54
- # inspect a container image
55
- DOCKER_INSPECT_FLAGS ?= --rm -i -t -e TERM -u root --entrypoint "/bin/bash"
56
- DOCKER_INSPECT_ARGS ?=
57
- inspect:
58
- @$(IMAGE_CONFIG) && \
59
- echo "++ inspecting Docker image $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE}" && \
60
- docker run \
61
- --name "$${IMAGE_NAME}-temp" \
62
- $(DOCKER_INSPECT_FLAGS) \
63
- $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE} \
64
- $(DOCKER_INSPECT_ARGS)
65
-
66
- # ==== EXEC ====
67
- # enter a running container image
68
- DOCKER_EXEC_FLAGS ?= -i -t -e TERM
69
- DOCKER_EXEC_ARGS ?= /bin/bash
70
- exec:
71
- @$(IMAGE_CONFIG) && \
72
- echo "++ executing command in Docker container of Docker image $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE}" && \
73
- docker exec \
74
- $(DOCKER_EXEC_FLAGS) \
75
- `docker ps --filter "ancestor=$${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE}" --format "{{ .ID }}"` \
76
- $(DOCKER_EXEC_ARGS)
77
-
78
- # ==== PUSH ====
79
- # push container image to registry
80
- push:
81
- @$(IMAGE_CONFIG) && \
82
- echo "++ pushing Docker image $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE} ($${IMAGE_ALIAS})" && \
83
- docker push $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE} && \
84
- docker push $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION} && \
85
- docker push $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_ALIAS}
86
-
87
- # ==== CLEAN ====
88
- # remove container image
89
- clean:
90
- @$(IMAGE_CONFIG) && \
91
- echo "++ removing Docker image $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE} ($${IMAGE_ALIAS})" && \
92
- docker image rm $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION}-$${IMAGE_RELEASE} >/dev/null 2>&1 || true && \
93
- docker image rm $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_VERSION} >/dev/null 2>&1 || true && \
94
- docker image rm $${IMAGE_PREFIX}$${IMAGE_NAME}:$${IMAGE_ALIAS} >/dev/null 2>&1 || true && \
95
-
96
- # ==== PRUNE ====
97
- # prune entire Docker environment
98
- prune:
99
- @echo "++ pruning Docker environment"
100
- docker container prune -f
101
- docker network prune -f
102
- docker volume prune -f
103
- docker image prune -f
104
-
package/nunjucks.1 DELETED
@@ -1,51 +0,0 @@
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
package/nunjucks.js DELETED
@@ -1,207 +0,0 @@
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
- /* load my own information */
20
- const my = JSON.parse(await fs.promises.readFile(new URL("./package.json", import.meta.url), "utf-8"));
21
- /* parse command-line arguments */
22
- const program = new Command();
23
- const reduceArray = (v, l) => l.concat([v]);
24
- program.name("nunjucks")
25
- .description("Nunjucks Template Rendering Command-Line Interface")
26
- .showHelpAfterError("hint: use option --help for usage information")
27
- .option("-h, --help", "show usage help", false)
28
- .option("-V, --version", "show program version information", false)
29
- .option("-e, --env <env-file>", "load environment key/value file", reduceArray, [])
30
- .option("-E, --envs", "load all environment key/value files", false)
31
- .option("-c, --config <config-file>", "load Nunjucks configuration YAML file", "")
32
- .option("-C, --option <key>=<value>", "set Nunjucks configuration option", reduceArray, [])
33
- .option("-d, --defines <context-file>", "load context definition YAML file", reduceArray, [])
34
- .option("-D, --define <key>=<value>", "set context definition key/value", reduceArray, [])
35
- .option("-p, --plugin <module-name>", "load Nunjucks JavaScript plugin module", reduceArray, [])
36
- .option("-o, --output <output-file>", "save output file", "-")
37
- .argument("[<input-file>]", "input file");
38
- program.parse(process.argv);
39
- const argv = {
40
- ...program.opts(),
41
- _: program.args
42
- };
43
- /* handle special help request */
44
- if (argv.help) {
45
- console.log(program.helpInformation());
46
- console.log("Example:\n $ echo \"Hello, {{ who }}!\" | nunjucks -Dwho=World -\n");
47
- process.exit(0);
48
- }
49
- /* handle special version request */
50
- if (argv.version) {
51
- console.log(`${my.name} ${my.version} (Node.js ${process.versions.node}, Nunjucks: ${my.dependencies.nunjucks})`);
52
- console.log(`${my.description}`);
53
- console.log(`Copyright (c) 2019-2025 ${my.author.name} <${my.author.url}>`);
54
- console.log(`Licensed under ${my.license} <http://spdx.org/licenses/${my.license}.html>`);
55
- process.exit(0);
56
- }
57
- /* read input file */
58
- let input = "";
59
- if (argv._.length > 1) {
60
- console.error(chalk.red("nunjucks: ERROR: invalid number of arguments (zero or one input file expected)"));
61
- process.exit(1);
62
- }
63
- let inputFile = argv._[0] ?? "-";
64
- if (inputFile === "-") {
65
- inputFile = "<stdin>";
66
- process.stdin.setEncoding("utf-8");
67
- const BUFSIZE = 256;
68
- const buf = Buffer.alloc(BUFSIZE);
69
- while (true) {
70
- let bytesRead = 0;
71
- try {
72
- bytesRead = fs.readSync(process.stdin.fd, buf, 0, BUFSIZE, null);
73
- }
74
- catch (ex) {
75
- if (ex.code === "EAGAIN")
76
- continue;
77
- else if (ex.code === "EOF")
78
- break;
79
- else
80
- throw ex;
81
- }
82
- if (bytesRead === 0)
83
- break;
84
- input += buf.toString("utf8", 0, bytesRead);
85
- }
86
- }
87
- else {
88
- if (!fs.existsSync(inputFile)) {
89
- console.error(chalk.red(`nunjucks: ERROR: failed to find input file: "${inputFile}"`));
90
- process.exit(1);
91
- }
92
- input = fs.readFileSync(inputFile, { encoding: "utf8" });
93
- }
94
- /* provide context variables for template */
95
- let context = {};
96
- for (const define of argv.defines) {
97
- try {
98
- context = deepmerge(context, jsYAML.load(fs.readFileSync(define, { encoding: "utf8" })));
99
- }
100
- catch (ex) {
101
- console.error(chalk.red(`nunjucks: ERROR: failed to load context YAML file: ${ex.toString()}`));
102
- process.exit(1);
103
- }
104
- }
105
- /* load environment variables from all default files */
106
- if (argv.envs) {
107
- const files = findup.findUpMultipleSync(".env");
108
- if (files.length > 0)
109
- dotenvx.config({ path: files, quiet: true });
110
- }
111
- /* load environment variables from environment files */
112
- if (argv.env.length > 0) {
113
- for (const env of argv.env) {
114
- if (!fs.existsSync(env)) {
115
- console.error(chalk.red(`nunjucks: ERROR: environment file not found: "${env}"`));
116
- process.exit(1);
117
- }
118
- }
119
- dotenvx.config({ path: argv.env, quiet: true });
120
- }
121
- /* expose environment variables to template */
122
- context.env = process.env;
123
- /* add context defines */
124
- argv.define.forEach((define) => {
125
- const match = define.match(/^([^=]+)(?:=(.*))?$/);
126
- if (!match)
127
- return;
128
- let [, key, val] = match;
129
- if (!key)
130
- return;
131
- if (val === undefined)
132
- val = "true";
133
- context[key] = val;
134
- });
135
- /* determine Nunjucks options */
136
- let options = {};
137
- if (argv.config) {
138
- try {
139
- options = jsYAML.load(fs.readFileSync(argv.config, { encoding: "utf8" }));
140
- }
141
- catch (ex) {
142
- console.error(chalk.red(`nunjucks: ERROR: failed to load options YAML file: ${ex.toString()}`));
143
- process.exit(1);
144
- }
145
- }
146
- if (argv.option.length > 0)
147
- options = Object.assign(options, argv.option);
148
- options = {
149
- autoescape: false,
150
- throwOnUndefined: false,
151
- trimBlocks: true,
152
- lstripBlocks: true,
153
- watch: false,
154
- noCache: true,
155
- ...options
156
- };
157
- /* configure environment */
158
- const env = nunjucks.configure(inputFile, options);
159
- /* load external plugin modules */
160
- for (const plugin of argv.plugin) {
161
- let modpath = path.resolve(plugin);
162
- if (!fs.existsSync(modpath)) {
163
- try {
164
- const require = createRequire(import.meta.url);
165
- modpath = require.resolve(plugin);
166
- }
167
- catch (_ex) {
168
- modpath = null;
169
- }
170
- }
171
- if (modpath === null) {
172
- console.error(chalk.red(`nunjucks: ERROR: failed to find plugin module: ${plugin}`));
173
- process.exit(1);
174
- }
175
- /* dynamically import the module */
176
- let mod;
177
- try {
178
- mod = await import(modpath);
179
- /* handle both default and named exports */
180
- mod = mod.default ?? mod;
181
- }
182
- catch (ex) {
183
- console.error(chalk.red(`nunjucks: ERROR: failed to load plugin module: ${ex.toString()}`));
184
- process.exit(1);
185
- }
186
- if (!(mod !== null && typeof mod === "function")) {
187
- console.error(chalk.red(`nunjucks: ERROR: failed to call plugin file: "${modpath}"`));
188
- process.exit(1);
189
- }
190
- mod(env);
191
- }
192
- /* render Nunjucks template */
193
- let output;
194
- try {
195
- output = env.renderString(input, context);
196
- }
197
- catch (ex) {
198
- console.error(chalk.red(`nunjucks: ERROR: failed to render template: ${ex.toString()}`));
199
- process.exit(1);
200
- }
201
- /* write output */
202
- if (argv.output === "-")
203
- process.stdout.write(output);
204
- else
205
- fs.writeFileSync(argv.output, output, { encoding: "utf8" });
206
- /* die gracefully */
207
- process.exit(0);