Exercism V Track

Exercism exercises in V.

Testing

To test the exercises, run ./bin/test. This command will iterate over all exercises and check to see if their example implementation passes all the tests.

Track linting

configlet is an Exercism-wide tool for working with tracks. You can download it by running:

$ ./bin/fetch-configlet

Run its lint command to verify if all exercises have all the necessary files and if config files are correct:

$ ./bin/configlet lint

The lint command is under development.
Please re-run this command regularly to see if your track passes the latest linting rules.

Basic linting finished successfully:
- config.json exists and is valid JSON
- config.json has these valid fields:
    language, slug, active, blurb, version, status, online_editor, key_features, tags
- Every concept has the required .md files
- Every concept has a valid links.json file
- Every concept has a valid .meta/config.json file
- Every concept exercise has the required .md files
- Every concept exercise has a valid .meta/config.json file
- Every practice exercise has the required .md files
- Every practice exercise has a valid .meta/config.json file
- Required track docs are present
- Required shared exercise docs are present

Contributing

General Information (useful for all contributions)

Setting up V

See INSTALLATION.md

Style Guide:

Before committing, please run v fmt -w [FILE_NAME] on whatever file you're committing to ensure it is formatted properly. More info on V formatting can be found in the docs

In the comments section anywhere

Use conventional comments

Issues

Opening new issues is highly encouraged! To make the process as smooth as possible, please include as much information as possible about the issue. Better to have more information than not enough.

Pull requests

Please use conventional commits
If your PR is related to or fixes an open issue, please reference the issue number in the PR title. Here's an example.

How to get started contributing

A good place to start in the docs is to understand how the Hello World exercise is created. Make sure you've fetched configlet!

How to implement a new exercise from start to finish

There are two ways to implement a practice exercise. You can follow all the 13 steps listed below from start to finish, or you can run ./bin/bootstrap_practice_exercise.sh [SLUG] to create all the files and folders you'll need. This will allow you to skip a few steps and jump right into writing your example solution, but you'll need bash and jq to run the script.

Pick an exercise from the problem-specifications repo.
Create a new entry for the exercise in config.json. Include

a new UUID for the exercise (generated with bin/configlet uuid)
the slug of the exercise (should be the same as in problem-specifications)
the name of the exercise (should be the same as in problem-specifications)
any concepts it practices and prereqs it has (safe to leave blank usually!)
your best estimate of how difficult the task is

Create the directory for the exercise and download shared files using these two commands:

bin/configlet sync --update --yes --docs --metadata --exercise [SLUG]
bin/configlet sync --update --tests include --exercise [SLUG]

Create 3 files in the new directory (located at exercises/practice/[SLUG]):

run_test.v
[SLUG].v
.meta/example.v

Write an example implementation in [SLUG].v
Write a test suite in run_test.v based on the canonical data in problem-specifications. Here's an example of canonical data and here's the corresponding test suite.
Run the test suite with v -stats test run_test.v
Once all tests pass, make sure code is formatted properly with v fmt -w [V_FILE] on all the v files (example and test files)
Copypaste everything in [SLUG].v into .meta/example.v
Remove everything from [SLUG].v except the stub of the needed function, the module main at the top, and make a stub of a struct or two.
Add needed info to the ...[SLUG]/.meta/config.json file:

Author's GitHub username
solution file name (should be [SLUG].v)
test file name (should be run_test.v)
example solution file name (should be .meta/example.v)

Commit changes with conventional commits
Make your PR and do a little happy dance

Decision Records

(putting these here for now until someone tells me a better place or I find a better place)

How to handle module naming

See solution #3 in this excellent repo

Name of sample solutions

example.v

Name of testing script for each solution

run_test.v

"All test functions have to be inside a test file whose name ends in _test.v."

kivi/exercism-vlang