From ffdaa3460a654ef4a6ccfe35228afa8039ced4c9 Mon Sep 17 00:00:00 2001
From: Yann Hamdaoui
Date: Fri, 19 Jan 2024 10:21:16 +0100
Subject: [PATCH] Update guide for > 1.3 CLI syntax
And the version of the docker image to install, passing by.
---
src/pages/getting-started.js | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/src/pages/getting-started.js b/src/pages/getting-started.js
index 974f6cd1..2ddb9947 100644
--- a/src/pages/getting-started.js
+++ b/src/pages/getting-started.js
@@ -32,7 +32,7 @@ nickel repl
nickel>`,
},
withDocker: {
- install: `docker run --rm -it ghcr.io/tweag/nickel:1.1.1 repl
+ install: `docker run --rm -it ghcr.io/tweag/nickel:1.4.0 repl
nickel>`,
},
firstConfig: `{
@@ -62,7 +62,7 @@ nickel>`,
dep3 = "6.7"
}
}`,
- export: `nickel -f example.ncl export --format yaml
+ export: `nickel export example.ncl --format yaml
---
contributors:
- email: johndoe@example.com
@@ -99,13 +99,13 @@ version = "0.1.1",
scripts = {
test = m%"
test.sh --option --install example --version "0.1.1"
- "%,`,
+ "%,`,
diff: `name = "example",
version = "0.1.1",
scripts = {
test = m%"
test.sh --option --install %{name} --version "%{version}"
- "%`,
+ "%,`,
result: `# [...]
scripts:
do_stuff: do_stuff.sh subcommand
@@ -141,7 +141,7 @@ const IndexPage = () => {
Run
- With a recent version of Nix (> 2.4.0), you can build and run Nickel in one shot. If you haven't installed Nix yet, please follow
+
With a recent version of Nix ({'>'} 2.4.0), you can build and run Nickel in one shot. If you haven't installed Nix yet, please follow
this installation guide. Once Nix is installed, use nix run
to start Nickel
and append -- args
to pass arguments to the Nickel executable (here we launch an REPL session)
@@ -233,7 +233,7 @@ const IndexPage = () => {
ending up with incoherent version numbers in the same configuration. To remedy the problem, let's have a
single source of truth by reusing the value of name
and version
in scripts.test
, using
the string interpolation syntax %{'{expr}'}
:
- {codeExamples.reuse.diff}
+ {codeExamples.reuse.diff}
Now, if we change version to 0.1.2
and export the result, the test script
invocation is updated as well: