configlet

README

Configlet

A linter for exercism language track repositories.

The API that delivers language-specific exercism problems makes certain assumptions. Configlet makes it simple to verify up-front that the changes to existing problems or the addition of new problems will play nicely with the API.

There are three common problems that occur:

1. The config.json might be invalid.
2. Problems might be missing a reference solution.
3. Problems might be implemented (test suite + reference solution), but not configured.
4. Slugs in the configuration might not have a corresponding problem.

Usage

$ configlet path/to/problem/repository

If you have installed the configlet binary and are at the root of an exercism language track, then you can run the following:

$ configlet .

License

The MIT License (MIT)

Copyright (c) 2015 Katrina Owen, _@kytrinyx.com

Documentation

Overview

Command configlet sanity-checks Exercism track configuration.

The binary is distributed with each track repository. The repositories are located at github.com/exercism/x<TRACK>.

The command also runs on Travis-CI.

See http://exercism.io for more information about the project.

Compile the CLI:

$ go build -o out/configlet

Run the command:

$ path/to/configlet path/to/track

Cross-compile using the build script:

$ bin/build

To verify the command, use the fixture files:

$ go build -o out/configlet
$ out/configlet configlet/fixtures/track

The command should exit with status 1, and output a list of issues.