promptex-js 0.0.1-alpha.1

package/LICENSE-APACHE

@@ -0,0 +1,204 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the
+      purposes of this License, Derivative Works shall not include works
+      that remain separable from, or merely link (or bind by name) to the
+      interfaces of, the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright
+      owner or by an individual or Legal Entity authorized to submit on
+      behalf of the copyright owner. For the purposes of this definition,
+      "submitted" means any form of electronic, verbal, or written
+      communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing
+      lists, source code control systems, and issue tracking systems that
+      are managed by, or on behalf of, the Licensor for the purpose of
+      discussing and improving the Work, but excluding communication that
+      is conspicuously marked or otherwise designated in writing by the
+      copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing
+      the origin of the Work and reproducing the content of the NOTICE
+      file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this
+      License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 promptex-ai
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 promptex-ai
+
+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

@@ -0,0 +1,84 @@
+# promptex-js（alpha 原型）
+
+promptex 的 TypeScript SDK **最小原型**。目前的能力只有一項：宣告 skill，
+建置成 Claude Code 的 `SKILL.md` 產物。
+
+## 這不是什麼
+
+本套件是早期 alpha，**不是**完整的 promptex。正式版的單一套件內含 SDK、核心的
+預編譯二進位綁定與完整命令列工具三者；本原型只有 SDK 的最窄一條路徑，命令列
+工具只有 `build` 一個動詞，沒有原生綁定、沒有多平台投影、沒有引用與關係圖、
+沒有安裝與所有權登記。
+
+介面與產物格式在正式版之前都會變，不保證任何相容性。正式版發布時本原型會被
+整份取代。
+
+## 安裝
+
+```bash
+npm install promptex-js@alpha
+```
+
+需要 Node.js 22.14 以上。
+
+## 用法
+
+把宣告寫在 `prompts/` 下：
+
+```ts
+// prompts/skill.ts
+import { defineSkill } from 'promptex-js'
+
+export const commitHelper = defineSkill({
+  id: 'commit-helper',
+  name: 'Commit 訊息協助',
+  config: { whenToUse: '當使用者要求撰寫 commit 訊息時使用' },
+  content: [
+    '依 Conventional Commits 撰寫：type(scope): subject。',
+    'subject 用繁體中文、50 字內，不以句號結尾；body 說明變更動機而非變更內容。',
+  ],
+})
+```
+
+建置：
+
+```bash
+npx promptex build
+```
+
+產出 `./.claude/skills/commit-helper/SKILL.md`：
+
+```text
+---
+name: commit-helper
+description: 當使用者要求撰寫 commit 訊息時使用
+---
+
+依 Conventional Commits 撰寫：type(scope): subject。
+
+subject 用繁體中文、50 字內，不以句號結尾；body 說明變更動機而非變更內容。
+```
+
+`.ts` 宣告檔不需要先經過建置步驟，命令列工具靠 Node 的型別剝離直接載入。
+
+### 命令列選項
+
+```text
+promptex build [--src <目錄>] [--out <目錄>]
+
+  --src <目錄>   宣告檔所在目錄，預設 prompts
+  --out <目錄>   產物輸出目錄，預設當前目錄
+```
+
+### 程式化呼叫
+
+```ts
+import { build, defineSkill, renderSkill } from 'promptex-js'
+
+defineSkill({ /* ... */ })
+const written = await build('.')
+```
+
+## 授權
+
+MIT OR Apache-2.0，見 `LICENSE-MIT` 與 `LICENSE-APACHE`。

package/bin/promptex.mjs

@@ -0,0 +1,113 @@
+#!/usr/bin/env node
+// promptex 命令列工具（alpha 原型）。
+//
+// 只有一個動詞：`build`。載入來源目錄下的宣告檔，把登記處內的 skill 投影
+// 成 SKILL.md。正式版的其餘動詞（evaluate、declare、config、diagnostics）
+// 不在本原型範圍內。
+
+import { spawnSync } from 'node:child_process'
+import { readdir, stat } from 'node:fs/promises'
+import { join, resolve } from 'node:path'
+import { pathToFileURL } from 'node:url'
+
+const USAGE = `promptex（alpha 原型）
+
+用法：
+  promptex build [--src <目錄>] [--out <目錄>]
+
+選項：
+  --src <目錄>   宣告檔所在目錄，預設 prompts
+  --out <目錄>   產物輸出目錄，預設當前目錄
+  --help         顯示本說明
+`
+
+/** 宣告檔的副檔名。`.ts` 依賴 Node 的型別剝離，不經過額外的建置步驟。 */
+const SOURCE_EXTENSIONS = ['.ts', '.mts', '.js', '.mjs']
+
+function parseArgs(argv) {
+  const args = { verb: argv[0], src: 'prompts', out: '.' }
+  for (let i = 1; i < argv.length; i += 1) {
+    const flag = argv[i]
+    if (flag === '--src' || flag === '--out') {
+      const value = argv[i + 1]
+      if (value === undefined) throw new Error(`${flag} 後面缺少值`)
+      args[flag.slice(2)] = value
+      i += 1
+    } else {
+      throw new Error(`未知的選項：${flag}`)
+    }
+  }
+  return args
+}
+
+/** 遞迴列出來源目錄下的宣告檔，依路徑排序讓載入順序不隨檔案系統而變。 */
+async function collectSources(dir) {
+  const entries = await readdir(dir, { withFileTypes: true })
+  const found = []
+  for (const entry of entries) {
+    const path = join(dir, entry.name)
+    if (entry.isDirectory()) found.push(...(await collectSources(path)))
+    else if (SOURCE_EXTENSIONS.some((ext) => entry.name.endsWith(ext))) found.push(path)
+  }
+  return found.sort()
+}
+
+async function main() {
+  const argv = process.argv.slice(2)
+  if (argv.length === 0 || argv[0] === '--help' || argv[0] === '-h') {
+    process.stdout.write(USAGE)
+    return
+  }
+
+  const args = parseArgs(argv)
+  if (args.verb !== 'build') {
+    process.stderr.write(`未知的動詞：${args.verb}\n\n${USAGE}`)
+    process.exitCode = 1
+    return
+  }
+
+  const srcDir = resolve(args.src)
+  try {
+    if (!(await stat(srcDir)).isDirectory()) throw new Error('不是目錄')
+  } catch {
+    process.stderr.write(`找不到來源目錄：${srcDir}\n`)
+    process.exitCode = 1
+    return
+  }
+
+  const sources = await collectSources(srcDir)
+  if (sources.length === 0) {
+    process.stderr.write(`來源目錄沒有宣告檔（${SOURCE_EXTENSIONS.join('、')}）：${srcDir}\n`)
+    process.exitCode = 1
+    return
+  }
+
+  // 載入宣告檔與呼叫 build 必須共用同一個模組實例，登記處才看得到宣告；
+  // 兩邊都經 `promptex-js` 的 dist 進入點解析，因此指向同一個模組。
+  const { build, declaredCount } = await import('../dist/index.js')
+  for (const source of sources) await import(pathToFileURL(source).href)
+
+  if (declaredCount() === 0) {
+    process.stderr.write(`載入了 ${sources.length} 份宣告檔，但沒有任何 skill 被宣告。\n`)
+    process.exitCode = 1
+    return
+  }
+
+  for (const path of await build(resolve(args.out))) process.stdout.write(`${path}\n`)
+}
+
+// Node 未內建型別剝離時（22.18 之前）以旗標重跑一次，讓 `.ts` 宣告檔不必
+// 先經過建置步驟。已內建的版本不重跑，避免多開一個行程。
+if (!process.features.typescript) {
+  const result = spawnSync(
+    process.execPath,
+    ['--experimental-strip-types', new URL(import.meta.url).pathname, ...process.argv.slice(2)],
+    { stdio: 'inherit' },
+  )
+  process.exit(result.status ?? 1)
+} else {
+  await main().catch((error) => {
+    process.stderr.write(`${error.message}\n`)
+    process.exitCode = 1
+  })
+}

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+/** skill 的觸發設定。 */
+export interface SkillConfig {
+    /** 觸發語料，投影為產物 frontmatter 的 `description`。 */
+    whenToUse: string;
+}
+/** 一份 skill 的宣告。本原型只承載正式版 `SkillDef` 的最小子集。 */
+export interface SkillDef {
+    /** 資源識別，同時是產物目錄名。 */
+    id: string;
+    /** 顯示名稱。 */
+    name: string;
+    /** 觸發設定。 */
+    config: SkillConfig;
+    /** 內容。單段用字串，多段用陣列，段落之間以空行分隔。 */
+    content: string | string[];
+}
+/** 宣告後回傳的引用。正式版以它承載節點間的引用關係，本原型只帶識別。 */
+export interface Ref {
+    readonly kind: 'skill';
+    readonly id: string;
+}
+/**
+ * 宣告一份 skill。
+ *
+ * 宣告本身不寫檔；產物在 {@link build} 被呼叫時一次產出。
+ */
+export declare function defineSkill(def: SkillDef): Ref;
+/** 目前已登記的宣告數。供呼叫端在建置前自我核對用。 */
+export declare const declaredCount: () => number;
+/**
+ * 把一份 skill 投影成 SKILL.md 的完整內容。
+ *
+ * frontmatter 的 `name` 取 id 而非顯示名稱：平台側以 `name` 作為喚起時的識別。
+ */
+export declare function renderSkill(skill: {
+    id: string;
+    whenToUse: string;
+    content: string[];
+}): string;
+/** 一份 skill 在輸出目錄下的產物路徑。 */
+export declare const skillPath: (outDir: string, id: string) => string;
+/**
+ * 把目前登記的全部宣告投影到輸出目錄，回傳產物路徑。
+ *
+ * 呼叫後登記處清空：同一行程內連續建置兩個輸出目錄時，第二次不該重複寫出
+ * 第一次的內容。
+ */
+export declare function build(outDir: string): Promise<string[]>;

package/dist/index.js

@@ -0,0 +1,62 @@
+// promptex-js（alpha 原型）：TypeScript SDK 的公開入口。
+//
+// 目前的能力只有一條路徑：宣告 skill，投影成 Claude Code 的 SKILL.md。
+// 正式版的核心綁定、多平台投影、引用與關係圖都不在本原型範圍內。
+import { mkdir, writeFile } from 'node:fs/promises';
+import { dirname, join } from 'node:path';
+// 模組層級的登記處：宣告散落在多個檔案時，逐一回傳並手動彙整會讓每個檔案
+// 都得認識彙整點。正式版的收集語意相同。
+const registry = [];
+/**
+ * id 是否可安全作為單層目錄名。
+ *
+ * 產物路徑由 id 直接組成，不擋下來的話 `../` 這類值會把檔案寫到輸出目錄之外。
+ */
+const isValidId = (id) => id.length > 0 && !id.includes('/') && !id.includes('\\') && id !== '.' && id !== '..';
+/**
+ * 宣告一份 skill。
+ *
+ * 宣告本身不寫檔；產物在 {@link build} 被呼叫時一次產出。
+ */
+export function defineSkill(def) {
+    if (!isValidId(def.id)) {
+        throw new Error(`skill id 不可為空、且不可含 \`/\`、\`\\\` 或 \`..\`：${JSON.stringify(def.id)}`);
+    }
+    registry.push({
+        id: def.id,
+        name: def.name,
+        whenToUse: def.config.whenToUse,
+        content: Array.isArray(def.content) ? def.content : [def.content],
+    });
+    return { kind: 'skill', id: def.id };
+}
+/** 目前已登記的宣告數。供呼叫端在建置前自我核對用。 */
+export const declaredCount = () => registry.length;
+/**
+ * 把一份 skill 投影成 SKILL.md 的完整內容。
+ *
+ * frontmatter 的 `name` 取 id 而非顯示名稱：平台側以 `name` 作為喚起時的識別。
+ */
+export function renderSkill(skill) {
+    const header = `---\nname: ${skill.id}\ndescription: ${skill.whenToUse}\n---\n`;
+    return skill.content.length === 0 ? header : `${header}\n${skill.content.join('\n\n')}\n`;
+}
+/** 一份 skill 在輸出目錄下的產物路徑。 */
+export const skillPath = (outDir, id) => join(outDir, '.claude', 'skills', id, 'SKILL.md');
+/**
+ * 把目前登記的全部宣告投影到輸出目錄，回傳產物路徑。
+ *
+ * 呼叫後登記處清空：同一行程內連續建置兩個輸出目錄時，第二次不該重複寫出
+ * 第一次的內容。
+ */
+export async function build(outDir) {
+    const skills = registry.splice(0, registry.length);
+    const written = [];
+    for (const skill of skills) {
+        const path = skillPath(outDir, skill.id);
+        await mkdir(dirname(path), { recursive: true });
+        await writeFile(path, renderSkill(skill), 'utf8');
+        written.push(path);
+    }
+    return written;
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "promptex-js",
+  "version": "0.0.1-alpha.1",
+  "description": "promptex 的 TypeScript SDK 最小原型（alpha）：宣告 skill 並投影成 SKILL.md",
+  "license": "MIT OR Apache-2.0",
+  "author": "promptex-ai",
+  "homepage": "https://github.com/promptex-ai/promptex#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/promptex-ai/promptex.git"
+  },
+  "bugs": {
+    "url": "https://github.com/promptex-ai/promptex/issues"
+  },
+  "keywords": [
+    "prompt",
+    "prompt-engineering",
+    "ai",
+    "llm",
+    "agent",
+    "claude",
+    "skills",
+    "codegen"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "promptex": "./bin/promptex.mjs"
+  },
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "files": [
+    "dist",
+    "bin",
+    "README.md",
+    "LICENSE-MIT",
+    "LICENSE-APACHE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepack": "npm run build",
+    "test": "node --test 'test/*.test.mjs'"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "typescript": "^5.7.0"
+  }
+}