@lernapps/tooling

中文文档
0.1.1发布于 2026/11/01MITTypeScriptES Module构建来源已验证

Shared tooling of the lernapps.net apps and sites: the CLI lernapps, site actions, Renovate preset, guidance for building apps; documentation at https://lernapps.net/tooling/

原始使用文档
文档目录6 节
  1. Who it is for
  2. Where to start
  3. What is in it
  4. Contributing
  5. Links
  6. License

tooling

The tooling with which a creator and their AI assistant build a learning app for lernapps.net: an app that runs in the browser, collects nothing, is accessible, and is listed in the app overview within minutes. The creator publishes the app at their own address, by default their own GitHub Pages; once listed, lernapps.net serves a copy of it at lernapps.net/apps/start/<id>/.

The tooling is responsible for helping builders get their apps out. The app overview explains building and listing, and provides the apps themselves: the catalog.

The repo also holds the platform's upkeep, which creators don't use: the actions that check, publish and preview lernapps.net's own websites, and the update policy for dependencies.

Who it is for

  • Creators and their assistants who build an app. The creator needs no development skills; the assistant follows the guidance and the checks.
  • The platform owner and the review agent, who decide whether an app is listed.
  • Maintainers of the lernapps repos, who change the rules, the checks and the guidance.

Where to start

  • Creators: lernapps.net/apps/build/ says what to tell your assistant.
  • Assistants: read lernapps.net/tooling/llms.txt. It starts the build with the plan template.
  • The skills: one per phase, grouped by what they hold: process/, tooling/, content/, archetypes/. The platform rules hold for every app, however it is built.
  • The plan template: the whole workflow of an app's first version, from the first question to the listing. It names each skill at the step where it is needed. Every later change follows the increment template, in a plan of its own.
  • The architecture: what each part is responsible for and why.
  • The rule catalog: every rule by id, with where it is told and checked.

What is in it

  • The package @lernapps/tooling, on npm (released from CI with provenance, .github/workflows/release.yml): the guidance, the skills, the shared preset and lint rules of every app, and the CLI.
  • The CLI lernapps: init starts an app's plan in an empty folder and syncs the skills of the packages into the agent directories, skills --archetype adds those of the chosen archetype, create writes a new app for an archetype once the creator confirmed the plan, check checks an app the same way in its git hooks and in CI, update moves an app to the runtime and tooling versions of the latest tooling and replaces the app's lernapps-* skills with that tooling's (and an older app's single plan into .vibe/plans/), changes tells what a change can affect, so that hooks and CI run only that, screenshots writes an image of every page and every figure of a built explainer or quiz, to show a creator what a learner sees (npx lernapps screenshots --help). npx --yes @lernapps/tooling --help before an app exists, npx lernapps --help in one.
  • The actions in actions/: the app check, app publish and app preview actions of every app, and the site actions with which lernapps.net's own websites are checked, published and previewed. Each says what it does in its action.yml. The reusable workflow changes.yml gives other workflows the change scope, and its comments show how a required check never stays "Pending".
  • The documentation site: the architecture, the rule catalog, the published schemas and the llms.txt.
  • The review in review/: the procedure and rubric of the agent that reviews an app before listing.
  • The Renovate preset default.json, which every lernapps repo extends.

The details live where you use them: the help of each command, the description of each action, the error messages, and the comments in the code.

Contributing

npm ci, then npm run check runs exactly what CI runs. The pre-push hook runs a fast subset when a push changes no code.

License

MIT

版本与发布记录

@lernapps/tooling 共发布 4 个版本,首次发布于 2026/11/01;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.1latest2026/11/011 天前
0.1.02026/11/012 天前
0.0.12026/11/012 天前
0.0.0-stage2026/11/012 天前

关于 @lernapps/tooling 的常见问题

@lernapps/tooling 是什么?

lernapps.net应用和站点的共享工具:CLI lernapps,站点操作,更新预设,构建应用的指导;文档在 https://lernapps.net/tooling/

如何安装 @lernapps/tooling?

在项目目录运行 npm install @lernapps/tooling,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 lernapps,可以用 npx lernapps 直接运行。

@lernapps/tooling 支持 TypeScript 吗?

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

@lernapps/tooling 支持 ESM 还是 CommonJS?

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

@lernapps/tooling 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js ^22.18.0 || ^24.11.0 || >=26.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@lernapps/tooling 可以商用吗?

@lernapps/tooling 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@lernapps/tooling 还在维护吗?

最新版本 0.1.1 发布于 2026/11/01(1 天前);至今共发布 4 个版本,其中过去 12 个月发布了 4 个;首次发布于 2026/11/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。