Merge pull request #81 from htmlacademy/feature/space-beetwen-comments

nikolai-shabalin · web-flow · commit 844763d18c24 · 2024-01-12T09:53:24.000+03:00
Added htmlacademy/space-between-comments
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.0.11
+Added [htmlacademy/space-between-comments](rules/space-between-comments/README.md)
+```js
+rules: {
+  'htmlacademy/space-between-comments': [true, 'space' | 'no-space]
+}
+```
+
+```html
+<!-- Comment --> // space
+<!--Comment--> // no-space
+```
+
 ## 1.0.10
 `attr-req-value` can now accept regex for ignore
 
diff --git a/docs/list-of-rules.md b/docs/list-of-rules.md
@@ -1,7 +1,7 @@
 # Список правил от HTML Academy
 
 | Имя правила                                                                         | Описания                                                                                           |
-|:------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------|
+|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
 | [htmlacademy/a-target-rel](../rules/a-target-rel/README.md)                         | Проверяет наличие `rel="noopener noreferrer"` у `<a target="_blank"></a>`                          |
 | [htmlacademy/aria-label-misuse](../rules/aria-label-misuse/README.md)               | Требует использование `aria-label` на определённых элементах                                       |
 | [htmlacademy/attr-delimiter](../rules/attr-delimiter/README.md)                     | Требует удалить пробел между `=` для атрибутов                                                     |
@@ -24,5 +24,6 @@
 | [htmlacademy/req-meta-viewport](../rules/req-meta-viewport/README.md)               | Проверяет наличие `<meta name="viewport" content="width=device-width,initial-scale=1">` в `<head>` |
 | [htmlacademy/req-single-styles](../rules/req-single-styles/README.md)               | Разрешает не более одного `link rel="stylesheet"` в `<head>`                                       |
 | [htmlacademy/section-has-heading](../rules/section-has-heading/README.md)           | Требует добавление заголовка любого уровня в `<section>`                                           |
+| [htmlacademy/space-between-comments](../rules/space-between-comments/README.md)     | Проверят пробелы у комментария `<!-- Это комментарий -->`
 | [htmlacademy/tag-name-lowercase](../rules/tag-name-lowercase/README.md)             | Имена тегов должны быть строчными                                                                  |
 | [htmlacademy/tag-self-close](../rules/tag-self-close/README.md)                     | Одиночные элементы не должны быть закрыты, `<br>` вместо `<br/>`                                   |
diff --git a/rules/space-between-comments/README.md b/rules/space-between-comments/README.md
@@ -0,0 +1,37 @@
+# htmlacademy/space-between-comments
+
+Это правило проверяет наличие пробелов в начале и в конце блока комментария.
+
+## Опции
+
+`string`: `"space"|"no-space"`
+
+## Значение `space`
+Если у комментария есть пробелы как в начале, так и в конце блока комментария, то это соответствует требованиям.
+
+Проблемными считаются следующие шаблоны:
+```html
+<!-- Это комментарий-->
+<!--Это комментарий -->
+<!--Это комментарий-->
+```
+
+Следующие шаблоны **не** считаются проблемами:
+```html
+<!-- Это комментарий -->
+```
+
+## Значение `no-space`
+Если у комментария **нет** пробелов как в начале, так и в конце блока комментария, то это соответствует требованиям.
+
+Проблемными считаются следующие шаблоны:
+```html
+<!-- Это комментарий-->
+<!--Это комментарий -->
+<!-- Это комментарий -->
+```
+
+Следующие шаблоны **не** считаются проблемами:
+```html
+<!--Это комментарий-->
+```
diff --git a/rules/space-between-comments/index.js b/rules/space-between-comments/index.js
@@ -0,0 +1,32 @@
+'use strict';
+const { is_comment_node } = require('@linthtml/dom-utils');
+
+const rules = {
+  'space': {
+    check: (string) => string.startsWith(' ') && string.endsWith(' '),
+    errorMessage: 'The comment should contain spaces at the beginning and end of the message.'
+  },
+  'no-space': {
+    check: (string) => !string.startsWith(' ') && !string.endsWith(' '),
+    errorMessage: 'The comment should not contain spaces at the beginning and end of the message.'
+  }
+};
+
+module.exports = {
+  name: 'htmlacademy/space-between-comments',
+  // eslint-disable-next-line camelcase
+  lint(node, rule_config = 'space', { report }) {
+    if (is_comment_node(node)) {
+      const comment = node.data;
+      // eslint-disable-next-line camelcase
+      const { check, errorMessage } = rules[rule_config];
+
+      if (!check(comment)) {
+        report({
+          position: node.loc,
+          message: errorMessage
+        });
+      }
+    }
+  }
+};
