# @happyvertical/smrt-scanner 中文文档

规范地址：https://npmcn.com/package/%40happyvertical/smrt-scanner/

版本：0\.62\.1
npm 元数据更新时间：2026-11-17T07:54:02.503Z
中文译文更新时间：2026-11-17T09:28:06.546Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40happyvertical/smrt-scanner
原文对照：https://npmcn.com/package/%40happyvertical/smrt-scanner/?lang=original
项目主页：https://github.com/happyvertical/smrt#readme
源码仓库：https://github.com/happyvertical/smrt

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：987 kB，54 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2026-06-23T01:18:42.279Z
- 最新版本发布：2026-11-17T07:54:02.289Z
- 近 30 天下载量：51300（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：365（近 12 个月 365 个）

## 中文简介

使用 OXC 的高性能类型Script 扫描仪用于 SMRT 显示生成

## 安装

```sh
npm install @happyvertical/smrt-scanner
```

也可以使用：`pnpm add @happyvertical/smrt-scanner`、`yarn add @happyvertical/smrt-scanner`、`bun add @happyvertical/smrt-scanner`

## README

# @ happyvertical/ smrt-scanner (笑) @ info: whatsthis

使用高性能类型Script AST扫描仪 [牛津救济会](https://oxc-project.github.io/) 为S -m -r 从源文件提取类,字段,方法和装饰元数据而不执行.

## 安装

```bash
pnpm add @happyvertical/smrt-scanner
```

## 使用量

```typescript
import { OxcScanner, InheritanceResolver, ManifestAdapter } from '@happyvertical/smrt-scanner';
import { parseFile, parseSource, extractSmrtImports } from '@happyvertical/smrt-scanner';

// Scan a single file
const result = parseFile('/path/to/Product.ts');
// result.classes → RawClassDefinition[]
// result.smrtImports → Map of SMRT package imports

// Scan from source string
const source = `
  @smrt({ api: true })
  class Product extends SmrtObject {
    name: string = '';
    price: number = 0.0;
  }
`;
const parsed = parseSource(source, 'Product.ts');

// Full scanner with glob support
const scanner = new OxcScanner({ include: ['src/**/*.ts'] });
const results = await scanner.scan();

// Resolve inheritance across files
const resolver = new InheritanceResolver();
resolver.addClasses(results.classes);
const resolved = resolver.resolveAll();

// Convert to SMRT manifest format
const adapter = new ManifestAdapter();
const manifest = adapter.toManifest(resolved);
```

### 国 际

```bash
# Scan and output manifest
smrt-scan src/**/*.ts
```

## API 密码

### 类

| 导出 | 说明 |
| --- | --- |
| `OxcScanner` | 扫描类型脚本文件 `@smrt()` 装饰类 |
| `InheritanceResolver` | 解决跨文件的阶级继承链 |
| `ManifestAdapter` | 将原始扫描结果转换为 s- m-r- t 显示格式 |

### 职能

| 导出 | 说明 |
| --- | --- |
| `parseFile` | 解析单个类型脚本文件并提取元数据 |
| `parseSource` | 解析类型脚本源字符串 |
| `extractSmrtImports` | 从文件中提取 s-m-r- t 相关的导入 |

### 密钥类型

`RawClassDefinition`, (中文(简体) ), `RawFieldDefinition`, (中文(简体) ), `RawMethodDefinition`, (中文(简体) ), `RawDecoratorConfig`, (中文(简体) ), `ResolvedClassDefinition`, (中文(简体) ), `ScanResults`, (中文(简体) ), `FileScanResult`, (中文(简体) ), `OxcScannerOptions`, (中文(简体) ), `InferredFieldType`, (中文(简体) ), `FieldTypeInference`

## 依赖关系

-   端点( 可选) : `@happyvertical/smrt-core`

## 常见问题

### @happyvertical/smrt-scanner 是什么？

使用 OXC 的高性能类型Script 扫描仪用于 SMRT 显示生成

### 如何安装 @happyvertical/smrt-scanner？

在项目目录运行 npm install @happyvertical/smrt-scanner，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 smrt-scan，可以用 npx smrt-scan 直接运行。

### @happyvertical/smrt-scanner 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @happyvertical/smrt-scanner 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @happyvertical/smrt-scanner 可以商用吗？

@happyvertical/smrt-scanner 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @happyvertical/smrt-scanner 的下载量有多少？

根据 npm 官方下载统计，@happyvertical/smrt-scanner 在 2026/10/17 – 2026/11/15 这 30 天内被下载 51,300 次，日均约 1,710 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @happyvertical/smrt-scanner 还在维护吗？

最新版本 0\.62\.1 发布于 2026/11/17（今天）；至今共发布 365 个版本，其中过去 12 个月发布了 365 个；首次发布于 2026/06/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

