power-linter 0.1.0 → 0.1.2

package/README.md

@@ -1,36 +1,66 @@
 # power-linter
 
-power-linter — линтер (ESLint) и форматтер (Prettier) с расширяемой архитектурой для произвольных правил и скриптов.
+## Описание
+power-linter — пакет пресетов конфигураций для ESLint и Prettier, кастомных правил линтирования и codemode-скриптов. Позволяет переносить одни и те же пресеты конфигураций для EsLint и Prettier, скрипты и правила , не дублируя их в репозиториях проектов.
 
-- конфиги eslint и prettier из коробки
-- кастомные правила-линтера (see `eslint-plugin-power-esrules`)
+Содержит правила из плагинов:
+    "eslint-config-airbnb",
+    "eslint-config-prettier",
+    "eslint-plugin-import",
+    "eslint-plugin-jsx-a11y",
+    "eslint-plugin-power-esrules",
+    "eslint-plugin-react",
+    "eslint-plugin-react-hooks".
 
-## Использование
+Содержит codemod-скрипты:
+  1. Для добавления data-аттрибута "data-testid" (add-data-testid.js).
+  2. Для преобразования классовых React-компонентов в функциональные (class-to-functional.js).
 
-1. Установка:
+Статус: в разработке.
 
+## Содержание
+- [Описание](#описание)
+- [Технологии](#технологии)
+- [Интеграция](#интеграция)
+- [Требования](#требования)
+
+## Технологии
+- [JavaScript](https://developer.mozilla.org/ru/docs/Web/JavaScript)
+- ...
+
+## Требования
+Eslint требуется не ниже версии 8.0.0.
+Prettier требуется не ниже версии 2.6.2.
+
+## Интеграция
+Для интеграции в проект предварительно необходимо:
+
+0. Установить EsLint и Prettier.
 ```bash
-npm install power-linter --save-dev
+$ npm i eslint
+$ npm i prettier
 ```
 
-2. Добавьте экспорт конфигурации eslint
+1. Установите npm-пакет с помощью команды:
+```bash
+$ npm install power-linter --save-dev
+```
 
+2. Добавьте экспорт конфигурации eslint
 ```js
 // .eslintrc.js
 module.exports = require('power-linter/src/eslint/config');
 ```
 
 3. Добавьте экспорт конфигурации Prettier
-
 ```js
 // .prettierrc.js
 module.exports = require('power-linter/src/prettier/config');
 ```
 
-4. Для кастомных правил добавляйте файлы в `eslint-plugin-power-esrules`
-
-5. Добавьте в корневой каталог проекта настройки vscode в каталоге .vscode создайте файл settings.json и добавьте в него 
-
+4. Для портирования настроек vscode (если необходимо) в каталоге .vscode создайте файл settings.json и добавьте в него следующие настройки:
+```json
+// settings.json
 `{
 "eslint.enable": true,
 "eslint.validate": [
@@ -69,3 +99,5 @@ module.exports = require('power-linter/src/prettier/config');
 }`
 
 ---
+
+

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "power-linter",
-    "version": "0.1.0",
-    "description": "power-linter — линтер (ESLint) и форматтер (Prettier) с расширяемой архитектурой для произвольных правил и скриптов.",
+    "version": "0.1.2",
+    "description": "power-linter — пакет пресетов конфигураций для ESLint и Prettier, кастомных правил линтирования и скриптов.",
     "main": "src/index.js",
     "author": "vollmond148",
     "license": "MIT",
@@ -29,7 +29,8 @@
         "prettier": "^3.2.5"
     },
     "peerDependencies": {
-        "eslint": "^8.0.0"
+        "eslint": "^8.0.0",
+        "prettier": "^2.6.2"
     },
     "files": [
         "src/",

package/scripts/addDataTestAttribute/addDataTestInDOM.js

@@ -0,0 +1,135 @@
+const STABLE_ID_ATTRIBUTE_NAME = "data-test";
+const COMPONENT_TEST_NAME = "data-testid";
+const KEYS_COUNTS_MAP_MAX_SIZE = 1000;
+
+const repeatedKeysCountsMap = new Map();
+
+export const clearRepeatedKeysCountsMap = () => {
+  repeatedKeysCountsMap.clear();
+};
+
+function encodeStableId(str) {
+  let hash = 0;
+  for (let i = 0; i < str.length; i += 4) {
+    // eslint-disable-next-line no-bitwise
+    hash = (hash * 31 + str.charCodeAt(i)) >>> 0; // 32-битный хеш
+  }
+  const base36 = hash.toString(36);
+  return base36.padStart(7, "0");
+}
+// собирает data-testid предков элемента до рутового компонента в строку
+function collectHashesByParentsTestIds(el) {
+  const segments = [];
+  let node = el;
+  while (node && node.nodeType === Node.ELEMENT_NODE) {
+    if (node.hasAttribute(COMPONENT_TEST_NAME)) {
+      const testID = node.getAttribute(COMPONENT_TEST_NAME);
+      if (segments[segments.length - 1] !== testID) {
+        const testIDHash = testID.replace(/[_aeiouy-]/gi, "");
+        segments.push(testIDHash);
+      }
+    }
+    if (
+      node.getAttribute &&
+      node.getAttribute(COMPONENT_TEST_NAME) === "app-root"
+    ) {
+      break;
+    }
+    node = node.parentElement;
+  }
+  return segments.join("");
+}
+
+// Собираем текущие максимальные индексы для уже проставленных data-test
+function buildCountsForExistedDataTests(rootNode) {
+  const existingDataTestNodes = rootNode.querySelectorAll(
+    `[${STABLE_ID_ATTRIBUTE_NAME}]`,
+  );
+  existingDataTestNodes.forEach((node) => {
+    const dataTestValue = node.getAttribute(STABLE_ID_ATTRIBUTE_NAME);
+    const dataTestParts = dataTestValue.split("::"); // [existingDataTestID, encodedID, index]
+    const groupedID = `${dataTestParts[0]}::${dataTestParts[1]}`;
+    const index = Number(dataTestParts[2]) || 0;
+    const prev = repeatedKeysCountsMap.get(groupedID) ?? 0;
+    if (index + 1 > prev) {
+      repeatedKeysCountsMap.set(groupedID, index + 1);
+    }
+  });
+}
+
+function applyDataTestIDsToDom(addedRootNode = document.body) {
+  if (!addedRootNode) return;
+  buildCountsForExistedDataTests(addedRootNode);
+  if (repeatedKeysCountsMap.size >= KEYS_COUNTS_MAP_MAX_SIZE) {
+    clearRepeatedKeysCountsMap();
+  }
+  const allAddedNodes = [];
+  if (!addedRootNode.hasAttribute(STABLE_ID_ATTRIBUTE_NAME)) {
+    allAddedNodes.push(addedRootNode);
+  }
+  const allNotDataTestChildren = addedRootNode.querySelectorAll(
+    `*:not([${STABLE_ID_ATTRIBUTE_NAME}])`,
+  );
+  allAddedNodes.push(...allNotDataTestChildren);
+  if (!allAddedNodes.length) return;
+  allAddedNodes.forEach((node) => {
+    let existingDataTestID = "";
+    if (node.hasAttribute(COMPONENT_TEST_NAME)) {
+      existingDataTestID = node.getAttribute(COMPONENT_TEST_NAME);
+    }
+    const fullHashChain = collectHashesByParentsTestIds(node);
+    const encodedID = encodeStableId(fullHashChain);
+    const groupedID = `${existingDataTestID}::${encodedID}`;
+    const nextIndex = repeatedKeysCountsMap.get(groupedID) ?? 0;
+    repeatedKeysCountsMap.set(groupedID, nextIndex + 1);
+    const resultID = `${groupedID}::${nextIndex}`;
+    node.setAttribute(STABLE_ID_ATTRIBUTE_NAME, resultID);
+  });
+}
+
+const clearNodeMapKeys = (removingRootNode = document.body) => {
+  const allRemovingNodes = [];
+  if (removingRootNode.hasAttribute(STABLE_ID_ATTRIBUTE_NAME)) {
+    allRemovingNodes.push(removingRootNode);
+  }
+  const allDataTestChildren = removingRootNode.querySelectorAll(
+    `[${STABLE_ID_ATTRIBUTE_NAME}]`,
+  );
+  allRemovingNodes.push(...allDataTestChildren);
+  allRemovingNodes.forEach((node) => {
+    const dataTestValueArray = node
+      .getAttribute(STABLE_ID_ATTRIBUTE_NAME)
+      .split("::");
+    dataTestValueArray.pop();
+    const nodeKey = dataTestValueArray.join("::");
+    const keyCount = repeatedKeysCountsMap.get(nodeKey);
+    if (keyCount) {
+      repeatedKeysCountsMap.set(nodeKey, keyCount - 1);
+    } else {
+      repeatedKeysCountsMap.delete(nodeKey);
+    }
+  });
+};
+
+export function initStableIds() {
+  if (typeof document === "undefined") return;
+  applyDataTestIDsToDom();
+  const observer = new MutationObserver((mutations) => {
+    mutations.forEach((mutationRecord) => {
+      mutationRecord.removedNodes.forEach((node) => {
+        if (node.nodeType === Node.ELEMENT_NODE) {
+          clearNodeMapKeys(node);
+        }
+      });
+      mutationRecord.addedNodes.forEach((node) => {
+        if (node.nodeType === Node.ELEMENT_NODE) {
+          applyDataTestIDsToDom(node);
+        }
+      });
+    });
+  });
+  observer.observe(document.body, {
+    childList: true,
+    subtree: true,
+  });
+}

package/src/index.js

@@ -1,7 +1,13 @@
-const eslintConfig = require('./eslint/config');
-const prettierConfig = require('./prettier/config');
+const eslintConfig = require("./eslint/config");
+const prettierConfig = require("./prettier/config");
+const {
+  initStableIds,
+  clearRepeatedKeysCountsMap,
+} = require("../scripts/addDataTestAttribute/addDataTestInDOM.js");
 
 module.exports = {
-    eslintConfig,
-    prettierConfig,
+  eslintConfig,
+  prettierConfig,
+  initStableIds,
+  clearRepeatedKeysCountsMap,
 };