@happyvertical/smrt-scanner

中文文档
0.62.1发布于 2026/11/17TypeScriptES Module近 30 天下载 5.1万

High-performance TypeScript scanner using OXC for SMRT manifest generation

原始使用文档
文档目录8 节
  1. Installation
  2. Usage
  3. CLI
  4. API
  5. Classes
  6. Functions
  7. Key Types
  8. Dependencies

@happyvertical/smrt-scanner

High-performance TypeScript AST scanner using OXC for s-m-r-t manifest generation. Extracts class, field, method, and decorator metadata from source files without executing them.

Installation

pnpm add @happyvertical/smrt-scanner

Usage

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);

CLI

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

API

Classes

ExportDescription
OxcScannerScans TypeScript files for @smrt() decorated classes
InheritanceResolverResolves class inheritance chains across files
ManifestAdapterConverts raw scan results to s-m-r-t manifest format

Functions

ExportDescription
parseFileParse a single TypeScript file and extract metadata
parseSourceParse a TypeScript source string
extractSmrtImportsExtract s-m-r-t-related imports from a file

Key Types

RawClassDefinition, RawFieldDefinition, RawMethodDefinition, RawDecoratorConfig, ResolvedClassDefinition, ScanResults, FileScanResult, OxcScannerOptions, InferredFieldType, FieldTypeInference

Dependencies

  • Peer (optional): @happyvertical/smrt-core

版本与发布记录

@happyvertical/smrt-scanner 共发布 365 个版本,首次发布于 2026/06/23;过去 12 个月发布了 365 个版本。

版本发布日期距今
0.62.1latest2026/11/17今天
0.62.02026/11/17今天
0.61.62026/11/161 天前
0.61.52026/11/161 天前
0.61.42026/11/161 天前
0.61.32026/11/152 天前

关于 @happyvertical/smrt-scanner 的常见问题

@happyvertical/smrt-scanner 是什么?

High-performance TypeScript scanner using OXC for SMRT manifest generation

如何安装 @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 和提交记录判断。