Exercism V Track

Exercism exercises in V.

Important

We are not accepting community contributions at this time.

We love our community, and we're grateful you are interested in improving the V track. But our maintainers are not accepting community issues or pull requests at this time. If you would like to suggest a change or discuss an issue, please open a thread in the V section of the Exercism forum.

This community blog post contains more details.

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

Community contributions are currently paused (see above). The information below is for the track maintainers.

General Information (useful for all contributions)

Setting up V

See INSTALLATION.md

Style Guide:

Before committing, please run bin/reformat to ensure every V file is formatted properly. It runs v fmt -w [FILE_NAME] using the same version of V as the test runner. More info on V formatting can be found in the docs

In the comments section anywhere

Use conventional comments

Issues

Please raise problems and suggestions in the V section of the Exercism forum rather than opening issues here. To make the process as smooth as possible, please include as much information as possible about the issue.

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 14 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.

1. Pick an exercise from the problem-specifications repo.
2. 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

3. 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]

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

• [SLUG].v
• .meta/example.v
• .meta/test_generator.py

5. Write an example implementation in [SLUG].v
6. Write a test generator in .meta/test_generator.py. It will receive the canonical data in problem-specifications. Here's an example of canonical data.
7. Generate run_test.v by running generators/generate.py [SLUG]
8. Run the test suite with v -stats test run_test.v
9. Once all tests pass, make sure code is formatted properly by running bin/reformat, or v fmt -w [V_FILE] on all the v files (example and test files)
10. Copypaste everything in [SLUG].v into .meta/example.v
11. 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.
12. 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)

13. Commit changes with conventional commits
14. 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."