loopbackio / loopbackio/loopback-next
eslint: forbid boolean function arguments
@achrinza arbeitet bereits daran.
Seit 02.12.2021.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 5.1k
- Forks
- 1.1k
- Ø Merge
- 2 T. 21 Std.
- Gemergte PRs (30 T.)
- 27
Beschreibung
Function arguments of type boolean are considered as a bad practice because they make the code difficult to read and reason about.
Consider the following code:
ctx.getBinding('repositories.todo', true);
What does the true flag mean? There is no way to tell when reading the code using the function, we have to look up the API definition and/or implementation to understand.
Compare with the current implementation which is following the best practices:
ctx.getBinding('repositories.todo', {optional: true});
Now it's more clear that we want to treat the binding as optional and don't trigger an error when it's not found.
Let's improve our eslint configuration to automatically detect and reject boolean arguments. Eslint rule to use: no-inferrable-types
Further reading:
Acceptance criteria
- A commit modifying our eslint configuration to enable the new check. This is a breaking change, see Describe incompatibilites for release notes
- One or more commits fixing any violations of this new rule in our existing code. For functions (methods) that are part our public API, decide whether to disable this rule via a code comment, change the method signature in a breaking (semver-major) change or implement both variants (with an options arg, with a boolean arg for backwards compatibility) to avoid a breaking change.
Breaking changes must be committed in such way that they don't trigger semver-major release of packages that are not affected.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Bewertung
Dieses Issue wurde noch nicht bewertet.