@@ -8,5 +8,33 @@ If the student submitted a test file, those will be ignored.
8
8
While this works well for most submissions, some tracks might need to ignore additional files.
9
9
For that, we'll allow the Lines of Code Counter to be [ customized per track] [ lines-of-code-counter-customize ] .
10
10
11
+ ## Implementation
12
+
13
+ We're using the [ tokei] [ tokei ] library to do the actual counting.
14
+ As pull requests are often not merged quickly, we've created our own [ fork] [ tokei-fork ] .
15
+ This allows us to iterate more quickly and add support for any language we want.
16
+
17
+ ## Supported languages
18
+
19
+ You can check to see if your language is supported out of the box by looking it up in the [ languages.json] [ languages.json ] file.
20
+
21
+ ### Adding new language
22
+
23
+ If your language is ** not** supported, you can add support by:
24
+
25
+ 1 . Adding an entry for your language to the [ languages.json] file.
26
+ Check the [ language addition docs] [ adding-language ] for more information.
27
+ 2 . Adding tests to verify counting works correctly for your language.
28
+ Check the [ adding tests docs] [ adding-tests ] for more information.
29
+
30
+ Once you've made these changes, open a pull request to the [ exercism/tokei repository] [ tokei-fork ] .
31
+ Here is an [ example pull request] [ example-pr ] that adds support for the Arturo language.
32
+
11
33
[ lines-of-code-counter ] : https://github.com/exercism/lines-of-code-counter/
12
34
[ lines-of-code-counter-customize ] : https://github.com/exercism/lines-of-code-counter/#ignore-additional-files
35
+ [ languages.json ] : https://github.com/exercism/tokei/blob/master/languages.json
36
+ [ tokei ] : https://github.com/XAMPPRocky/tokei
37
+ [ tokei-fork ] : https://github.com/exercism/tokei
38
+ [ example-pr ] : https://github.com/exercism/tokei/pull/14/files
39
+ [ adding-language ] : https://github.com/exercism/tokei/blob/master/CONTRIBUTING.md#language-addition
40
+ [ adding-tests ] : https://github.com/exercism/tokei/blob/master/CONTRIBUTING.md#tests
0 commit comments