@brighterly/lib-fe-codestyle 0.1.0

package/eslint/rules/require-component-name.mjs

@@ -0,0 +1,68 @@
+export default {
+  meta: {
+    type: 'suggestion',
+    fixable: 'code',
+    docs: {
+      description: 'require defineOptions({ name }) matching the file name in every component',
+    },
+    schema: [],
+    messages: {
+      missing: 'Component must declare defineOptions({ name: \'{{ name }}\' }).',
+      noName: 'defineOptions() must include a name property.',
+    },
+  },
+  create (context) {
+    const filename = context.filename ?? context.getFilename()
+    if (!filename.endsWith('.vue')) return {}
+
+    const expectedName = filename.split('/').pop().replace('.vue', '')
+
+    return {
+      Program (program) {
+        const body = program.body
+        if (body.length === 0) return
+
+        let defineOptionsCall = null
+        for (const stmt of body) {
+          if (
+            stmt.type === 'ExpressionStatement'
+                        && stmt.expression.type === 'CallExpression'
+                        && stmt.expression.callee.type === 'Identifier'
+                        && stmt.expression.callee.name === 'defineOptions'
+          ) {
+            defineOptionsCall = stmt.expression
+            break
+          }
+        }
+
+        if (!defineOptionsCall) {
+          const imports = body.filter(s => s.type === 'ImportDeclaration')
+          const anchor = imports[imports.length - 1] ?? body[0]
+          const text = `defineOptions({\n  name: '${expectedName}',\n})`
+          context.report({
+            node: body[0],
+            messageId: 'missing',
+            data: { name: expectedName },
+            fix: fixer => imports.length
+              ? fixer.insertTextAfter(anchor, `\n\n${text}`)
+              : fixer.insertTextBefore(anchor, `${text}\n\n`),
+          })
+
+          return
+        }
+
+        const arg = defineOptionsCall.arguments[0]
+        const hasName = arg
+                    && arg.type === 'ObjectExpression'
+                    && arg.properties.some(p =>
+                      p.type === 'Property'
+                        && !p.computed
+                        && (p.key.name === 'name' || p.key.value === 'name'))
+
+        if (!hasName) {
+          context.report({ node: defineOptionsCall, messageId: 'noName' })
+        }
+      },
+    }
+  },
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@brighterly/lib-fe-codestyle",
+  "version": "0.1.0",
+  "type": "module",
+  "license": "UNLICENSED",
+  "description": "Shared invariant-validator engine, rule pack and ESLint config for Brighterly Nuxt frontend apps",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/brighterly/lib-fe-codestyle.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "files": [
+    "dist",
+    "eslint",
+    "README.md"
+  ],
+  "exports": {
+    "./invariants": {
+      "types": "./dist/invariants/index.d.ts",
+      "default": "./dist/invariants/index.js"
+    },
+    "./invariants/rules": {
+      "types": "./dist/invariants/rules/index.d.ts",
+      "default": "./dist/invariants/rules/index.js"
+    },
+    "./validate": {
+      "types": "./dist/validate/index.d.ts",
+      "default": "./dist/validate/index.js"
+    },
+    "./eslint": "./eslint/index.mjs"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build && npm run test",
+    "test": "vitest run",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint",
+    "lint-fix": "eslint --fix",
+    "validate": "node validate.mjs"
+  },
+  "peerDependencies": {
+    "@vue/compiler-sfc": "^3.5.0",
+    "eslint": "^10.0.0",
+    "eslint-plugin-check-file": "^3.3.0",
+    "typescript": "^6.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^26.6.2",
+    "@typescript-eslint/parser": "^8.70.1",
+    "@vue/compiler-sfc": "^3.5.40",
+    "eslint": "^10.7.0",
+    "eslint-plugin-check-file": "^3.3.2",
+    "typescript": "6.0.3",
+    "typescript-eslint": "^8.70.1",
+    "vitest": "^4.1.10"
+  }
+}