Skip to content

Commit 826f9e8

Browse files
authored
Update README.md (#138)
I looked at the README and I decided that the headings too long, so I tidied that up a bit.
1 parent 746edde commit 826f9e8

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,33 +43,39 @@ Example `.eslintrc`:
4343

4444
## Configurations
4545

46-
This package exposes multiple configurations for your usage. Each configuration listed below is available for both JavaScript projects (no suffix) and TypeScript projects (with `-ts` suffix).
46+
This package exposes multiple configurations for your usage. Each configuration listed below is available for both JavaScript projects and TypeScript projects (when using `-ts` suffix).
4747

48-
### `@salesforce/eslint-config-lwc/base` and `@salesforce/eslint-config-lwc/base-ts` configurations
48+
### `@salesforce/eslint-config-lwc/base`
4949

5050
**Goal:**
5151
Prevent common pitfalls with LWC, and enforce other Salesforce platform restrictions.
5252

5353
**Rules:**
5454
[_LWC specific rules_](https://github.com/salesforce/eslint-plugin-lwc/blob/master/README.md#lwc) only.
5555

56-
### `@salesforce/eslint-config-lwc/recommended` and `@salesforce/eslint-config-lwc/recommended-ts` configurations
56+
**TypeScript:** Use `@salesforce/eslint-config-lwc/base-ts` to use this config in TypeScript projects.
57+
58+
### `@salesforce/eslint-config-lwc/recommended`
5759

5860
**Goal:**
5961
Prevent common Javascript pitfalls and enforce all best practices.
6062

6163
**Rules:**
6264
`@salesforce/eslint-config-lwc/base` rules + Most of the base [_Potential errors_](https://eslint.org/docs/rules/#possible-errors) rules + Some of the [_Best Practices_](https://eslint.org/docs/rules/#best-practices) rules + [_LWC Best Practices_](https://github.com/salesforce/eslint-plugin-lwc/blob/master/README.md#best-practices).
6365

64-
### `@salesforce/eslint-config-lwc/extended` and `@salesforce/eslint-config-lwc/extended-ts` configurations
66+
**TypeScript:** Use `@salesforce/eslint-config-lwc/recommended-ts` to use this config in TypeScript projects.
67+
68+
### `@salesforce/eslint-config-lwc/extended`
6569

6670
**Goal:**
6771
Restrict usage of some Javascript language features known to be slow after the _COMPAT_ transformation. LWC runs in _COMPAT_ mode on older browsers (eg. IE11). To support new Javascript syntax and language features on older browser the LWC compiler transforms LWC modules. This linting configuration targets patterns known to be slow in _COMPAT_ mode.
6872

6973
**Rules:**
7074
`@salesforce/eslint-config-lwc/recommended` rules + restrict usage of some slow patterns in [_COMPAT_](https://github.com/salesforce/eslint-plugin-lwc/blob/master/README.md#compat-performance).
7175

72-
### `@salesforce/eslint-config-lwc/i18n` and `@salesforce/eslint-config-lwc/i18n-ts` configurations
76+
**TypeScript:** Use `@salesforce/eslint-config-lwc/extended-ts` to use this config in TypeScript projects.
77+
78+
### `@salesforce/eslint-config-lwc/i18n`
7379

7480
**Goal:**
7581
Promote usage of `@salesforce/i18n-service` over 3rd parties, promote internationalization (I18N) best practices.
@@ -87,7 +93,9 @@ Add the `i18n` configuration to the `extends` field in your `.eslintrc` configur
8793
}
8894
```
8995

90-
### `@salesforce/eslint-config-lwc/ssr` and `@salesforce/eslint-config-lwc/ssr-ts` configurations
96+
**TypeScript:** Use `@salesforce/eslint-config-lwc/i18n-ts` to use this config in TypeScript projects.
97+
98+
### `@salesforce/eslint-config-lwc/ssr`
9199

92100
**Goal:**
93101
Promote writing server-side-rendering friendly components. We only recommend using this configuration if your components are running in experiences supporting LWC server-side-rendering.
@@ -104,3 +112,5 @@ Add the `ssr` configuration to the `extends` field in your `.eslintrc` configura
104112
"extends": ["@salesforce/eslint-config-lwc/recommended", "@salesforce/eslint-config-lwc/ssr"]
105113
}
106114
```
115+
116+
**TypeScript:** Use `@salesforce/eslint-config-lwc/ssr-ts` to use this config in TypeScript projects.

0 commit comments

Comments
 (0)