Implement Document Formatting #1732
Conversation
aslakhellesoy
added
⚡ enhancement
| describe('getGherkinFormattingEdits', () => { | ||
| it('returns text edits that prettifies a Gherkin document', () => { | ||
| const gherkinSource = `Feature: Hello | ||
| Scenario: World |
There was a problem hiding this comment.
What about using reindent-template-literals (as a dev dependency) to avoid breaking the indentation, as it is done with cucumber-js?
There was a problem hiding this comment.
The gherkinSource is intentionally unindented and the test verifies that it's indented after formatting.
Why do we need to worry about breaking indentation? (Not quite sure what you mean).
There was a problem hiding this comment.
I mean, the indentation in the test file itself is broken.
For example: cucumber/cucumber-js@dd62cbb#diff-7e7cef54343b7de585c12b93987ac29f464c8ec6e7dcb33fea9b969e507c1073
Before: the indentation in the file is hard to follow: https://github.com/cucumber/cucumber-js/blob/24ff9dc635ed25a32bdb6daf0028ecaf89569393/src/formatter/helpers/issue_helpers_spec.ts
After: the indentation has been fixed: https://github.com/cucumber/cucumber-js/blob/ad4a25b062c2d2922cbbba09712cc026e28fbd5a/src/formatter/helpers/issue_helpers_spec.ts
This is just a matter of readability
|
@aslakhellesoy is there anything that could be used directly under java / cucumber-jvm? |
Summary
Implement Gherkin Document formatting in language server / vscode extension / monaco plugin.
Details
The actual formatting is done by the
prettyfunction in@cucumber/gherkin-utilsMotivation and Context
People using an editor want to format their documents 😄
How Has This Been Tested?
With unit tests and manual testing of VSCode extension and monaco plugin.
Screenshots (if appropriate):
Before:
After:
Types of changes
Checklist: