Skip to content

docs: when not to use each rule #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 57 commits into from
Jan 6, 2025
Merged

docs: when not to use each rule #91

merged 57 commits into from
Jan 6, 2025

Conversation

@JasonWeinzierl
Copy link
Owner

@JasonWeinzierl JasonWeinzierl commented Dec 19, 2024 •
edited
Loading

Adds useful documentation like typescript-eslint's When Not To Use It section to each rule.

This also cleans up or expands on various existing rule documentation. This also adds a Resources section to each rule linking to the rule source and unit tests. This also tries to link related rules together in a Related To section.

Resolves #67

@github-actions
Copy link

github-actions bot commented Dec 19, 2024 •
edited
Loading

LCOV of commit 440d173 during .github/workflows/ci.yml #338

Summary coverage rate:
  lines......: 96.7% (4250 of 4396 lines)
  functions..: 96.1% (270 of 281 functions)
  branches...: 91.1% (932 of 1023 branches)

Files changed coverage rate: n/a

@JasonWeinzierl JasonWeinzierl force-pushed the 67-when-not-to-use-it branch 3 times, most recently from 0a27fd5 to de4435a Compare January 3, 2025 22:40
@JasonWeinzierl
docs(ban-operators): add missing code block closer
0d3913b
@JasonWeinzierl
docs(ban-observables): when not to use it
3c45406
@JasonWeinzierl
docs(ban-operators): when not to use it
adbbdad
@JasonWeinzierl
docs(finnish): when not to use it
5d9e12f
@JasonWeinzierl
docs(no-finnish): when not to use it
1021197
@JasonWeinzierl
docs(just): when not to use it
7a28d99
@JasonWeinzierl
docs(no-async-subscribe): when not to use it
61d44b9
@JasonWeinzierl
docs(no-connectable): when not to use it
98b5815
@JasonWeinzierl
docs(no-create): when not to use it
8d8b8b7
@JasonWeinzierl
docs(no-cyclic-action): when not to use it
6509aa8
@JasonWeinzierl
docs(no-explicit-generics): when not to use it
a297a90
@JasonWeinzierl
docs(no-exposed-subjects): when not to use it
87e3ea7
@JasonWeinzierl
docs(no-floating-observables): when not to use it
8d1e842
@JasonWeinzierl
docs(no-misused-observables): when not to use it
9b69169
@JasonWeinzierl
docs(no-ignored-default-value): when not to use it
8c8c3c6
@JasonWeinzierl
docs(no-ignored-error): when not to use it
dbb4505
@JasonWeinzierl
docs(no-ignored-notifier): when not to use it
eb5e508
@JasonWeinzierl
docs(no-ignored-replay-buffer): when not to use it
47a9090
@JasonWeinzierl
docs(no-ignored-subscribe): when not to use it
e8d5272
@JasonWeinzierl
docs(no-subscribe-handlers): when not to use it
7558ec9
@JasonWeinzierl
docs(no-ignored-subscription): when not to use it
c706a52
@JasonWeinzierl
docs(no-ignored-takewhile-value): when not to use it
663ecaf
@JasonWeinzierl
docs(no-implicit-any-catch): when not to use it
6811ef0
@JasonWeinzierl
chore(no-index): when not to use it
afd8ecf
@JasonWeinzierl
docs(no-internal): when not to use it
22fa1b8
@JasonWeinzierl
docs(no-nested-subscribe): when not to use it
20cbcfa
@JasonWeinzierl JasonWeinzierl marked this pull request as ready for review January 6, 2025 19:19
@JasonWeinzierl JasonWeinzierl mentioned this pull request Jan 6, 2025
Closed
@JasonWeinzierl JasonWeinzierl merged commit f4b16eb into main Jan 6, 2025
3 checks passed
@JasonWeinzierl JasonWeinzierl deleted the 67-when-not-to-use-it branch January 6, 2025 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add "When Not To Use It" to rule documentation

2 participants

@JasonWeinzierl