Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix configlet link #491

Merged
merged 2 commits into from
Feb 20, 2024
Merged

fix configlet link #491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f0a868
Add missing configlet format entry
ErikSchierboom Feb 20, 2024
4e7c91f
Improve configlet format documentation
ErikSchierboom Feb 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions building/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@
"path": "building/configlet/create.md",
"title": "configlet create"
},
{
"uuid": "425c2bff-675b-4e15-9d53-eb595d7632f9",
"slug": "configlet/format",
"path": "building/configlet/format.md",
"title": "configlet fmt"
},
{
"uuid": "d8d9ff53-fe8f-4333-80c5-87517433cf7d",
"slug": "configlet/generating-documents",
Expand Down
6 changes: 3 additions & 3 deletions building/configlet/format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ An Exercism track repo has many JSON files, including:

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.

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.
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.

## Usage

Expand All @@ -31,7 +31,7 @@ Options for fmt:
-y, --yes Auto-confirm the prompt from --update
```

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.
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.

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):

Expand Down Expand Up @@ -102,4 +102,4 @@ Note that `configlet fmt` only operates on exercises that exist in the track-lev
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.
If the exercise is not yet ready to be user-facing, please set its `status` value to `wip`.

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