ex-minimal-plugin-ts 0.0.1-alpha.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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/README.md

@@ -0,0 +1,33 @@
+# ex-minimal-plugin-ts
+
+[ex-minimal-project-ts](../../) 的 plugin 擴展。由專案以相對路徑直接編譯進來，不走套件解析：Node 的型別剝離不作用於 node_modules 底下的 .ts，擴展若包成套件就得先跑一次建置才裝得動；同時保持可發布形態——中繼欄位、參數宣告與授權都隨套件出貨，版號比照 promptex 的 alpha 原型套件。
+
+plugin 掛在求值管線的三個生命週期上，順序固定：
+
+1. `prepare`——唯一 async 的階段，跑在收集遍之前。真實 plugin 在這裡請求外部資源，或以 `ctx.cacheDir` 快取、`ctx.writeLock` 記錄鎖定，再經閉包把資料交給後續階段。
+2. `transform`——改寫遍。改寫既有節點一律經 ctx 操作函式（`appendContent`／`patchConfig`），型別安全、變更可追蹤、衝突可偵測；也可在此以 `define*` 新增節點。
+3. `validate`——解析遍，核心檢查在先。對註冊表做結構驗證並回傳診斷，空清單即通過。
+
+plugin 產出的是節點而非檔案：要落地的內容以 `define*` 新增資源節點，由核心落地為產物。
+
+## 在本專案的接法
+
+`promptex.config.ts` 以 `plugins: [createPlugin()]` 掛上。跑 `npx promptex install .` 後，兩個平台的 `example-rule` 產物末尾都會多出本 plugin 在 `transform` 追加的那一行——那是它有生效的可見證據。
+
+## 參數宣告
+
+參數宣告（標準 JSON Schema）住擴展目錄根的 `promptex.config.schema.json`，由 `src/index.ts` 在載入時讀進來（執行期讀檔而非編譯期 JSON import，產物樹因此保持扁平、全包只留套件根那一份），隨中介表示交給讀取端；`promptex config declare ex-minimal-plugin-ts` 讀的是同一份檔案。
+
+## 發布
+
+```bash
+npm install
+npm pack --dry-run
+npm publish --tag alpha --access public
+```
+
+`prepack` 綁著 `tsc`，`npm publish` 會自己先建置；`files` 只放 `dist`、參數宣告、README 與 LICENSE。發到 `alpha` 標籤而非 `latest`：預發布版不該被 `npm install` 預設選中，安裝端寫 `npm install ex-minimal-plugin-ts@alpha`。
+
+SDK 依賴不必換：`peerDependencies` 與 `devDependencies` 的 `promptex-js: ^0.0.0` 在 registry 上對到的是 promptex-prototype 發的 `0.0.0` **介面樁**——型別與簽名逐字複製正式版、方法本體一律拋錯。發布驗證（尤其 `cargo publish` 的建置）拿它編得過；裝到消費端也裝得起來，但實際執行要靠工作區覆寫指向本地的正式版 SDK，否則第一個碰到樁的呼叫就會以「promptex 介面樁」開頭的錯誤中止。
+
+名稱刻意不帶 `promptex-plugin-` 前綴——那是給要被消費端搜尋到的套件用的；本擴展的定位是示範，改以 keywords 的 `promptex-plugin` 承載可搜尋性。

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import type { Plugin } from 'promptex-js';
+/** 建構參數：與 promptex.config.schema.json 的宣告一一對應。 */
+export interface Options {
+    /** transform 階段追加到每個 skill 與 rule 的內容；省略時用預設文字。 */
+    readonly banner?: string;
+}
+export declare function createPlugin(options?: Options): Plugin;

package/dist/index.js

@@ -0,0 +1,49 @@
+// 最小可發布 plugin：三個生命週期各示範一件事，發布前把內容換成你的邏輯。
+// 生命週期固定順序：prepare（唯一 async 的階段，收集遍之前）→ 源碼求值 →
+// transform（改寫遍）→ validate（解析遍，核心檢查在先）。
+import { readFileSync } from 'node:fs';
+// 參數宣告（標準 JSON Schema）住套件根，由本檔在載入時讀進來。用執行期讀檔而非
+// 編譯期 import：JSON 在 include 的 src 之外，靜態 import 會把編譯器的共同來源根
+// 抬到套件根，產物因此多一層 src/，包裡還會留下第二份 schema。改讀檔之後
+// src/index.ts 與 dist/index.js 對套件根的相對位置相同，兩種形態都指向同一份。
+const configSchema = JSON.parse(readFileSync(new URL('../promptex.config.schema.json', import.meta.url), 'utf8'));
+const DEFAULT_BANNER = '（本節點由 ex-minimal-plugin-ts plugin 追加此行）';
+export function createPlugin(options = {}) {
+    // prepare 取得的資料存進閉包，transform 只讀閉包、不知道資料從何而來。
+    let banner = '';
+    return {
+        name: 'ex-minimal-plugin-ts',
+        // 宣告本擴充作用在哪幾種節點類型（供文件與讀取端），不隱含過濾。
+        kinds: ['skill', 'rule'],
+        // 相容的框架版本範圍：安裝的 promptex-js 落在範圍外時於編譯開始前報錯。
+        version: '^0.0.0',
+        // 參數宣告隨中介表示交給讀取端；
+        // `promptex config declare` 讀的是套件根的同一份檔案。
+        configSchema,
+        // 準備：唯一 async 的生命週期。真實 plugin 在這裡請求外部資源，或以
+        // ctx.cacheDir 快取、ctx.writeLock 記錄鎖定；本範例只把參數收斂成
+        // transform 要用的值。
+        async prepare() {
+            banner = options.banner ?? DEFAULT_BANNER;
+        },
+        // 改寫：改寫既有節點一律經 ctx 操作函式（appendContent／patchConfig），
+        // 型別安全、變更可追蹤、衝突可偵測；也可在此以 define* 新增節點。
+        transform(ctx) {
+            for (const entry of ctx.entries) {
+                if (entry.kind === 'skill' || entry.kind === 'rule')
+                    ctx.appendContent(entry, banner);
+            }
+        },
+        // 驗證：對註冊表做結構驗證，回傳診斷（空陣列即通過）。
+        validate(ctx) {
+            return ctx.entries
+                .filter((e) => e.id.startsWith('promptex-'))
+                .map((e) => ({
+                code: 'ex-minimal-plugin-ts-reserved-id',
+                message: `節點 ${e.id} 以保留前綴 promptex- 命名，請改用其他 id`,
+                at: [e.at],
+                severity: 'error',
+            }));
+        },
+    };
+}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "ex-minimal-plugin-ts",
+  "version": "0.0.1-alpha.1",
+  "description": "promptex plugin 擴展範例（alpha）：在改寫遍為 skill 與 rule 追加一行",
+  "license": "Apache-2.0",
+  "author": "promptex-ai",
+  "homepage": "https://github.com/promptex-ai/ex-minimal-project-ts#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/promptex-ai/ex-minimal-project-ts.git",
+    "directory": "plugins/ex-minimal-plugin-ts"
+  },
+  "bugs": {
+    "url": "https://github.com/promptex-ai/ex-minimal-project-ts/issues"
+  },
+  "keywords": [
+    "promptex",
+    "promptex-plugin",
+    "prompt",
+    "ai",
+    "llm",
+    "agent",
+    "codegen"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "files": [
+    "dist",
+    "promptex.config.schema.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepack": "npm run build"
+  },
+  "peerDependencies": {
+    "promptex-js": "^0.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "promptex-js": "^0.0.0",
+    "typescript": "^5.7.0"
+  }
+}

package/promptex.config.schema.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "ex-minimal-plugin-ts options",
+  "type": "object",
+  "properties": {
+    "banner": {
+      "type": "string",
+      "description": "Appended to every skill and rule at the transform stage. Defaults to a built-in notice."
+    }
+  },
+  "additionalProperties": false
+}