ts-abbr-skill 1.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 aShu-guo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -20,27 +20,41 @@
   <a href="https://github.com/aShu-guo/ts-abbreviation-skill/stargazers"><img src="https://img.shields.io/github/stars/aShu-guo/ts-abbreviation-skill?style=flat-square&logo=github" alt="GitHub stars"></a>
 </p>
 
-A Claude Code skill that makes generated/refactored TypeScript naming follow a shared abbreviation dictionary (`business` → `biz`, `context` → `ctx`, `configuration` → `cfg`, ...) instead of verbose full words.
+An agent skill that makes generated/refactored TypeScript naming follow a shared abbreviation dictionary (`business` → `biz`, `context` → `ctx`, `configuration` → `cfg`, ...) instead of verbose full words. Works with **Claude Code**, **Codex**, and [any agent supported by the `skills` CLI](https://github.com/vercel-labs/skills).
 
 ## Install
 
+### Option A — universal installer (recommended)
+
+Works with Claude Code, Codex, and 70+ other agents via [`skills`](https://github.com/vercel-labs/skills):
+
+```bash
+npx skills add aShu-guo/ts-abbreviation-skill
+```
+
+### Option B — dedicated installer
+
 ```bash
 npx ts-abbr-skill
 ```
 
-You'll be asked where to install:
+You'll be asked which agent(s) to install for (Claude Code, Codex — more than one can be selected) and where:
+
+| Agent | Project path | Global path |
+|-------|--------------|-------------|
+| Claude Code | `./.claude/skills/ts-abbr-skill/` | `~/.claude/skills/ts-abbr-skill/` |
+| Codex | `./.agents/skills/ts-abbr-skill/` | `~/.codex/skills/ts-abbr-skill/` |
 
-- **Project** — `./.claude/skills/ts-abbr-skill/` (recommended for team-shared conventions, commit this to your repo)
-- **Global** — `~/.claude/skills/ts-abbr-skill/` (applies to all your projects)
+Project scope is recommended for team-shared conventions — commit it to your repo. Global scope applies to all your projects.
 
-Both can be selected at once. Re-running the installer is safe: your customized `config/default.config.json` and `dictionary/default.json` are never overwritten.
+Re-running the installer is safe: your customized `config/default.config.json` and `dictionary/default.json` at the target are never overwritten.
 
 ## What it does
 
-- **When generating new code**: Claude checks the abbreviation dictionary before naming local variables/parameters and uses the abbreviated form when a match exists.
+- **When generating new code**: the agent checks the abbreviation dictionary before naming local variables/parameters and uses the abbreviated form when a match exists.
 - **When refactoring existing code**: batch renames go through an AST-aware rename script (`ts-morph`-based), never plain-text find/replace, so cross-file references stay correct. A `tsc --noEmit` check is required afterward before the rename is considered done.
 
-See [`skill/SKILL.md`](skill/SKILL.md) for the full rules Claude follows.
+See [`skills/ts-abbr-skill/SKILL.md`](skills/ts-abbr-skill/SKILL.md) for the full rules the agent follows.
 
 ## Built-in Dictionary (excerpt)
 
@@ -61,7 +75,7 @@ See [`skill/SKILL.md`](skill/SKILL.md) for the full rules Claude follows.
 | application | app |
 | ... | ... |
 
-Full dictionary: [`skill/dictionary/default.json`](skill/dictionary/default.json)
+Full dictionary: [`skills/ts-abbr-skill/dictionary/default.json`](skills/ts-abbr-skill/dictionary/default.json)
 
 ## Customize
 
@@ -73,7 +87,7 @@ Full dictionary: [`skill/dictionary/default.json`](skill/dictionary/default.json
 
 `scope` accepts `variable`, `parameter`, `localFunction`, `class`. `exported` controls whether public/exported symbols are eligible (default `false`).
 
-**Project-specific additions** — add `.claude/ts-abbr.local.json` at your repo root; entries are merged on top of the default dictionary:
+**Project-specific additions** — add `.ts-abbr-skill.local.json` at your repo root; entries are merged on top of the default dictionary:
 
 ```json
 {
@@ -93,7 +107,7 @@ node dist/cli.js  # try the installer locally
 For iterating on skill content, use a symlink instead of rebuilding:
 
 ```bash
-ln -sfn /path/to/ts-abbreviation-skill/skill \
+ln -sfn /path/to/ts-abbreviation-skill/skills/ts-abbr-skill \
   your-test-project/.claude/skills/ts-abbr-skill
 ```
 

package/README.zh-CN.md

@@ -20,27 +20,41 @@
   <a href="https://github.com/aShu-guo/ts-abbreviation-skill/stargazers"><img src="https://img.shields.io/github/stars/aShu-guo/ts-abbreviation-skill?style=flat-square&logo=github" alt="GitHub stars"></a>
 </p>
 
-一个 Claude Code Skill，让生成/重构的 TypeScript 代码命名遵循统一的缩写词典（`business` → `biz`、`context` → `ctx`、`configuration` → `cfg` 等），而不是冗长的全称。
+一个 Agent Skill，让生成/重构的 TypeScript 代码命名遵循统一的缩写词典（`business` → `biz`、`context` → `ctx`、`configuration` → `cfg` 等），而不是冗长的全称。支持 **Claude Code**、**Codex**，以及 [`skills` CLI 支持的所有 agent](https://github.com/vercel-labs/skills)。
 
 ## 安装
 
+### 方式 A — 通用安装器（推荐）
+
+通过 [`skills`](https://github.com/vercel-labs/skills) 支持 Claude Code、Codex 及 70+ 其他 agent：
+
+```bash
+npx skills add aShu-guo/ts-abbreviation-skill
+```
+
+### 方式 B — 专属安装器
+
 ```bash
 npx ts-abbr-skill
 ```
 
-安装时会询问装到哪里：
+会依次询问要为哪些 agent 安装（Claude Code、Codex，可多选）以及装到哪里：
+
+| Agent | 项目级路径 | 全局路径 |
+|-------|-----------|---------|
+| Claude Code | `./.claude/skills/ts-abbr-skill/` | `~/.claude/skills/ts-abbr-skill/` |
+| Codex | `./.agents/skills/ts-abbr-skill/` | `~/.codex/skills/ts-abbr-skill/` |
 
-- **项目级** — `./.claude/skills/ts-abbr-skill/`（推荐团队共享，提交到仓库）
-- **全局** — `~/.claude/skills/ts-abbr-skill/`（适用于你所有的项目）
+项目级推荐团队共享，提交到仓库；全局适用于你所有的项目。
 
-两个选项可以同时勾选。重复运行安装器是安全的：目标路径下已存在的 `config/default.config.json` 和 `dictionary/default.json` 不会被覆盖。
+重复运行安装器是安全的：目标路径下已存在的 `config/default.config.json` 和 `dictionary/default.json` 不会被覆盖。
 
 ## 效果
 
-- **生成新代码时**：Claude 在命名局部变量/参数之前查缩写词典，有匹配则使用缩写形式。
+- **生成新代码时**：agent 在命名局部变量/参数之前查缩写词典，有匹配则使用缩写形式。
 - **重构已有代码时**：批量改名强制走基于 AST 的重命名脚本（`ts-morph`），不允许纯文本替换，避免误改字符串字面量和跨作用域同名变量。改名后必须跑 `tsc --noEmit` 校验，不通过不算完成。
 
-完整规则见 [`skill/SKILL.md`](skill/SKILL.md)。
+完整规则见 [`skills/ts-abbr-skill/SKILL.md`](skills/ts-abbr-skill/SKILL.md)。
 
 ## 内置词典摘录
 
@@ -61,7 +75,7 @@ npx ts-abbr-skill
 | application | app |
 | ... | ... |
 
-完整词典见 [`skill/dictionary/default.json`](skill/dictionary/default.json)。
+完整词典见 [`skills/ts-abbr-skill/dictionary/default.json`](skills/ts-abbr-skill/dictionary/default.json)。
 
 ## 自定义
 
@@ -73,7 +87,7 @@ npx ts-abbr-skill
 
 `scope` 可选值：`variable`、`parameter`、`localFunction`、`class`。`exported` 控制是否对导出/公共符号生效（默认 `false`）。
 
-**添加项目专属缩写** — 在仓库根目录放 `.claude/ts-abbr.local.json`，词条会合并覆盖默认词典：
+**添加项目专属缩写** — 在仓库根目录放 `.ts-abbr-skill.local.json`，词条会合并覆盖默认词典：
 
 ```json
 {
@@ -93,7 +107,7 @@ node dist/cli.js     # 本地测试安装器
 迭代调试 Skill 内容时，用 symlink 代替每次重新构建：
 
 ```bash
-ln -sfn /path/to/ts-abbreviation-skill/skill \
+ln -sfn /path/to/ts-abbreviation-skill/skills/ts-abbr-skill \
   your-test-project/.claude/skills/ts-abbr-skill
 ```
 

package/dist/cli.js

@@ -9,13 +9,22 @@ import os from "os";
 import path from "path";
 import { fileURLToPath } from "url";
 var __dirname = path.dirname(fileURLToPath(import.meta.url));
-var SKILL_NAME = "ts-abbreviation-skill";
+var SKILL_NAME = "ts-abbr-skill";
 var PROTECTED_RELATIVE_PATHS = ["config/default.config.json", "dictionary/default.json"];
+var AGENT_SKILLS_DIR = {
+  "claude-code": { project: ".claude/skills", global: ".claude/skills" },
+  codex: { project: ".agents/skills", global: ".codex/skills" }
+};
+var AGENT_LABELS = {
+  "claude-code": "Claude Code",
+  codex: "Codex"
+};
 function getSkillSourceDir() {
-  return path.join(__dirname, "..", "skill");
+  return path.join(__dirname, "..", "skills", SKILL_NAME);
 }
-function getTargetDir(scope, cwd) {
-  const base = scope === "project" ? path.join(cwd, ".claude", "skills") : path.join(os.homedir(), ".claude", "skills");
+function getTargetDir(agent, scope, cwd) {
+  const relDir = AGENT_SKILLS_DIR[agent][scope];
+  const base = scope === "project" ? path.join(cwd, relDir) : path.join(os.homedir(), relDir);
   return path.join(base, SKILL_NAME);
 }
 function copyRecursive(srcDir, destDir, protectedRelPaths, relPrefix = "") {
@@ -37,23 +46,37 @@ function copyRecursive(srcDir, destDir, protectedRelPaths, relPrefix = "") {
   }
   return skipped;
 }
-function installSkill(scope, cwd = process.cwd()) {
+function installSkill(agent, scope, cwd = process.cwd()) {
   const srcDir = getSkillSourceDir();
-  const targetDir = getTargetDir(scope, cwd);
+  const targetDir = getTargetDir(agent, scope, cwd);
   const skippedExisting = copyRecursive(srcDir, targetDir, new Set(PROTECTED_RELATIVE_PATHS));
   return { targetDir, skippedExisting };
 }
 
 // src/cli.ts
 async function main() {
-  console.log("ts-abbreviation-skill installer\n");
+  console.log("ts-abbr-skill installer\n");
+  const { agents } = await prompts({
+    type: "multiselect",
+    name: "agents",
+    message: "Which AI coding agent(s) should this skill be installed for?",
+    choices: [
+      { title: AGENT_LABELS["claude-code"], value: "claude-code", selected: true },
+      { title: AGENT_LABELS["codex"], value: "codex" }
+    ],
+    min: 1
+  });
+  if (!agents || agents.length === 0) {
+    console.log("No agent selected, aborting.");
+    process.exit(1);
+  }
   const { scopes } = await prompts({
     type: "multiselect",
     name: "scopes",
     message: "Where should this skill be installed?",
     choices: [
-      { title: "This project (./.claude/skills/)", value: "project", selected: true },
-      { title: "Global (~/.claude/skills/)", value: "global" }
+      { title: "This project", value: "project", selected: true },
+      { title: "Global (all your projects)", value: "global" }
     ],
     min: 1
   });
@@ -61,18 +84,20 @@ async function main() {
     console.log("No install scope selected, aborting.");
     process.exit(1);
   }
-  for (const scope of scopes) {
-    const { targetDir, skippedExisting } = installSkill(scope);
-    console.log(`
-\u2714 Installed to ${targetDir}`);
-    if (skippedExisting.length > 0) {
-      console.log(`  Kept existing customizations (not overwritten): ${skippedExisting.join(", ")}`);
+  for (const agent of agents) {
+    for (const scope of scopes) {
+      const { targetDir, skippedExisting } = installSkill(agent, scope);
+      console.log(`
+\u2714 Installed for ${AGENT_LABELS[agent]} to ${targetDir}`);
+      if (skippedExisting.length > 0) {
+        console.log(`  Kept existing customizations (not overwritten): ${skippedExisting.join(", ")}`);
+      }
     }
   }
   console.log("\nNext steps:");
-  console.log("  - Restart/reopen Claude Code so it picks up the new skill.");
+  console.log("  - Restart/reopen your AI coding agent so it picks up the new skill.");
   console.log("  - Customize scope/exported in <target>/config/default.config.json if needed.");
-  console.log("  - Add project-specific abbreviations via .claude/ts-abbreviation.local.json in your repo.");
+  console.log("  - Add project-specific abbreviations via .ts-abbr-skill.local.json in your repo.");
 }
 main().catch((err) => {
   console.error(err);

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "ts-abbr-skill",
-  "version": "1.0.0",
-  "description": "Claude Code skill that applies a configurable abbreviation dictionary (business→biz, context→ctx, ...) to TypeScript variable/parameter naming.",
+  "version": "1.1.0",
+  "description": "Agent skill (Claude Code, Codex, and more) that applies a configurable abbreviation dictionary (business→biz, context→ctx, ...) to TypeScript variable/parameter naming.",
   "type": "module",
   "bin": {
     "ts-abbr-skill": "dist/cli.js"
   },
   "files": [
     "dist",
-    "skill"
+    "skills"
   ],
   "scripts": {
     "build": "tsup",
@@ -16,12 +16,18 @@
   },
   "keywords": [
     "claude-code",
+    "codex",
+    "agent-skills",
     "skill",
     "typescript",
     "naming",
     "abbreviation"
   ],
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aShu-guo/ts-abbreviation-skill.git"
+  },
   "dependencies": {
     "prompts": "^2.4.2"
   },

package/{skill → skills/ts-abbr-skill}/SKILL.md

@@ -1,5 +1,5 @@
 ---
-name: ts-abbreviation-skill
+name: ts-abbr-skill
 description: Use when writing or refactoring TypeScript variable, parameter, function, or class names — applies a configurable abbreviation dictionary (business→biz, context→ctx, configuration→cfg, etc.) so generated and refactored code matches the team's naming conventions.
 ---
 
@@ -13,7 +13,7 @@ Generated TypeScript code tends to use full, verbose English words for local nam
 
 Before naming anything, resolve config and dictionary by merging, most specific first:
 
-1. Project override: `.claude/ts-abbreviation.local.json` in the current repo root (if present) — entries here are merged on top of the default dictionary/config, not a full replacement.
+1. Project override: `.ts-abbr-skill.local.json` in the current repo root (if present) — entries here are merged on top of the default dictionary/config, not a full replacement.
 2. Default config/dictionary shipped with this skill: `config/default.config.json`, `dictionary/default.json`.
 
 Default config (`config/default.config.json`):
@@ -27,7 +27,7 @@ Default config (`config/default.config.json`):
 - `scope`: which kinds of identifiers this applies to. Possible values: `variable`, `parameter`, `localFunction`, `class`. Only apply abbreviations to kinds listed here.
 - `exported`: whether exported/public symbols (exported consts, public class members, public function names) are in scope. Default `false` — never abbreviate a symbol that's part of a public API unless the project config explicitly sets `exported: true`.
 
-If the project has no `.claude/ts-abbreviation.local.json`, use the defaults as-is.
+If the project has no `.ts-abbr-skill.local.json`, use the defaults as-is.
 
 ## Mode 1: Generating New Code
 

package/{skill → skills/ts-abbr-skill}/config/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "ts-abbreviation-skill config",
+  "title": "ts-abbr-skill config",
   "type": "object",
   "additionalProperties": false,
   "properties": {