lint: add initial checks for approaches and articles #704
Conversation
There is not yet a formal spec for an approach `config.json` file or an article `config.json` file, but I've tried to implement linting them from the docs for approaches [1][2] and a commit [3] on the csharp track. [1] https://github.com/exercism/docs/blob/5509b2f12fac/building/tracks/concept-exercises.md#file-approachesconfigjson [2] https://github.com/exercism/docs/blob/5509b2f12fac/building/tracks/practice-exercises.md#file-approachesconfigjson [3] exercism/csharp@4069cca97782
src/lint/approaches_and_articles.nim
Outdated
| DirKind = enum | ||
| dkApproaches = "approaches" | ||
| dkArticles = "articles" |
There was a problem hiding this comment.
DirKind isn't a great name. Do we have a name for something that is an approach or article?
There was a problem hiding this comment.
They are part of the Dig Deeper section, maybe something like that?
There was a problem hiding this comment.
We could do something like DigDeeperKind, but then dots in the enum string representations are bad.
If this is blocking, please suggest a name.
There was a problem hiding this comment.
DigDeeperDirKind? That's bad too. This is not blocking
Make `configlet lint` produce an error for a snippet with 8 newline
characters then non-newline content on the 9th line, e.g.:
1\n2\n3\n4\n5\n6\n7\n8\n9
Note that this means we do not count lines like `wc`:
$ printf '1\n2\n3\n4\n5\n6\n7\n8' | wc -l
7
$ printf '1\n2\n3\n4\n5\n6\n7\n8\n' | wc -l
8
$ printf '1\n2\n3\n4\n5\n6\n7\n8\n9' | wc -l
8
$ printf '1\n2\n3\n4\n5\n6\n7\n8\n9\n' | wc -l
9
| result = 0 | ||
| if s.len > 0: | ||
| for line in s.splitLines(): | ||
| if not (line.startsWith("```") and dk == dkArticles): |
There was a problem hiding this comment.
Does not handle the fact that a code fence can begin with ~~~
There was a problem hiding this comment.
That's probably perfectly fine
|
We currently output: - Every practice exercise has the required .md files
- Every practice exercise has a valid .meta/config.json fileWould it perhaps be useful here to also add that we're checking articles and approaches? |
|
I'll PR for the errors in csharp and rust. Edit: At the time of writing, the only other tracks with approaches/articles in |
OK - 6747ce1. Feel free to bikeshed the wording. In general I don't love the summary message, though. I've considered linking to #249. Things would be better with a refactor that defines all the implemented checks and their error messages in one places. |
I agree. That would be a lot more convenient. |
|
I've found that for both approaches and articles, the files within those directory are not checked. I could rename |
Ok. Is the below the logic that we want in the spec?
|
I'd make this more strict and have it be:
|
|
But yes, that sounds good! |
Try to implement these checks for `.approaches/config.json`
- If the `introduction.authors` array is non-empty, there must be a non-empty `introduction.md` file
- Any `approaches.slug` value must have a corresponding non-empty `<slug>/content.md` file
- Any `approaches.slug` value must have a corresponding non-empty `<slug>/snippet.txt` file
And these checks for `.articles/config.json`
- Any `articles.slug` value must have a corresponding non-empty `<slug>/content.md` file
- Any `articles.slug` value must have a corresponding non-empty `<slug>/snippet.md` file
Some output:
$ configlet lint
[...]
The config.json 'introduction' object is present, but there is no corresponding introduction file at the below location:
./exercises/practice/bob/.approaches/introduction.md
A config.json 'approaches.slug' value is 'if', but there is no corresponding content file at the below location:
./exercises/practice/bob/.approaches/if/content.md
A config.json 'approaches.slug' value is 'answer-array', but there is no corresponding snippet file at the below location:
./exercises/practice/bob/.approaches/answer-array/snippet.txt
A config.json 'articles.slug' value is 'performance', but there is no corresponding content file at the below location:
./exercises/practice/bob/.articles/performance/content.md
A config.json 'articles.slug' value is 'performance', but there is no corresponding snippet file at the below location:
./exercises/practice/bob/.articles/performance/snippet.md
|
Please take another look. Sample output: $ configlet lint
[...]
The config.json 'introduction' object is present, but there is no corresponding introduction file at the below location:
./exercises/practice/bob/.approaches/introduction.md
A config.json 'approaches.slug' value is 'if', but there is no corresponding content file at the below location:
./exercises/practice/bob/.approaches/if/content.md
A config.json 'approaches.slug' value is 'answer-array', but there is no corresponding snippet file at the below location:
./exercises/practice/bob/.approaches/answer-array/snippet.txt
A config.json 'articles.slug' value is 'performance', but there is no corresponding content file at the below location:
./exercises/practice/bob/.articles/performance/content.md
A config.json 'articles.slug' value is 'performance', but there is no corresponding snippet file at the below location:
./exercises/practice/bob/.articles/performance/snippet.md |
|
See https://github.com/exercism/docs/pull/406/files for an attempt at defining the linting rules |
That looks great! The only thing that I'm missing is that if there is a sub-directory for an article or approach but no entry in the |
Example output:
$ configlet lint
[...]
There is no 'approaches.slug' key with the value 'performance', but a sibling directory exists with that name:
../exercism-tracks/csharp/exercises/practice/reverse-string/.approaches/config.json
OK - please take another look. |
No, nor for Ruby. Nor for open PRs that add articles/approaches on those tracks. However, I have not run
would make the |
|
I think that's fine. We'll fix them later |
Appease nimpretty.
ee7
changed the title
There is not yet a formal spec for an approach
config.jsonfile or an articleconfig.jsonfile, but I've tried to implement linting them from the docs for concept exercises and practice exercises (which talk about approaches) and a commit on the csharp track.