exercism / lines-of-code-counter

GNU Affero General Public License v3.0
1 stars 8 forks source link

include tokei.toml configuration file #105

Closed noah-clements closed 1 year ago

noah-clements commented 1 year ago

Currently the lines of code counter counts docstrings in certain languages such as python and julia as code. See https://github.com/XAMPPRocky/tokei/issues/763 (julia), https://github.com/XAMPPRocky/tokei/issues/413 (python - there are other issue #s)

This can be solved by including a simple tokei.toml file that has a count docstrings as comments setting:

# Any doc strings (e.g. `"""hello"""` in python) will be counted as comments.
treat_doc_strings_as_comments = true 

This is the tokei canonical way to change the default configuration. See the readme section on configuration

I don't think this will help clojure - see https://github.com/XAMPPRocky/tokei/issues/229 and I don't know whether this issue exists for other languages, but this is an official tokei setting that could be useful.

There are many python exercises that have docstrings in the stub file - useful so that you don't have to keep switching to the readme. The current situation makes a solution that kept the exercism docstring comments seem much longer than one where the user deleted those docstrings. I think docstrings are useful.

This fix could be implemented by putting a line in the dockerfile to copy over a simple tokei.toml file as above into the directory from which tokei is run (the working directory?)

github-actions[bot] commented 1 year ago

Hello. Thanks for opening an issue on Exercism. We are currently in a phase of our journey where we have paused community contributions to allow us to take a breather and redesign our community model. You can learn more in this blog post. As such, all issues and PRs in this repository are being automatically closed.

That doesn't mean we're not interested in your ideas, or that if you're stuck on something we don't want to help. The best place to discuss things is with our community on the Exercism Community Forum. You can use this link to copy this into a new topic there.


Note: If this issue has been pre-approved, please link back to this issue on the forum thread and a maintainer or staff member will reopen it.