lint(concepts): implement links.json checks
#171
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ee7
force-pushed
the
lint-concepts-links
branch
from
a6661ea
to
f61a34b
Compare
ee7
force-pushed
the
lint-concepts-links
branch
2 times, most recently
from
655ff42
to
67d2eea
Compare
|
@ErikSchierboom Just to confirm, what should
In the future we could detect empty files and print a better error message.
but it should't complain about this, right? |
ee7
force-pushed
the
lint-concepts-links
branch
from
67d2eea
to
b9d8f0f
Compare
That is an error.
That's fine. |
ee7
force-pushed
the
lint-concepts-links
branch
from
b9d8f0f
to
1aa14a7
Compare
Done. This PR now causes the following diff to the Tracks that no longer exit with 0clojure+File is empty, but must contain at least the empty array, `[]`:
+./concepts/basics/links.json
+haxeThese files are an object at the top level, see e.g. https://github.com/exercism/haxe/blob/717a4d3cd01ad1c8439501b64b9c3ff46b3f59e7/concepts/abstract-types/links.json +Not an array: root:
+./concepts/abstract-types/links.json
+
+Not an array: root:
+./concepts/array-comprehension/links.json
+
+Not an array: root:
+./concepts/arrays/links.json
+
+Not an array: root:
+./concepts/basics/links.json
+
+Not an array: root:
+./concepts/bit-manipulation/links.json
+
+Not an array: root:
+./concepts/chars/links.json
+
+Not an array: root:
+./concepts/classes/links.json
+
+Not an array: root:
+./concepts/constructors/links.json
+
+Not an array: root:
+./concepts/datetimes/links.json
+
+Not an array: root:
+./concepts/do-while-loops/links.json
+
+Not an array: root:
+./concepts/enums/links.json
+
+Not an array: root:
+./concepts/equality/links.json
+
+Not an array: root:
+./concepts/exceptions/links.json
+
+Not an array: root:
+./concepts/final/links.json
+
+Not an array: root:
+./concepts/flag-enums/links.json
+
+Not an array: root:
+./concepts/floating-point-numbers/links.json
+
+Not an array: root:
+./concepts/for-loops/links.json
+
+Not an array: root:
+./concepts/foreach-loops/links.json
+
+Not an array: root:
+./concepts/generic-types/links.json
+
+Not an array: root:
+./concepts/if-statements/links.json
+
+Not an array: root:
+./concepts/indexers/links.json
+
+Not an array: root:
+./concepts/inheritance/links.json
+
+Not an array: root:
+./concepts/integral-numbers/links.json
+
+Not an array: root:
+./concepts/interfaces/links.json
+
+Not an array: root:
+./concepts/iterators/links.json
+
+Not an array: root:
+./concepts/lambda/links.json
+
+Not an array: root:
+./concepts/lists/links.json
+
+Not an array: root:
+./concepts/maps/links.json
+
+Not an array: root:
+./concepts/nullability/links.json
+
+Not an array: root:
+./concepts/numbers/links.json
+
+Not an array: root:
+./concepts/operator-overloading/links.json
+
+Not an array: root:
+./concepts/option-type/links.json
+
+Not an array: root:
+./concepts/optional-arguments/links.json
+
+Not an array: root:
+./concepts/pattern-matching/links.json
+
+Not an array: root:
+./concepts/properties/links.json
+
+Not an array: root:
+./concepts/randomness/links.json
+
+Not an array: root:
+./concepts/reflection/links.json
+
+Not an array: root:
+./concepts/regular-expressions/links.json
+
+Not an array: root:
+./concepts/rest-args/links.json
+
+Not an array: root:
+./concepts/string-buffer/links.json
+
+Not an array: root:
+./concepts/switch-expressions/links.json
+
+Not an array: root:
+./concepts/templates/links.json
+
+Not an array: root:
+./concepts/ternary-operators/links.json
+
+Not an array: root:
+./concepts/throw-expressions/links.json
+
+Not an array: root:
+./concepts/time/links.json
+
+Not an array: root:
+./concepts/typedefs/links.json
+
+Not an array: root:
+./concepts/using-statements/links.json
+
+Not an array: root:
+./concepts/while-loops/links.jsonjava
+Missing key: 'url':
+./concepts/for-loops/links.json
+
+Missing key: 'url':
+./concepts/foreach-loops/links.jsonpythonInvalid capitalization of the +Missing key: 'url':
+./concepts/numbers/links.jsonruby+
+File is empty, but must contain at least the empty array, `[]`:
+./concepts/enumeration/links.json
+
+File is empty, but must contain at least the empty array, `[]`:
+./concepts/exceptions/links.json
+
+File is empty, but must contain at least the empty array, `[]`:
+./concepts/ostruct/links.jsonswift+
+Missing file:
+./concepts/characters/links.json
+
+Missing file:
+./concepts/classes/links.json
+
+Missing file:
+./concepts/initializers/links.json
+
+Missing file:
+./concepts/opaque-indices/links.json
+
+Missing key: 'url':
+./concepts/shorthand-arguments/links.json
+
+Missing key: 'description':
+./concepts/shorthand-arguments/links.json
+
+Missing file:
+./concepts/strings/links.json
+
+Missing file:
+./concepts/structs/links.json |
ErikSchierboom
approved these changes
Mar 19, 2021
| if not checkString(data, "description", path): | ||
| result = false | ||
|
|
||
| if data.hasKey("icon_url"): |
There was a problem hiding this comment.
Do you need this call? Doesn't checkString gracefully handle optional values?
There was a problem hiding this comment.
Do you need this call?
With the current checkString, unfortunately yes.
The full context is:
if data.hasKey("icon_url"):
if checkString(data, "icon_url", path, isRequired = false):
let s = data["icon_url"].getStr()icon_url is optional, so we call checkString with isRequired = false. That means that checkString returns true if icon_url is missing, which means the data["icon_url"].getStr() would throw an exception if we don't have the first line.
It is indeed pretty ugly, and we're performing hasKey twice.
In the future I'm thinking about splitting checkString into hasString and isString (and the same for checkBoolean, and checkInteger), similar to the previous split of checkArray into hasArray and isArray.
We can do without this optimization - about 97% of the URLs in `links.json` files so far start with `https://` anyway.
ee7
changed the title
links.jsonlinks.json checks
BethanyG
added a commit
to exercism/python
that referenced
this pull request
Mar 19, 2021
`URL` --> `url. Python had a configlet linting error : `Invalid capitalization of the url key:`, as referenced in exercism/configlet#171. This fixes that error.
BethanyG
added a commit
to exercism/python
that referenced
this pull request
Mar 20, 2021
`URL` --> `url. Python had a configlet linting error : `Invalid capitalization of the url key:`, as referenced in exercism/configlet#171. This fixes that error.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements the
concept/<slug>/links.jsonpart of the spec:To-do:
config.json#169 and rebase this PR on topisEveryConceptLinksFileValidfromlint.nimconfiglet lintoutput on every track