OpenAPITools / OpenAPITools/openapi-generator
[REQ] typescript/JS service methods with finnish notation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
In javascript/typescript, lots of projects I encountered implement and enforce Finnish Notation for RxJS methods/properties that return Observables.
This means: service-methods/variables/properties that return an observable end with a '$' in their name.
e.g.:
public loadFoo$(): Observable<Foo>
instead of
public loadFoo(): Observable<Foo>
Describe the solution you'd like
It would be nice to have this naming convention configurable via command line switches.
Describe alternatives you've considered
Altering the provided templates works, but is tedious work for such a widespread convention.
Additional context
Contributor guide
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
Start by reviewing the provided JavaScript/TypeScript templates and the command-line switch handling. Determine how a configurable Finnish-notation option should apply to service methods, variables, and properties that return Observables; done means generated names follow the selected convention without manually altering templates.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100