@containerbase/eslint-plugin 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Containerbase
+
+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/README.md

@@ -0,0 +1,3 @@
+# eslint-plugin
+
+containerbase eslint plugin

package/index.d.ts

@@ -0,0 +1,9 @@
+import eslint from 'eslint';
+
+const plugin: eslint.ESLint.Plugin & {
+  configs: {
+    all: eslint.Linter.Config;
+  };
+};
+
+export default plugin;

package/index.js

@@ -0,0 +1,82 @@
+import process from 'node:process';
+import pkg from './package.json' with { type: 'json' };
+
+/** @type {Record<string, import('eslint').Rule.RuleModule>} */
+const rules = {
+  'test-root-describe': {
+    meta: {
+      fixable: 'code',
+    },
+    create(context) {
+      const absoluteFileName = context.filename;
+      if (!absoluteFileName.endsWith('.spec.ts')) {
+        return {};
+      }
+      const relativeFileName = absoluteFileName
+        .replace(process.cwd(), '')
+        .replace(/\\/g, '/')
+        .replace(/^(?:\/(?:lib|src|test))?\//, '');
+      const testName = relativeFileName.replace(/\.spec\.ts$/, '');
+      return {
+        CallExpression(node) {
+          const { callee } = node;
+          if (
+            callee.type === 'Identifier' &&
+            callee.name === 'describe' &&
+            node.parent.parent.type === 'Program'
+          ) {
+            const [descr] = node.arguments;
+
+            if (!descr) {
+              context.report({
+                node,
+                message: `Test root describe must have arguments`,
+              });
+              return;
+            }
+
+            const isOkay =
+              descr.type === 'Literal' &&
+              typeof descr.value === 'string' &&
+              testName === descr.value;
+            if (!isOkay) {
+              context.report({
+                node: descr,
+                message: `Test must be described by this string: '${testName}'`,
+                fix(fixer) {
+                  return fixer.replaceText(descr, `'${testName}'`);
+                },
+              });
+            }
+          }
+        },
+      };
+    },
+  },
+};
+
+/** @type {Record<string, import('eslint').Linter.Config> } */
+const configs = {
+  all: {
+    plugins: {
+      get '@containerbase'() {
+        return plugin;
+      },
+    },
+    rules: {
+      '@containerbase/test-root-describe': 'error',
+    },
+  },
+};
+
+/** @type {import('eslint').ESLint.Plugin} */
+const plugin = {
+  meta: {
+    name: pkg.name,
+    version: pkg.version,
+  },
+  rules,
+  configs,
+};
+
+export default plugin;

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@containerbase/eslint-plugin",
+  "version": "1.0.1",
+  "description": "containerbase eslint plugin",
+  "keywords": [
+    "eslint-plugin",
+    "jest",
+    "vitest"
+  ],
+  "repository": "https://github.com/containerbase/eslint-plugin.git",
+  "license": "MIT",
+  "author": "Rhys Arkins <rhys@arkins.net>",
+  "contributors": [
+    "Michael Kriese <michael.kriese@visualon.de>"
+  ],
+  "type": "module",
+  "main": "index.js",
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "eslint": "eslint --cache .",
+    "eslint-fix": "eslint --cache --fix .",
+    "lint": "run-s prettier eslint lint:types",
+    "lint:types": "run-p 'lint:types:*'",
+    "lint:types:default": "tsc",
+    "lint-fix": "run-s prettier-fix eslint-fix",
+    "prepare": "husky",
+    "prettier": "prettier --cache -c -u \"**/*.*\"",
+    "prettier-fix": "prettier --cache -w -u \"**/*.*\""
+  },
+  "devDependencies": {
+    "@eslint/js": "9.14.0",
+    "@tsconfig/node20": "20.1.4",
+    "@tsconfig/strictest": "2.0.5",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/node": "^22.9.0",
+    "conventional-changelog-conventionalcommits": "8.0.0",
+    "eslint": "^9.14.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-formatter-gha": "1.5.1",
+    "eslint-import-resolver-typescript": "3.6.3",
+    "eslint-plugin-import": "2.31.0",
+    "husky": "9.1.6",
+    "lint-staged": "15.2.10",
+    "npm-run-all2": "7.0.1",
+    "prettier": "3.3.3",
+    "prettier-plugin-packagejson": "2.5.3",
+    "semantic-release": "24.2.0",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.13.0"
+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0"
+  },
+  "packageManager": "pnpm@9.12.3",
+  "engines": {
+    "node": "^20.9.0 || ^22.11.0",
+    "pnpm": "^9.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}