feat(eslint-plugin-template): [i18n] add allowMarkupInContent option (#…

…1795)
angular-eslint · May 22, 2024 · bb8470d · bb8470d
1 parent 977f0b9
commit bb8470d
Show file tree

Hide file tree

Showing 3 changed files with 416 additions and 11 deletions.
diff --git a/packages/eslint-plugin-template/docs/rules/i18n.md b/packages/eslint-plugin-template/docs/rules/i18n.md
@@ -30,6 +30,10 @@ The rule accepts an options object with the following properties:
 
 ```ts
 interface Options {
+  /**
+   * Default: `true`
+   */
+  allowMarkupInContent?: boolean;
   boundTextAllowedPattern?: string;
   /**
    * Default: `true`
@@ -130,6 +134,33 @@ interface Options {
 
 <br>
 
+#### Default Config
+
+```json
+{
+  "rules": {
+    "@angular-eslint/template/i18n": [
+      "error"
+    ]
+  }
+}
+```
+
+<br>
+
+#### ❌ Invalid Code
+
+```html
+{ value, plural, =0 {No elements} =1 {111} }
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+```
+
+<br>
+
+---
+
+<br>
+
 #### Custom Config
 
 ```json
@@ -1098,6 +1129,111 @@ interface Options {
 </div>
 ```
 
+<br>
+
+---
+
+<br>
+
+#### Custom Config
+
+```json
+{
+  "rules": {
+    "@angular-eslint/template/i18n": [
+      "error",
+      {
+        "allowMarkupInContent": false,
+        "checkId": false
+      }
+    ]
+  }
+}
+```
+
+<br>
+
+#### ❌ Invalid Code
+
+```html
+<div i18n>
+  Text to translate
+  <foo></foo>
+  ~~~~~~~~~~~
+</div>
+```
+
+<br>
+
+---
+
+<br>
+
+#### Custom Config
+
+```json
+{
+  "rules": {
+    "@angular-eslint/template/i18n": [
+      "error",
+      {
+        "allowMarkupInContent": false,
+        "checkId": false
+      }
+    ]
+  }
+}
+```
+
+<br>
+
+#### ❌ Invalid Code
+
+```html
+<ng-template i18n>
+  Text to translate
+  <foo></foo>
+  ~~~~~~~~~~~
+</ng-template>
+```
+
+<br>
+
+---
+
+<br>
+
+#### Custom Config
+
+```json
+{
+  "rules": {
+    "@angular-eslint/template/i18n": [
+      "error",
+      {
+        "allowMarkupInContent": false,
+        "checkId": false
+      }
+    ]
+  }
+}
+```
+
+<br>
+
+#### ❌ Invalid Code
+
+```html
+<div i18n>
+  <div i18n>
+  ~~~~~~~~~~
+    Text to translate
+    ~~~~~~~~~~~~~~~~~
+  </div>
+  ~~~~~~
+</div>
+```
+
 </details>
 
 <br>
@@ -1551,6 +1687,34 @@ interface Options {
 
 #### ✅ Valid Code
 
+```html
+<ng-container i18n="@@description">
+  { value, plural, =0 {No elements} =1 {111} }
+</ng-container>
+```
+
+<br>
+
+---
+
+<br>
+
+#### Default Config
+
+```json
+{
+  "rules": {
+    "@angular-eslint/template/i18n": [
+      "error"
+    ]
+  }
+}
+```
+
+<br>
+
+#### ✅ Valid Code
+
 ```html
 <ng-container i18n="@@description">
   { value, plural, =0 {<div>No elements</div>} =1 {111} }
@@ -2124,6 +2288,134 @@ interface Options {
 
 <br>
 
+#### Custom Config
+
+```json
+{
+  "rules": {
+    "@angular-eslint/template/i18n": [
+      "error",
+      {
+        "allowMarkupInContent": false,
+        "checkId": false
+      }
+    ]
+  }
+}
+```
+
+<br>
+
+#### ✅ Valid Code
+
+```html
+<div i18n>
+  Text to translate{{ Bound }}
+</div>
+```
+
+<br>
+
+---
+
+<br>
+
+#### Custom Config
+
+```json
+{
+  "rules": {
+    "@angular-eslint/template/i18n": [
+      "error",
+      {
+        "allowMarkupInContent": false,
+        "checkId": false
+      }
+    ]
+  }
+}
+```
+
+<br>
+
+#### ✅ Valid Code
+
+```html
+<ng-template i18n>
+  Text to translate{{ Bound }}
+</ng-template>
+```
+
+<br>
+
+---
+
+<br>
+
+#### Custom Config
+
+```json
+{
+  "rules": {
+    "@angular-eslint/template/i18n": [
+      "error",
+      {
+        "allowMarkupInContent": false,
+        "checkId": false
+      }
+    ]
+  }
+}
+```
+
+<br>
+
+#### ✅ Valid Code
+
+```html
+<div i18n>
+  { value, plural, =0 {No elements} =1 {111} }
+</div>
+```
+
+<br>
+
+---
+
+<br>
+
+#### Custom Config
+
+```json
+{
+  "rules": {
+    "@angular-eslint/template/i18n": [
+      "error",
+      {
+        "allowMarkupInContent": false,
+        "checkId": false
+      }
+    ]
+  }
+}
+```
+
+<br>
+
+#### ✅ Valid Code
+
+```html
+<div i18n>
+  { value, plural, =0 {<div>No elements</div>} =1 {111} }
+</div>
+```
+
+<br>
+
+---
+
+<br>
+
 #### Default Config
 
 ```json