framework-detect

一个用于检测Web项目框架的TypeScript库。

安装

tnpm install @tencent/framework-detect

使用方法

import { describeFramework } from '@tencent/framework-detect';

// 检测项目框架
const frameworkInfo = await describeFramework('./my-project');
console.log(frameworkInfo);

API

`describeFramework(projectRoot: string): Promise<FrameworkInfo>`

检测指定目录中的Web项目框架。

参数:

projectRoot (string): 项目根目录路径

返回值:

Promise<FrameworkInfo>: 框架信息对象

返回对象结构:

interface FrameworkInfo {
  Framework: string;    // 框架名称
  BuildCmd: string;     // 构建命令
  InstallCmd: string;   // 安装命令
  OutputDir: string;    // 输出目录
  IconPath?: string;    // 图标路径（可选）
}

支持的框架

Next.js
Gatsby
Remix
React Router
Astro
Hexo
Eleventy
Docusaurus
Solid
Vue
Angular
Svelte
React
Nuxt
Qwik
Hono
Vite

开发

# 安装依赖
npm install

# 构建
npm run build

# 运行测试
npm run test

@edgeone/framework-detect

Package Exports

Readme

framework-detect

安装

使用方法

API

describeFramework(projectRoot: string): Promise<FrameworkInfo>

支持的框架

开发

`describeFramework(projectRoot: string): Promise<FrameworkInfo>`