chore: fix docs

JamesHenry · JamesHenry · commit ced9d4eee039 · 2024-11-30T00:41:18.000+04:00
diff --git a/packages/eslint-plugin/docs/rules/prefer-signals.md b/packages/eslint-plugin/docs/rules/prefer-signals.md
@@ -837,70 +837,6 @@ class Test {
 
 <br>
 
-#### Custom Config
-
-```json
-{
-  "rules": {
-    "@angular-eslint/prefer-signals": [
-      "error",
-      {
-        "typesToReplace": []
-      }
-    ]
-  }
-}
-```
-
-<br>
-
-#### ✅ Valid Code
-
-```ts
-class Test {
-  noTypesToReplace = new BehaviorSubject();
-}
-```
-
-<br>
-
----
-
-<br>
-
-#### Custom Config
-
-```json
-{
-  "rules": {
-    "@angular-eslint/prefer-signals": [
-      "error",
-      {
-        "typesToReplace": [
-          "CustomType"
-        ]
-      }
-    ]
-  }
-}
-```
-
-<br>
-
-#### ✅ Valid Code
-
-```ts
-class Test {
-  customTypesToReplace = new BehaviorSubject();
-}
-```
-
-<br>
-
----
-
-<br>
-
 #### Default Config
 
 ```json
@@ -1470,7 +1406,7 @@ class Test {
     "@angular-eslint/prefer-signals": [
       "error",
       {
-        "preferReadonly": false
+        "preferReadonlySignalProperties": false
       }
     ]
   }
@@ -1661,7 +1597,7 @@ class Test {
     "@angular-eslint/prefer-signals": [
       "error",
       {
-        "preferInputSignal": false
+        "preferInputSignals": false
       }
     ]
   }
@@ -1721,7 +1657,7 @@ class Test {
     "@angular-eslint/prefer-signals": [
       "error",
       {
-        "preferQuerySignal": false
+        "preferQuerySignals": false
       }
     ]
   }
@@ -1781,7 +1717,7 @@ class Test {
     "@angular-eslint/prefer-signals": [
       "error",
       {
-        "preferQuerySignal": false
+        "preferQuerySignals": false
       }
     ]
   }
@@ -1841,7 +1777,7 @@ class Test {
     "@angular-eslint/prefer-signals": [
       "error",
       {
-        "preferQuerySignal": false
+        "preferQuerySignals": false
       }
     ]
   }
@@ -1901,7 +1837,7 @@ class Test {
     "@angular-eslint/prefer-signals": [
       "error",
       {
-        "preferQuerySignal": false
+        "preferQuerySignals": false
       }
     ]
   }

Original file line number	Diff line number	Diff line change
`@@ -837,70 +837,6 @@ class Test {`
`837`	`837`
`838`	`838`	`<br>`
`839`	`839`
`840`		`-#### Custom Config`
`841`		`-`
`842`		-```json
`843`		`-{`
`844`		`- "rules": {`
`845`		`- "@angular-eslint/prefer-signals": [`
`846`		`- "error",`
`847`		`- {`
`848`		`- "typesToReplace": []`
`849`		`- }`
`850`		`- ]`
`851`		`- }`
`852`		`-}`
`853`		-```
`854`		`-`
`855`		`-<br>`
`856`		`-`
`857`		`-#### ✅ Valid Code`
`858`		`-`
`859`		-```ts
`860`		`-class Test {`
`861`		`- noTypesToReplace = new BehaviorSubject();`
`862`		`-}`
`863`		-```
`864`		`-`
`865`		`-<br>`
`866`		`-`
`867`		`----`
`868`		`-`
`869`		`-<br>`
`870`		`-`
`871`		`-#### Custom Config`
`872`		`-`
`873`		-```json
`874`		`-{`
`875`		`- "rules": {`
`876`		`- "@angular-eslint/prefer-signals": [`
`877`		`- "error",`
`878`		`- {`
`879`		`- "typesToReplace": [`
`880`		`- "CustomType"`
`881`		`- ]`
`882`		`- }`
`883`		`- ]`
`884`		`- }`
`885`		`-}`
`886`		-```
`887`		`-`
`888`		`-<br>`
`889`		`-`
`890`		`-#### ✅ Valid Code`
`891`		`-`
`892`		-```ts
`893`		`-class Test {`
`894`		`- customTypesToReplace = new BehaviorSubject();`
`895`		`-}`
`896`		-```
`897`		`-`
`898`		`-<br>`
`899`		`-`
`900`		`----`
`901`		`-`
`902`		`-<br>`
`903`		`-`
`904`	`840`	`#### Default Config`
`905`	`841`
`906`	`842`	```json
`@@ -1470,7 +1406,7 @@ class Test {`
`1470`	`1406`	`"@angular-eslint/prefer-signals": [`
`1471`	`1407`	`"error",`
`1472`	`1408`	`{`
`1473`		`- "preferReadonly": false`
	`1409`	`+ "preferReadonlySignalProperties": false`
`1474`	`1410`	`}`
`1475`	`1411`	`]`
`1476`	`1412`	`}`
`@@ -1661,7 +1597,7 @@ class Test {`
`1661`	`1597`	`"@angular-eslint/prefer-signals": [`
`1662`	`1598`	`"error",`
`1663`	`1599`	`{`
`1664`		`- "preferInputSignal": false`
	`1600`	`+ "preferInputSignals": false`
`1665`	`1601`	`}`
`1666`	`1602`	`]`
`1667`	`1603`	`}`
`@@ -1721,7 +1657,7 @@ class Test {`
`1721`	`1657`	`"@angular-eslint/prefer-signals": [`
`1722`	`1658`	`"error",`
`1723`	`1659`	`{`
`1724`		`- "preferQuerySignal": false`
	`1660`	`+ "preferQuerySignals": false`
`1725`	`1661`	`}`
`1726`	`1662`	`]`
`1727`	`1663`	`}`
`@@ -1781,7 +1717,7 @@ class Test {`
`1781`	`1717`	`"@angular-eslint/prefer-signals": [`
`1782`	`1718`	`"error",`
`1783`	`1719`	`{`
`1784`		`- "preferQuerySignal": false`
	`1720`	`+ "preferQuerySignals": false`
`1785`	`1721`	`}`
`1786`	`1722`	`]`
`1787`	`1723`	`}`
`@@ -1841,7 +1777,7 @@ class Test {`
`1841`	`1777`	`"@angular-eslint/prefer-signals": [`
`1842`	`1778`	`"error",`
`1843`	`1779`	`{`
`1844`		`- "preferQuerySignal": false`
	`1780`	`+ "preferQuerySignals": false`
`1845`	`1781`	`}`
`1846`	`1782`	`]`
`1847`	`1783`	`}`
`@@ -1901,7 +1837,7 @@ class Test {`
`1901`	`1837`	`"@angular-eslint/prefer-signals": [`
`1902`	`1838`	`"error",`
`1903`	`1839`	`{`
`1904`		`- "preferQuerySignal": false`
	`1840`	`+ "preferQuerySignals": false`
`1905`	`1841`	`}`
`1906`	`1842`	`]`
`1907`	`1843`	`}`