eslint-plugin-textjs

中文文档
1.4.0发布于 2026/11/03MITTypeScriptES Module

ESLint rules for Text.js: console-safe JSX, cell-width glyphs, frame-paced timers, keymaps and App Router conventions.

原始使用文档

▼ eslint-plugin-textjs

ESLint rules for Text.js apps: console-safe JSX, cell-width glyphs, frame-paced timers, keymaps and App Router conventions.

bun add -d eslint eslint-plugin-textjs typescript-eslint
// 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 and configs.strict are flat configs (ESLint 9 and 10).

RuleCatches
no-dom-elements<div>, <span>, … in console components (TX003)
no-box-in-text<Box> and box-rooted components inside <Text> (TX004)
no-unsupported-glyphsBraille, U+2B00–2BFF symbols and other glyphs Menlo lacks; one-cell symbols + U+FE0F
no-console-in-componentsconsole.* calls that interleave with frames
prefer-use-intervalRaw setInterval in components
no-sub-frame-timersIntervals faster than Text.js's 66ms frame pacing
prefer-use-keymapHand-rolled useInput key matching (strict)
valid-route-moduleMissing default exports (TX015) and invalid dynamic (TX031) in route files
valid-metadataIgnored or malformed metadata / generateMetadata
route-handler-exportsNon-method exports and miscased handlers in route.ts

Docs: textjs.org/docs/eslint

Development

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

版本与发布记录

eslint-plugin-textjs 共发布 10 个版本,首次发布于 2026/11/01;过去 12 个月发布了 10 个版本。

版本发布日期距今
1.4.0latest2026/11/03今天
1.3.02026/11/03今天
1.2.02026/11/03今天
1.1.02026/11/031 天前
1.0.42026/11/021 天前
1.0.32026/11/021 天前

关于 eslint-plugin-textjs 的常见问题

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 和提交记录判断。