@entva/styleguide 0.0.0

package/scripts/for-each-package

@@ -0,0 +1,12 @@
+#!/bin/sh
+PACKAGES=`find . -iname packages -not -path "*/node_modules/*"  -exec find {} -maxdepth 1 -mindepth 1  \;`
+EXIT_STATUS=0
+
+for PACKAGE in $PACKAGES
+do
+  if ! (cd $PACKAGE && $@); then
+    EXIT_STATUS=1
+  fi
+done
+
+exit $EXIT_STATUS

package/test/css.js

@@ -0,0 +1,36 @@
+import { resolve } from 'path';
+import fs from 'fs';
+import { collectLinterErrors, createTestErrorsCollector } from './utils.js';
+
+// ESM is very convenient and doesn't require any workarounds for the CJS dynamic import
+const loadStyleLint = async () => {
+  const cwd = process.cwd();
+  const pkg = JSON.parse(fs.readFileSync(resolve(cwd, 'node_modules/stylelint/package.json'), 'utf8'));
+  const styleLint = resolve(cwd, 'node_modules/stylelint', pkg.main);
+  const mod = await import(styleLint);
+  return mod.default;
+};
+
+
+const processFile = (result) => {
+  const errorsLinter = result.warnings.reduce(collectLinterErrors, []);
+  const errorsTest = errorsLinter.reduce(createTestErrorsCollector(result.source), []);
+
+  if (errorsTest.length) throw `Errors found:\n${errorsTest.join('\n')}`;
+};
+
+const run = async (dir, exts = 'css,scss') => {
+  const stylelint = await loadStyleLint();
+  try {
+    const report = await stylelint.lint({
+      files: exts.split(',').map((ext) => `${dir}/**/*.${ext}`),
+      quietDeprecationWarnings: true,
+    });
+    report.results.forEach(processFile);
+  } catch (err) {
+    console.error(err);
+    process.exit(1);
+  }
+};
+
+export default run;

package/test/index.js

@@ -0,0 +1,7 @@
+const [dir, type, ext] = process.argv.slice(2)
+const run = async () => {
+  const { default: fn } = await import(`./${type}.js`);
+  fn(dir, ext);
+};
+
+run();

package/test/js.js

@@ -0,0 +1,35 @@
+import { resolve } from 'path';
+import fs from 'fs';
+import { collectLinterErrors, createTestErrorsCollector } from './utils.js';
+
+// ESM is very convenient and doesn't require any workarounds for the CJS dynamic import
+const loadESLint = async () => {
+  const cwd = process.cwd();
+  const pkg = JSON.parse(fs.readFileSync(resolve(cwd, 'node_modules/eslint/package.json'), 'utf8'));
+  const eslintPath = resolve(cwd, 'node_modules/eslint', pkg.main);
+  return import(eslintPath);
+};
+
+const processFile = (file) => {
+  const errorsLinter = file.messages.reduce(collectLinterErrors, []);
+  const errorsTest = errorsLinter.reduce(createTestErrorsCollector(file.filePath), []);
+
+  if (errorsTest.length) {
+    console.error(`Errors found:\n${errorsTest.join('\n')}`);
+    return false;
+  }
+
+  return true;
+};
+
+const run = async (dir, ext = 'js') => {
+  const { ESLint } = await loadESLint();
+  const eslint = new ESLint({ overrideConfigFile: resolve(process.cwd(), 'index.js') });
+  const result = await eslint.lintFiles(`${dir}/**/*.${ext}`);
+
+  const isSuccess = result.map(processFile).every(r => r);
+
+  process.exit(isSuccess ? 0 : 1)
+};
+
+export default run;

package/test/utils.js

@@ -0,0 +1,63 @@
+import { readFileSync } from 'fs';
+import { relative } from 'path';
+
+const specPrefix = '// expect:';
+
+const arrayDiff = (arr, compareArr) => arr.filter((err) => !compareArr.includes(err));
+const formatError = (filePath, line, message) => (
+  `[${relative(process.cwd(), filePath)}:${line}] ${message}`
+);
+
+const parseSpec = (spec) => {
+  if (!spec || !spec.includes(specPrefix)) return [];
+
+  const rules = spec.replace(specPrefix, '');
+  return rules.split(',').map((rule) => rule.trim());
+};
+
+const findSpecLineIndex = (line, fileLines) => {
+  const mayBeFileError = line === 1;
+  if (mayBeFileError) return 0;
+
+  for (let i = line - 2; i >= 0; i -= 1) {
+    if (!fileLines[i].trim()) continue;
+    return i;
+  }
+
+  return line - 2;
+};
+
+export const collectLinterErrors = (acc, { line, ruleId, rule }) => {
+  const lineRecord = acc.find((item) => item.line === line);
+  const ruleKey = ruleId || rule;
+
+  if (lineRecord) {
+    lineRecord.rules.push(ruleKey);
+  } else {
+    acc.push({ line, rules: [ruleKey] });
+  }
+
+  return acc;
+};
+
+export const createTestErrorsCollector = (filePath) => {
+  const fileLines = readFileSync(filePath, 'utf8').split('\n');
+
+  return (acc, { line, rules }) => {
+    const specLineIndex = findSpecLineIndex(line, fileLines);
+    const specRules = parseSpec(fileLines[specLineIndex]);
+
+    const notCheckedRules = arrayDiff(specRules, rules);
+    const extraCheckedRules = arrayDiff(rules, specRules);
+
+    if (notCheckedRules.length) {
+      acc.push(formatError(filePath, line, `Linter should check these rules: ${notCheckedRules.join(', ')}`));
+    }
+
+    if (extraCheckedRules.length) {
+      acc.push(formatError(filePath, line, `Linter should not check these rules: ${extraCheckedRules.join(', ')}`));
+    }
+
+    return acc;
+  };
+};

package/tooling/packages/biome/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Maxim Degterev <max@degterev.me> (https://max.degterev.me)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/tooling/packages/biome/README.md

@@ -0,0 +1,27 @@
+# eslint-config-entva-typescript
+
+> Shareable entva typescript styleguide config for eslint.
+
+Extends [`eslint-config-airbnb-typescript`](https://github.com/iamturns/eslint-config-airbnb-typescript).
+
+A shareable config to enforce entva styleguide: https://github.com/entva/styleguide
+
+To see the rules that this config uses, please read the [config itself](./index.js).
+
+## Installation
+
+```bash
+npm install eslint-config-entva-typescript --save-dev
+```
+
+## Usage
+
+If you've installed `eslint-config-entva-typescript` locally within your project, just set your `eslint` config to:
+
+```json
+{
+  "extends": "eslint-config-entva-typescript"
+}
+```
+
+## [MIT License](LICENSE)