Skip to content

Commit afc4bc7

Browse files
fix configlet link (#491)
* Add missing configlet format entry * Improve configlet format documentation
1 parent 2f05090 commit afc4bc7

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

building/config.json

+6
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@
3737
"path": "building/configlet/create.md",
3838
"title": "configlet create"
3939
},
40+
{
41+
"uuid": "425c2bff-675b-4e15-9d53-eb595d7632f9",
42+
"slug": "configlet/format",
43+
"path": "building/configlet/format.md",
44+
"title": "configlet fmt"
45+
},
4046
{
4147
"uuid": "d8d9ff53-fe8f-4333-80c5-87517433cf7d",
4248
"slug": "configlet/generating-documents",

building/configlet/format.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ An Exercism track repo has many JSON files, including:
1010

1111
These files are more readable if they have a consistent formatting Exercism-wide, and so configlet has a `fmt` command for rewriting a track's JSON files in a canonical form.
1212

13-
The `fmt` command currently only operates on the exercise `.meta/config.json` files, but it is likely to operate on all the track JSON files in the future.
13+
The `fmt` command currently operates on the exercise `.meta/config.json` files and the track `config.json` file, but it is likely to operate on all the track JSON files in the future.
1414

1515
## Usage
1616

@@ -31,7 +31,7 @@ Options for fmt:
3131
-y, --yes Auto-confirm the prompt from --update
3232
```
3333

34-
A plain `configlet fmt` makes no changes to the track and checks the formatting of the `.meta/config.json` file for every Concept Exercise and Practice Exercise.
34+
A plain `configlet fmt` makes no changes to the track and checks the formatting of the `.meta/config.json` file for every Concept Exercise and Practice Exercise and the track `config.json` file.
3535

3636
To print a list of paths for which there is not already a formatted exercise `.meta/config.json` file (exiting with a non-zero exit code if at least one exercise lacks a formatted config file):
3737

@@ -102,4 +102,4 @@ Note that `configlet fmt` only operates on exercises that exist in the track-lev
102102
Therefore if you are implementing a new exercise on a track and want to format its `.meta/config.json` file, please add the exercise to the track-level `config.json` file first.
103103
If the exercise is not yet ready to be user-facing, please set its `status` value to `wip`.
104104

105-
The exit code is 0 when every seen exercise has a formatted `.meta/config.json` file when configlet exits, and 1 otherwise.
105+
The exit code is 0 when every seen config file is formatted when configlet exits, and 1 otherwise.

0 commit comments

Comments
 (0)