Added htmlacademy/space-between-comments

nikolai-shabalin · nikolai-shabalin · commit 397c9942bfa3 · 2023-10-26T11:15:08.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.0.10
+Added [htmlacademy/space-between-comments](rules/space-between-comments/README.md)
+
 ## 1.0.9
 Fixed `req-charset-utf` rule
 
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,18 @@
+# htmlacademy/space-between-comments
+
+Это правило проверяет наличие пробелов в начале и в конце блока комментария.
+
+## Значение `true`
+Если у комментария есть пробелы как в начале, так и в конце блока комментария, то это соответствует требованиям.
+
+Проблемными считаются следующие шаблоны:
+```html
+<!-- Это комментарий-->
+<!--Это комментарий -->
+<!--Это комментарий-->
+```
+
+Следующие шаблоны не считаются проблемами:
+```html
+<!-- Это комментарий -->
+```
diff --git a/rules/space-between-comments/index.js b/rules/space-between-comments/index.js
@@ -0,0 +1,22 @@
+'use strict';
+const { is_comment_node } = require('@linthtml/dom-utils');
+
+const hasSpacesAtStartAndEnd = (string) => string.startsWith(' ') && string.endsWith(' ');
+
+module.exports = {
+  name: 'htmlacademy/space-between-comments',
+  // eslint-disable-next-line camelcase
+  lint(node, rule_config, { report }) {
+    if (is_comment_node(node)) {
+      const comment = node.data;
+      const isEdges = hasSpacesAtStartAndEnd(comment);
+
+      if (!isEdges) {
+        report({
+          position: node.loc,
+          message: 'The comment does not contain spaces at the beginning and end of the message.'
+        });
+      }
+    }
+  }
+};
