@longzai-intelligence-oxlint/elysia-route-plugin 0.0.0-stage → 0.1.47

package/dist/index.d.ts

@@ -0,0 +1,100 @@
+import { ESTree } from "@oxlint/plugins";
+//#region src/rules/no-bare-route-path/index.d.ts
+/**
+ * no-bare-route-path 规则定义
+ *
+ * 检测 Elysia 路由注册与 prefix 配置中的裸路径字面量
+ */
+declare const noBareRoutePathRule: import("@oxlint/plugins").Rule;
+//#endregion
+//#region src/utils/elysia-route.utils.d.ts
+/**
+ * 判断表达式是否以给定前缀开头的路径形态
+ *
+ * 模板串与拼接表达式取其最左操作数的字符串前缀判定
+ *
+ * @param node - 表达式节点
+ * @returns 以 `/` 开头的路径表达式返回 true
+ */
+declare function isPathLikeExpression(node: ESTree.Node): boolean;
+/**
+ * 判断调用表达式是否为 Elysia 路由方法注册调用
+ *
+ * 命中方法名集合且首个参数为路径形态表达式
+ *
+ * @param node - 调用表达式节点
+ * @returns 路由注册调用返回 true
+ */
+declare function isRouteRegistrationCall(node: ESTree.CallExpression): boolean;
+/**
+ * 判断新表达式是否为 Elysia 实例构造
+ *
+ * @param node - 新表达式节点
+ * @returns 构造名为 Elysia 时返回 true
+ */
+declare function isNewElysiaExpression(node: ESTree.NewExpression): boolean;
+/**
+ * 从 Elysia 构造参数中提取 prefix 属性值节点
+ *
+ * @param node - 新表达式节点
+ * @returns prefix 属性值节点，不存在时返回 undefined
+ */
+declare function extractPrefixPropertyNode(node: ESTree.NewExpression): ESTree.Node | undefined;
+/**
+ * 判断文件路径是否命中豁免后缀清单
+ *
+ * @param filename - 当前文件路径
+ * @param allowedFiles - 豁免文件路径后缀列表
+ * @returns 命中任一后缀返回 true
+ */
+declare function isAllowedFile(filename: string, allowedFiles: string[]): boolean;
+/**
+ * 判断路径字面量是否命中豁免路径清单
+ *
+ * @param path - 注册路径值
+ * @param allowedPaths - 豁免路径字面量列表
+ * @returns 完全一致命中返回 true
+ */
+declare function isAllowedPath(path: string, allowedPaths: string[]): boolean;
+/**
+ * 读取路径表达式的静态字符串值
+ *
+ * @param node - 表达式节点
+ * @returns 字符串字面量值，非字面量时返回 undefined
+ */
+declare function readPathValue(node: ESTree.Node): string | undefined;
+//#endregion
+//#region src/types.d.ts
+/**
+ * Elysia 路由管理插件类型定义
+ *
+ * 定义路由方法集合、裸路径判定与规则选项等核心类型
+ */
+/**
+ * Elysia 路由注册方法名集合
+ */
+type ElysiaRouteMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'all' | 'route' | 'group';
+/**
+ * no-bare-route-path 规则选项
+ */
+type NoBareRoutePathOptions = {
+  /**
+   * 豁免文件路径后缀列表，命中任一后缀的文件整件豁免
+   */
+  allowedFiles?: string[];
+  /**
+   * 豁免路径字面量列表，注册路径与清单内字面量完全一致时豁免
+   */
+  allowedPaths?: string[];
+};
+//#endregion
+//#region src/index.d.ts
+/**
+ * elysia-route 插件
+ *
+ * 提供 Elysia 路由契约绑定相关的 Oxlint 规则，
+ * 通过 eslintCompatPlugin 包装以同时支持 Oxlint 和 ESLint 运行时
+ */
+declare const elysiaRoutePlugin: import("@oxlint/plugins").Plugin;
+//#endregion
+export { type ElysiaRouteMethod, type NoBareRoutePathOptions, elysiaRoutePlugin as default, elysiaRoutePlugin, extractPrefixPropertyNode, isAllowedFile, isAllowedPath, isNewElysiaExpression, isPathLikeExpression, isRouteRegistrationCall, noBareRoutePathRule, readPathValue };

package/dist/index.js

@@ -0,0 +1 @@
+import{defineRule as e,eslintCompatPlugin as t}from"@oxlint/plugins";const n=[`get`,`post`,`put`,`patch`,`delete`,`all`,`route`,`group`];function r(e){if(e.type===`Literal`&&`value`in e&&typeof e.value==`string`)return e.value}function i(e){switch(e.type){case`Literal`:return r(e)?.startsWith(`/`)===!0;case`TemplateLiteral`:return e.quasis[0]?.value.raw.startsWith(`/`)===!0;case`BinaryExpression`:return e.operator===`+`&&i(e.left);default:return!1}}function a(e){if(e.callee.type!==`MemberExpression`)return!1;let t=e.callee.property;if(t.type!==`Identifier`||!n.includes(t.name))return!1;let r=e.arguments[0];return r?i(r):!1}function o(e){return e.callee.type===`Identifier`&&e.callee.name===`Elysia`}function s(e){let t=e.arguments[0];if(t&&t.type===`ObjectExpression`){for(let e of t.properties)if(e.type===`Property`&&e.key.type===`Identifier`&&e.key.name===`prefix`)return e.value}}function c(e,t){return t.some(t=>e.includes(t))}function l(e,t){return t.includes(e)}function u(e){return r(e)}const d=`Elysia 路由注册禁止裸 URL 路径字面量，路径必须取自契约 RouteDefinition 字典导出（如 xxxRoutes.operation.path）。`;function f(e){return Array.isArray(e)&&e.every(e=>typeof e==`string`)}function p(e){return!(typeof e!=`object`||!e||!(`allowedFiles`in e)&&!(`allowedPaths`in e)||`allowedFiles`in e&&e.allowedFiles!==void 0&&!f(e.allowedFiles)||`allowedPaths`in e&&e.allowedPaths!==void 0&&!f(e.allowedPaths))}const m=e({meta:{type:`problem`,docs:{description:`Elysia 路由注册禁止裸 URL 路径字面量，路径必须取自契约 RouteDefinition 字典导出`},schema:[{type:`object`,properties:{allowedFiles:{type:`array`,items:{type:`string`},description:`豁免文件路径后缀列表，命中文件整件豁免`},allowedPaths:{type:`array`,items:{type:`string`},description:`豁免路径字面量列表，完全一致时豁免`}},additionalProperties:!1}]},createOnce(e){let t=!1,n=[];return{Program(r){t=!1,n=[];let i=e.options?.[0];if(!p(i))return;let a=i;n=a.allowedPaths??[],a.allowedFiles!==void 0&&c(e.filename,a.allowedFiles)&&(t=!0)},CallExpression(r){if(t||!a(r))return;let i=r.arguments[0];if(!i)return;let o=u(i);o!==void 0&&l(o,n)||e.report({node:i,message:d})},NewExpression(r){if(t||!o(r))return;let a=s(r);if(!a||!i(a))return;let c=u(a);c!==void 0&&l(c,n)||e.report({node:a,message:d})}}}}),h=t({meta:{name:`@longzai-intelligence-oxlint/elysia-route-plugin`},rules:{"no-bare-route-path":m}});export{h as default,h as elysiaRoutePlugin,s as extractPrefixPropertyNode,c as isAllowedFile,l as isAllowedPath,o as isNewElysiaExpression,i as isPathLikeExpression,a as isRouteRegistrationCall,m as noBareRoutePathRule,u as readPathValue};

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@longzai-intelligence-oxlint/elysia-route-plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.47",
+  "description": "Longzai Intelligence oxlint Elysia 路由规则插件",
+  "keywords": [
+    "elysia",
+    "longzai-intelligence",
+    "oxlint",
+    "route",
+    "rules"
+  ],
+  "license": "UNLICENSED",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "lzi-builder",
+    "build:prod": "NODE_ENV=production bun run build",
+    "prepublishOnly": "bun run build:prod",
+    "dev": "lzi-builder --watch",
+    "clean": "lzi-dev-cli clean",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "oxlint && oxfmt --check",
+    "lint:fix": "oxlint --fix && oxfmt",
+    "typecheck": "bun run typecheck:app && bun run typecheck:node && bun run typecheck:test",
+    "typecheck:app": "lzi-tsgo typecheck tsconfig/app.json",
+    "typecheck:node": "lzi-tsgo typecheck tsconfig/node.json",
+    "typecheck:test": "lzi-tsgo typecheck tsconfig/test.json"
+  },
+  "dependencies": {
+    "@oxlint/plugins": "^1.74.0"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.10",
+    "typescript": "^6.0.3"
+  },
+  "peerDependencies": {
+    "oxlint": ">=1.0.0"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.