Skip to content
This repository has been archived by the owner on May 30, 2023. It is now read-only.

Pass linting checks #29

Open
Tracked by #34
ErikSchierboom opened this issue Jan 29, 2021 · 3 comments
Open
Tracked by #34

Pass linting checks #29

ErikSchierboom opened this issue Jan 29, 2021 · 3 comments
Assignees
Labels
x:action/fix Fix an issue x:knowledge/elementary Little Exercism knowledge required x:size/medium Medium amount of work x:type/content Work on content (e.g. exercises, concepts)

Comments

@ErikSchierboom
Copy link
Member

ErikSchierboom commented Jan 29, 2021

This issue is part of the migration to v3. You can read full details about the various changes here.

The configlet tool has a lint command that checks if a track's configuration files are properly structured - both syntactically and semantically. Misconfigured tracks may not sync correctly, may look wrong on the website, or may present a suboptimal user experience, so configlet's guards play an important part in maintaining the integrity of Exercism.

We're updating configlet to work with v3 tracks, which have a different set of requirements than v2 tracks.

The full list of rules that will be checked by the linter can be found in this spec.

⚠ Note that only a subset of the linting rules has been implemented at this moment. This means that while your track may be passing the checks at this moment, it might fail later. We thus strongly suggest you keep this issue open until we let you know otherwise.

Goal

Ensure that the track passes all the (v3 track) checks defined in configlet lint.

To help verify that the track passes all the linting rules, the v3 preparation PR has added a GitHub Actions workflow that automatically runs configlet lint.

It is also possible to run configlet lint locally by running the ./bin/fetch-configlet (or ./bin/fetch-configlet.ps1) script to download a local copy of the configlet binary. Once downloaded, you can then do ./bin/configlet lint to run the linting on your own machine.

Tracking

exercism/v3-launch#3

@ErikSchierboom
Copy link
Member Author

⚠ The original issue did not explain that currently only a subset of the linting rules have been implemented. This means that while your track may be passing the checks at this moment, it might fail later. We (the Exercism team) thus strongly suggest you keep this issue open until we let you know otherwise. The issue's text has been updated to reflect this.

@LeaveNhA
Copy link
Member

I'm back. I'll sync up with you all and let you know about the developments.
Take care!

@LeaveNhA LeaveNhA self-assigned this Feb 25, 2021
@ErikSchierboom ErikSchierboom changed the title [v3] Pass linting checks Pass linting checks Aug 17, 2021
@ErikSchierboom ErikSchierboom added x:action/fix Fix an issue x:knowledge/elementary Little Exercism knowledge required x:size/medium Medium amount of work x:type/content Work on content (e.g. exercises, concepts) labels Aug 18, 2021
@LeaveNhA
Copy link
Member

  • The tags array is empty.
  • Some, Missing File, entries.
  • Missing directory, exercises/shared/.docs

I will take care of them, ASAP.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
x:action/fix Fix an issue x:knowledge/elementary Little Exercism knowledge required x:size/medium Medium amount of work x:type/content Work on content (e.g. exercises, concepts)
Projects
None yet
Development

No branches or pull requests

2 participants