Examine possible usage of Fantomas
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- fsharp
- Domain
- tooling
Research direction
Start by reviewing the repository's F# generator code, test suites, examples, and stub implementations, then read Fantomas's CLI/API documentation and the referenced integration article. Done means determining whether Fantomas is useful and documenting or implementing a chosen integration approach, including any required generator formatting changes.
Written by the indexing model from the issue text.
Description
The Fantomas library allows one to format F# code using a pre-defined set of coding guidelines. We should investigate to see if it is useful to integrate Fantomas in our projects. I can envision two approaches:
- Use the CLI tool to format all of the F# code in this repository: https://github.com/fsprojects/fantomas#command-line-tool--api. This means that not only will our test generator code be consistently formatted, all the tests suites, example and stub implementations will also have the same formatting, which is beneficial for students. Note: this may require some changes to the format in which the generator outputs the test suites, to have it conform to the Fantomas style.
- Add Fantomas as a CLI tool reference to each exercise's project: https://blog.nojaf.com/2018/05/03/fantomas-rejuvenated/ This will give students the ability to quickly format their code.
- Dominant language
- F#
- Stars
- 118
- Forks
- 113
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from exercism/fsharp
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Difficulty 5/5 Over a week Newbie friendliness 18/100
-
exercism/fsharp#1173 · 1 comment · 2 reactions · 1 assignee ·
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
use-agent-os/agent-os#3314 ·
-
documentation low-priority templates
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
jesseray718/openroot#87 ·
-
factory-active factory-automatic task-bug-reproduction-cannot-reproduce task-identify-harness-labels-done task-identify-issue-type-done
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
danielmiessler/LifeOS#2218 ·
-
in-progress proposal
Difficulty 1/5 Under an hour Newbie friendliness 88/100
uibcdf/molsyssuite#36 ·