Skip to content

Commit 2f6782a

Browse files
committed
chore: README.md update of breaking changes in langauges.ncl
1 parent b9a34a3 commit 2f6782a

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,31 @@
99

1010
## setup
1111

12-
1. install latest topiary-cli
12+
1. install topiary-cli (0.5.1 above)
1313
2. clone this repo to `$env.XDG_CONFIG_HOME/topiary`
1414
3. set environment variables
1515
```nu
1616
$env.TOPIARY_CONFIG_FILE = ($env.XDG_CONFIG_HOME | path join topiary languages.ncl)
1717
$env.TOPIARY_LANGUAGE_DIR = ($env.XDG_CONFIG_HOME | path join topiary languages)
1818
```
19+
4. update `languages.ncl` if Nickel error detected: `grammar.source.git` fits recent updates of topiary github
20+
while the latest release of topiary-cli still uses the other way.
21+
22+
```diff
23+
< grammar = {
24+
---
25+
> grammar.source.git = {
26+
```
1927

2028
## usage
2129

2230
`topiary format script.nu`
31+
32+
## contribute
33+
34+
Help to find format issues with following method (dry-run, detects parsing/idempotence/semantic breaking):
35+
36+
```nu
37+
source utils.nu
38+
test_format <root-path-of-your-nushell-scripts>
39+
```

utils.nu

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,6 @@ export def test_format [
3030
break
3131
}
3232
}
33+
rm $target
3334
}
3435
}

0 commit comments

Comments
 (0)