@freehour/eslint-rules 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -28,7 +28,19 @@ export default defineConfig(
28
28
  files: ['**/*.{ts,tsx}'],
29
29
  },
30
30
  );
31
+ ```
32
+ The ESLint rules are designed to be compatible with the following TypeScript compiler options. Make sure to set them in your `tsconfig.json`:
31
33
 
34
+ ```jsonc
35
+ {
36
+ "compilerOptions": {
37
+ "exactOptionalPropertyTypes": false, // optional, but recommended
38
+ "noFallthroughCasesInSwitch": true,
39
+ "noImplicitOverride": true,
40
+ "noImplicitReturns": true,
41
+ }
42
+ }
43
+ ```
32
44
 
33
45
  ### Auto-fixing
34
46
 
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "private": false,
4
4
  "displayName": "eslint-rules",
5
5
  "description": "ESLint rules for TypeScript projects.",
6
- "version": "1.0.0",
6
+ "version": "1.0.1",
7
7
  "type": "module",
8
8
  "repository": {
9
9
  "type": "git",