# eslint-plugin-textjs 中文文档

规范地址：https://npmcn.com/package/eslint-plugin-textjs/

版本：1\.4\.0
npm 元数据更新时间：2026-11-03T13:42:21.580Z
中文译文更新时间：2026-11-03T14:58:28.884Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/eslint-plugin-textjs
原文对照：https://npmcn.com/package/eslint-plugin-textjs/?lang=original
项目主页：https://textjs.org/docs/eslint
源码仓库：https://github.com/anomalyco/textjs

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

- 包体积（解压后）：295 kB，64 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：eslint ^9\.0\.0 \|\| ^10\.0\.0
- 首次发布：2026-11-01T12:58:03.815Z
- 最新版本发布：2026-11-03T13:42:21.416Z
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

ESLint对Text.js的规则：控制台安全的JSX、单元格宽度符号、帧节奏计时器、键映射和应用路由器约定。

## 安装

```sh
npm install eslint-plugin-textjs
```

也可以使用：`pnpm add eslint-plugin-textjs`、`yarn add eslint-plugin-textjs`、`bun add eslint-plugin-textjs`

## README

# ▼eslint-plugin-textjs

ESLint规则 [Text.js](https://textjs.org/) 应用程序：主机安全的JSX，单元宽度符号，帧节奏计时器，键映射和应用路由器约定。

```bash
bun add -d eslint eslint-plugin-textjs typescript-eslint
```

```js
// eslint.config.js
import { defineConfig } from "eslint/config";
import tseslint from "typescript-eslint";
import textjs from "eslint-plugin-textjs";

export default defineConfig(tseslint.configs.recommended, textjs.configs.recommended);
```

`configs.recommended` 和 `configs.strict` 是平面配置（ESLint 9和10）。

| 规则 | 捕获 |
| :-- | :-- |
| `no-dom-elements` | `<div>`， `<span>`控制台组件（TX003） |
| `no-box-in-text` | `<Box>` 以及内部的盒根组件 `<Text>` (TX004) |
| `no-unsupported-glyphs` | 盲文、U+ 2B00-2BFF符号等门罗缺少的符号；单格符号+ U+FE0F |
| `no-console-in-components` | `console.*` 与帧交错的调用 |
| `prefer-use-interval` | 生 `setInterval` 在组件 |
| `no-sub-frame-timers` | 间隔比Text.js的66ms帧速度快 |
| `prefer-use-keymap` | 手卷 `useInput` 键匹配（严格） |
| `valid-route-module` | 缺少默认导出（TX015）并且无效 `dynamic` （TX031）在路由文件 |
| `valid-metadata` | 被忽视或畸形 `metadata` / `generateMetadata` |
| `route-handler-exports` | 中的非方法导出和大小写错误的处理程序 `route.ts` |

文档: [textjs.org/docs/eslint](https://textjs.org/docs/eslint)

## 发展

```bash
bun test                                                   # RuleTester suites
bun scripts/lint-repo.ts                                   # strict config over apps/, examples/, templates (read-only)
```

## 常见问题

### eslint-plugin-textjs 是什么？

ESLint对Text\.js的规则：控制台安全的JSX、单元格宽度符号、帧节奏计时器、键映射和应用路由器约定。

### 如何安装 eslint-plugin-textjs？

在项目目录运行 npm install eslint-plugin-textjs，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^9\.0\.0 \|\| ^10\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### eslint-plugin-textjs 支持 TypeScript 吗？

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

### eslint-plugin-textjs 支持 ESM 还是 CommonJS？

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

### eslint-plugin-textjs 可以商用吗？

eslint-plugin-textjs 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### eslint-plugin-textjs 还在维护吗？

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