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.

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

lint: Add stub implementation #127

Merged
merged 2 commits into from
Jan 22, 2021
Merged

lint: Add stub implementation #127

merged 2 commits into from
Jan 22, 2021

Conversation

ErikSchierboom
Copy link
Member

This PR is based off #106, so it should only be merged after that PR is merged.

In this PR, a minimal stub implementation of the lint command is added. My goals with this PR are as follows:

  • Output a friendly error to tracks when they try to run configlet lint (which will be sooner rather than later)
  • Let tracks know that we're busy implementing the linting rules and that they thus need to re-run the check regularly
  • Provide a base for others to also start working on the linter. Admittedly, this doesn't help much at the moment, but it is a start.

I've deliberately not added any actual linting rule implementations or tests.

@ErikSchierboom ErikSchierboom force-pushed the lint-minimal branch 2 times, most recently from bd7044c to 3557a28 Compare January 21, 2021 11:52
src/lint/lint.nim Outdated Show resolved Hide resolved
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
@ee7
Copy link
Member

ee7 commented Jan 22, 2021

Approved, but we could add something about the WIP-status of lint to the README in the next PR.

The output of ./configlet --help regarding the lint options is a bit weird, but fine for now:

Usage:
  configlet [global-options] <command> [command-options]

Commands:
  lint, sync, uuid

Options for lint:

Options for sync:
  -e, --exercise <slug>        Only sync this exercise
  -c, --check                  Terminates with a non-zero exit code if one or more tests are missing. Doesn't update the tests
  -m, --mode <mode>            What to do with missing test cases. Allowed values: c[hoose], i[nclude], e[xclude]
  -p, --prob-specs-dir <dir>   Use this `problem-specifications` directory, rather than cloning temporarily
  -o, --offline                Do not check that the directory specified by `-p, --prob-specs-dir` is up-to-date

Options for uuid:
  -n, --num <int>              Number of UUIDs to generate

Global options:
  -h, --help                   Show this help message and exit
      --version                Show this tool's version information and exit
  -v, --verbosity <verbosity>  The verbosity of output. Allowed values: q[uiet], n[ormal], d[etailed]

@ErikSchierboom ErikSchierboom merged commit bef9cda into master Jan 22, 2021
@ErikSchierboom ErikSchierboom deleted the lint-minimal branch January 22, 2021 12:26
@ErikSchierboom
Copy link
Member Author

Agreed. Will be good to add something to the README.

ee7 added a commit to ee7/exercism-configlet that referenced this pull request Jan 22, 2021
The output of `configlet --help` contains an empty list of options for
`lint`, but that's fine for now.

Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants