rokucommunity / rokucommunity/brighterscript-formatter
interDeclarationSpacing
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 17
- Forks
- 10
- Avg merge
- 49m
- Merged PRs (30d)
- 7
Description
Enforce consistent newlines between top level declarations. This is for the space between declarations, and does not affect newlines at start of file or end of file.
The option should be called:
interDeclarationSpacing
and it'll have:
- "original" - don't change anything
- a number represents the number of newlines that should be enforce between each declaration
When enabled, it will:
- enforce exactly 1 empty line between each declaration
- groups of comments should be included without newlines inside of them
- comments right before a declaration (function, etc) should be right next to the function.
- collapse multiple newlines into single newline
- add newlines when missing
When enforcing
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.
Research direction
The issue defines the interDeclarationSpacing option and its expected newline and comment behavior, but names no files, tests, or entry points and ends mid-requirement. First clarify the unfinished requirements and locate the formatter code that handles top-level declarations; done means the option supports "original" and numeric spacing without changing file-edge newlines.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100