https://github.com/exercism/vimscript

Exercism exercises in Vim script.
https://github.com/exercism/vimscript

community-contributions-paused exercism-track

Last synced: 3 months ago
JSON representation

Exercism exercises in Vim script.

• Host: GitHub
• URL: https://github.com/exercism/vimscript
• Owner: exercism
• License: mit
• Created: 2017-02-20T22:12:38.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-04-24T18:26:38.000Z (about 1 year ago)
• Last Synced: 2024-05-01T11:25:37.025Z (about 1 year ago)
• Topics: community-contributions-paused, exercism-track
• Language: Vim Script
• Homepage: https://exercism.org/tracks/vimscript
• Size: 538 KB
• Stars: 21
• Watchers: 8
• Forks: 24
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Exercism Vim script Track

[![Configlet](https://github.com/exercism/vimscript/actions/workflows/configlet.yml/badge.svg)](https://github.com/exercism/vimscript/actions/workflows/configlet.yml)

![Exercise Test Status](https://github.com/exercism/vimscript/workflows/vimscript%20%2F%20main/badge.svg)

We welcome any kind of contribution!

If you have a suggestion or question, create a new

[issue](https://github.com/exercism/vimscript/issues).

For code or fixing typos and similar things, open a

[pull request](https://github.com/exercism/vimscript/pulls).

Look at recent [commits](https://github.com/exercism/vimscript/commits/master)

to get a feeling on how to format your own ones.

Even if there are any uncertainties, go for it nevertheless. We can straighten

out everything in the process.

Thank you for contributing! :tada:

## Linting Vim files

If you add or change a Vim file, the CI will use vint to ensure best practices.

Therefore it's recommended idea to run it locally first, before creating a pull

request.

1. Install [vint](https://github.com/Kuniwak/vint#quick-start).

1. Recursively lint all Vim files:

    ```

    $ vint .

    ```

## Writing test files

### Generating test files

Use the [generator](lib/generate.vim) to create Vader files from their canonical

test data:

```vim

" in Vim

:source lib/generate.vim

:Generate word-count

```

This would fetch the [canonical test data](https://raw.githubusercontent.com/exercism/x-common/master/exercises/word-count/canonical-data.json),

decode the JSON to Vim data types, iterate over the result, and put the tests in

a new unnamed buffer.