Merge branch 'main' into feature/space-beetwen-comments

nikolai-shabalin · nikolai-shabalin · commit facbec47f9e5 · 2024-01-11T20:59:45.000+03:00
# Conflicts:
#	CHANGELOG.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,11 @@
 # Changelog
 
-## 1.0.10
+## 1.0.11
 Added [htmlacademy/space-between-comments](rules/space-between-comments/README.md)
 
+## 1.0.10
+`attr-req-value` can now accept regex for ignore
+
 ## 1.0.9
 Fixed `req-charset-utf` rule
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "linthtml-rules-htmlacademy",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "Кастомные правила для linthtml от HTML Academy",
   "main": "index.js",
   "repository": "htmlacademy/linthtml-rules-htmlacademy",
@@ -13,7 +13,7 @@
   "license": "ISC",
   "devDependencies": {
     "@linthtml/dom-utils": "0.9.5",
-    "eslint": "8.52.0",
+    "eslint": "8.55.0",
     "eslint-config-htmlacademy": "10.0.1"
   }
 }
diff --git a/rules/a-target-rel/README.md b/rules/a-target-rel/README.md
@@ -14,7 +14,6 @@
 ```
 
 Следующие шаблоны **не** считаются проблемами:
-
 ```html
 <a href="https://htmlacademy.pro" target="_blank" rel="noreferrer noopener">Link</a>
 
diff --git a/rules/attr-delimiter/README.md b/rules/attr-delimiter/README.md
@@ -1,6 +1,6 @@
 # htmlacademy/attr-delimiter
 
-Это правило запрещает использование пробелов, разделяющих ключ атрибута и значение, т.е. до или после символа `=`. Технически пробелы разрешены спецификацией HTML5.
+Это правило запрещает использование пробелов, разделяющих ключ атрибута и значение, то есть до или после символа `=`. Технически пробелы разрешены спецификацией HTML5.
 Использование пробелов в этом контексте может быть признаком опечатки.
 
 ## true
diff --git a/rules/attr-req-value/README.md b/rules/attr-req-value/README.md
@@ -27,13 +27,13 @@
 ```
 
 ### ignore
-Игнорирует перечисленный список атрибутов
+Игнорирует перечисленный список атрибутов. Принимает значения `string|regex`
 
 ```js
 {
   'htmlacademy/attr-req-value': [true, 
     { 
-      ignore: ['alt']
+      ignore: ['alt', '/^data-/']
     }
   ]
 }
@@ -49,4 +49,5 @@
 
 ```html
 <img src="images/image.jpg" width="100" height="100" alt="">
+<section data-test></section>
 ```
diff --git a/rules/attr-req-value/index.js b/rules/attr-req-value/index.js
@@ -1,6 +1,18 @@
 'use strict';
 // eslint-disable-next-line camelcase
-const { is_tag_node, has_non_empty_attribute, is_boolean_attribute} = require('@linthtml/dom-utils');
+const { is_tag_node, has_non_empty_attribute, is_boolean_attribute } = require('@linthtml/dom-utils');
+const matchesIgnoreList = (attributeName, ignoreList) => ignoreList.some((ignoreItem) => {
+  if (typeof ignoreItem === 'string') {
+    const regexString = ignoreItem.startsWith('/') && ignoreItem.endsWith('/') ? ignoreItem.slice(1, -1) : ignoreItem;
+    const regex = new RegExp(regexString);
+    return regex.test(attributeName);
+  } else if (ignoreItem instanceof RegExp) {
+    return ignoreItem.test(attributeName);
+  } else {
+    return attributeName === ignoreItem;
+  }
+});
+
 
 module.exports = {
   name: 'htmlacademy/attr-req-value',
@@ -12,18 +24,19 @@ module.exports = {
         const name = attribute.name.chars.toLowerCase();
 
         // eslint-disable-next-line camelcase
-        if (!has_non_empty_attribute(node, name) && !is_boolean_attribute(attribute) && !rule_config.ignore?.includes(name)) {
+        if (!has_non_empty_attribute(node, name) && !is_boolean_attribute(attribute) && !matchesIgnoreList(name, rule_config.ignore)
+        ) {
           report({
             code: 'E006',
             position: attribute.loc,
             meta: {
               data: {
-                attribute: name
-              }
-            }
+                attribute: name,
+              },
+            },
           });
         }
       });
     }
-  }
+  },
 };
diff --git a/rules/charset-position/README.md b/rules/charset-position/README.md
@@ -1,6 +1,6 @@
 # htmlacademy/charset-position
 
-Правило позиционирование `<meta charset="">` в `<head>`. Правило принимает значения `true` или `false`
+Правило позиционирования `<meta charset="">` в `<head>`. Правило принимает значения `true` или `false`
 
 ## true 
 `<meta charset="">` указан первым непосредственным ребёнком в `<head>`.
diff --git a/rules/link-req-content/README.md b/rules/link-req-content/README.md
@@ -11,12 +11,24 @@
 
 Проблемными считаются следующие шаблоны:
 ```html
-<a><img src="cat.gif"></a>
+<a>
+  <img src="images/cat.gif" width="100" height="1000">
+</a>
+
+<a href="#">
+  <svg>...</svg>
+</a>
 ```
 
 Следующие шаблоны **не** считаются проблемами:
 ```html
-<a>lorem ipsum</a>
-<a><img src="cat.gif" alt="cat page"></a>
-<a aria-label="lorem ipsum"></a>
+<a href="#">
+  lorem ipsum
+</a>
+
+<a href="#">
+  <img src="images/cat.gif" width="100" height="100" alt="cat page">
+</a>
+
+<a href="#" aria-label="lorem ipsum"></a>
 ```
diff --git a/rules/no-blocking-script/README.md b/rules/no-blocking-script/README.md
@@ -1,6 +1,6 @@
 # htmlacademy/no-blocking-script
 
-Правило проверяет расположение скриптов в разметке.
+Правило проверяет расположение скриптов в разметке. Правило принимает значения `true` или `false`.
 
 ## true
 Скрипты должны быть подключены в самом низу страницы, чтобы при её загрузке не блокировать отображение содержимого.

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "linthtml-rules-htmlacademy",`
`3`		`- "version": "1.0.9",`
	`3`	`+ "version": "1.0.10",`
`4`	`4`	`"description": "Кастомные правила для linthtml от HTML Academy",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"repository": "htmlacademy/linthtml-rules-htmlacademy",`
`@@ -13,7 +13,7 @@`
`13`	`13`	`"license": "ISC",`
`14`	`14`	`"devDependencies": {`
`15`	`15`	`"@linthtml/dom-utils": "0.9.5",`
`16`		`- "eslint": "8.52.0",`
	`16`	`+ "eslint": "8.55.0",`
`17`	`17`	`"eslint-config-htmlacademy": "10.0.1"`
`18`	`18`	`}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,13 +27,13 @@`
`27`	`27`	```
`28`	`28`
`29`	`29`	`### ignore`
`30`		`-Игнорирует перечисленный список атрибутов`
	`30`	+Игнорирует перечисленный список атрибутов. Принимает значения `string\|regex`
`31`	`31`
`32`	`32`	```js
`33`	`33`	`{`
`34`	`34`	`'htmlacademy/attr-req-value': [true,`
`35`	`35`	`{`
`36`		`- ignore: ['alt']`
	`36`	`+ ignore: ['alt', '/^data-/']`
`37`	`37`	`}`
`38`	`38`	`]`
`39`	`39`	`}`
`@@ -49,4 +49,5 @@`
`49`	`49`
`50`	`50`	```html
`51`	`51`	`<img src="images/image.jpg" width="100" height="100" alt="">`
	`52`	`+<section data-test></section>`
`52`	`53`	```