@rse/nunjucks-cli 1.4.5 → 1.5.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.
Files changed (7) hide show
  1. package/Dockerfile +42 -0
  2. package/Dockerfile.mk +104 -0
  3. package/README.md +12 -9
  4. package/eslint.yaml +1 -1
  5. package/nunjucks.js +4 -3
  6. package/nunjucks.md +10 -8
  7. package/package.json +10 -9
package/Dockerfile ADDED
@@ -0,0 +1,42 @@
1
+ ##
2
+ ## Dockerfile -- Docker Build Configuration
3
+ ##
4
+
5
+ # build arguments (early)
6
+ ARG IMAGE_PREFIX=docker.io/engelschall/
7
+ ARG IMAGE_NAME=nunjucks-cli
8
+ ARG IMAGE_VERSION=1.5.0
9
+ ARG IMAGE_RELEASE=20231003
10
+ ARG IMAGE_ALIAS=latest
11
+
12
+ # derive image from a certain base image
13
+ FROM node:20.8-alpine3.18
14
+
15
+ # add additional build tools
16
+ RUN apk update && \
17
+ apk upgrade
18
+
19
+ # establish application area and user/group
20
+ RUN mkdir -p /app && \
21
+ apk add --no-cache --virtual .deps1 shadow && \
22
+ groupadd -g 2000 app && \
23
+ useradd -u 2000 -g app -d /app -m -s /bin/bash -p '!' -l app && \
24
+ apk del .deps1 && \
25
+ chown -R app:app /app
26
+ WORKDIR /app
27
+ ENV HOME=/app
28
+
29
+ # install tool
30
+ RUN npm install -g \
31
+ @rse/nunjucks-cli@1.5.0 \
32
+ @rse/nunjucks-addons@1.0.6
33
+
34
+ # cleanup Alpine
35
+ RUN rm -rf /var/cache/apk/*
36
+
37
+ # switch to run-time user
38
+ USER app:app
39
+
40
+ # provide entrypoint
41
+ ENTRYPOINT [ "nunjucks" ]
42
+
package/Dockerfile.mk ADDED
@@ -0,0 +1,104 @@
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 ?= --progress=plain --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/README.md CHANGED
@@ -8,6 +8,7 @@ nunjucks-cli
8
8
  [![github (author followers)](https://img.shields.io/github/followers/rse?label=author%20followers&logo=github&color=%234477aa)](https://github.com/rse)
9
9
  [![github (project stdver)](https://img.shields.io/github/package-json/stdver/rse/nunjucks-cli?logo=github&label=project%20stdver&color=%234477aa&cacheSeconds=900)](https://github.com/rse/nunjucks-cli)
10
10
  <br/>
11
+ [![npm (project license)](https://img.shields.io/npm/l/%40rse%2Fnunjucks-cli?logo=npm&label=npm%20license&color=%23cc3333)](https://npmjs.com/@rse/nunjucks-cli)
11
12
  [![npm (project release)](https://img.shields.io/npm/v/%40rse/nunjucks-cli?logo=npm&label=npm%20release&color=%23cc3333)](https://npmjs.com/@rse/nunjucks-cli)
12
13
  [![npm (project downloads)](https://img.shields.io/npm/dm/%40rse/nunjucks-cli?logo=npm&label=npm%20downloads&color=%23cc3333)](https://npmjs.com/@rse/nunjucks-cli)
13
14
 
@@ -66,23 +67,25 @@ $ nunjucks
66
67
  ```
67
68
 
68
69
  - `-h`|`--help`:<br/>
69
- show usage help.
70
+ Show usage help.
70
71
  - `-V`|`--version`:<br/>
71
- show program version information.
72
+ Show program version information.
72
73
  - `-c`|`--config` `<config-file>`:<br/>
73
- load Nunjucks configuration YAML file.
74
+ Load Nunjucks configuration YAML file.
74
75
  - `-C`|`--option` `<key>=<value>`:<br/>
75
- set Nunjucks configuration option.
76
+ Set Nunjucks configuration option.
76
77
  - `-d`|`--defines` `<context-file>`:<br/>
77
- load context definition YAML file.
78
+ Load context definition YAML file.
79
+ Can occur multiple times.
78
80
  - `-D`|`--define` `<key>=<value>`:<br/>
79
- set context definition key/value.
81
+ Set context definition key/value.
82
+ Can occur multiple times.
80
83
  - `-e`|`--extension` `<module-name>`:<br/>
81
- load Nunjucks JavaScript extension module (installed via NPM).
84
+ Load Nunjucks JavaScript extension module (installed via NPM).
82
85
  - `-o`|`--output` `<output-file>`|`-`:<br/>
83
- save output file (or stdout).
86
+ Save output file (or stdout).
84
87
  - `<input-file>`|`-`:<br/>
85
- load input file (or stdin).
88
+ Load input file (or stdin).
86
89
 
87
90
  Example
88
91
  -------
package/eslint.yaml CHANGED
@@ -11,7 +11,7 @@ extends:
11
11
  - eslint-config-standard
12
12
 
13
13
  parserOptions:
14
- ecmaVersion: 8
14
+ ecmaVersion: 12
15
15
  sourceType: module
16
16
  ecmaFeatures:
17
17
  jsx: false
package/nunjucks.js CHANGED
@@ -17,6 +17,7 @@ const commander = require("commander")
17
17
  const chalk = require("chalk")
18
18
  const jsYAML = require("js-yaml")
19
19
  const nunjucks = require("nunjucks")
20
+ const deepmerge = require("deepmerge")
20
21
 
21
22
  /* parse command-line arguments */
22
23
  const program = new commander.Command()
@@ -27,7 +28,7 @@ program.name("nunjucks")
27
28
  .option("-V, --version", "show program version information", false)
28
29
  .option("-c, --config <config-file>", "load Nunjucks configuration YAML file", "")
29
30
  .option("-C, --option <key>=<value>", "set Nunjucks configuration option", (v, l) => l.concat([ v ]), [])
30
- .option("-d, --defines <context-file>", "load context definition YAML file", "")
31
+ .option("-d, --defines <context-file>", "load context definition YAML file", (v, l) => l.concat([ v ]), [])
31
32
  .option("-D, --define <key>=<value>", "set context definition key/value", (v, l) => l.concat([ v ]), [])
32
33
  .option("-e, --extension <module-name>", "load Nunjucks JavaScript extension module", (v, l) => l.concat([ v ]), [])
33
34
  .option("-o, --output <output-file>", "save output file", "-")
@@ -88,9 +89,9 @@ else {
88
89
 
89
90
  /* provide context variables for template */
90
91
  let context = {}
91
- if (argv.defines) {
92
+ for (const define of argv.defines) {
92
93
  try {
93
- context = jsYAML.load(fs.readFileSync(argv.defines, { encoding: "utf8" }))
94
+ context = deepmerge(context, jsYAML.load(fs.readFileSync(define, { encoding: "utf8" })))
94
95
  }
95
96
  catch (ex) {
96
97
  console.error(chalk.red(`nunjucks: ERROR: failed to load context YAML file: ${ex.toString()}`))
package/nunjucks.md CHANGED
@@ -31,28 +31,30 @@ The following top-level options and arguments exist:
31
31
  Show usage help.
32
32
 
33
33
  - \[`-V`|`--version`\]
34
- show program version information.
34
+ Show program version information.
35
35
 
36
36
  - \[`-c`|`--config` *config-file*\]
37
- load Nunjucks configuration YAML file.
37
+ Load Nunjucks configuration YAML file.
38
38
 
39
39
  - \[`-C`|`--option` *key*=*value*\]
40
- set Nunjucks configuration option.
40
+ Set Nunjucks configuration option.
41
41
 
42
42
  - \[`-d`|`--defines` *context-file*\]
43
- load context definition YAML file.
43
+ Load context definition YAML file.
44
+ Can occur multiple times.
44
45
 
45
46
  - \[`-D`|`--define` *key*=*value*\]
46
- set context definition key/value.
47
+ Set context definition key/value.
48
+ Can occur multiple times.
47
49
 
48
50
  - \[`-e`|`--extension` *module-name*\]
49
- load Nunjucks JavaScript extension module (installed via NPM).
51
+ Load Nunjucks JavaScript extension module (installed via NPM).
50
52
 
51
53
  - \[`-o`|`--output` *output-file*|`-`\]
52
- save output file (or stdout).
54
+ Save output file (or stdout).
53
55
 
54
56
  - \[`<input-file>`|`-`\]
55
- load input file (or stdin).
57
+ Load input file (or stdin).
56
58
 
57
59
  ## EXAMPLE
58
60
 
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@rse/nunjucks-cli",
3
3
  "publishConfig": { "access": "public" },
4
- "version": "1.4.5",
5
- "stdver": "1.4.3.20230827-GA",
4
+ "version": "1.5.1",
5
+ "stdver": "1.5.1-GA",
6
6
  "description": "Nunjucks Template Rendering Command-Line Interface",
7
7
  "author": {
8
8
  "name": "Dr. Ralf S. Engelschall",
@@ -24,18 +24,19 @@
24
24
  "dependencies": {
25
25
  "nunjucks": "3.2.4",
26
26
  "chalk": "4.1.0",
27
- "commander": "11.0.0",
28
- "js-yaml": "4.1.0"
27
+ "commander": "11.1.0",
28
+ "js-yaml": "4.1.0",
29
+ "deepmerge": "4.3.1"
29
30
  },
30
31
  "devDependencies": {
31
- "eslint": "8.48.0",
32
+ "eslint": "8.56.0",
32
33
  "eslint-config-standard": "17.1.0",
33
34
  "eslint-plugin-promise": "6.1.1",
34
- "eslint-plugin-import": "2.28.1",
35
+ "eslint-plugin-import": "2.29.1",
35
36
  "eslint-plugin-node": "11.1.0",
36
- "remark-cli": "11.0.0",
37
- "remark": "14.0.3",
38
- "remark-man": "8.0.1"
37
+ "remark-cli": "12.0.0",
38
+ "remark": "15.0.1",
39
+ "remark-man": "9.0.0"
39
40
  },
40
41
  "upd": [ "!chalk" ],
41
42
  "scripts": {