מניפסט (ingot.json)

לכל תוסף יש ingot.json בתיקיית השורש: מי מפרסם אותו, מה הגרסה והסוג שלו, מה הוא מוסיף ל-Ingot ואילו קבצים נכנסים לחבילת ה-.ingotx. הדף הזה מפרט כל שדה ואת הבדיקות שהחנות מריצה עליו.

הוסיפו את שורת הסכמה, והעורך שלכם ישלים ויבדוק את הקובץ תוך כדי הקלדה:

{ "$schema": "https://www.ingotide.com/schemas/ingot.json" }

דוגמה

{
  "$schema": "https://www.ingotide.com/schemas/ingot.json",
  "name": "react-rules",
  "publisher": "acme",
  "displayName": "React Rules",
  "version": "1.2.0",
  "type": "rules",
  "description": "Conventions for React and TypeScript projects.",
  "license": "MIT",
  "repository": "https://github.com/acme/react-rules",
  "keywords": ["react", "typescript"],
  "icon": { "mark": "Re", "color": "#1B2647" },
  "engines": { "ingot": ">=0.1.0" },
  "contributes": {
    "rules": [{ "path": "rules/react.mdc" }],
    "commands": [{ "name": "review", "description": "Review the open files", "path": "commands/review.md" }]
  }
}

שדות

שדהחובהכללים
$schemaלאאם מוגדר, חייב להיות https://www.ingotide.com/schemas/ingot.json
nameכן2 עד 50 אותיות קטנות או ספרות, מילים מחוברות ב--; ייחודי בתוך המפרסם שלכם
publisherכןמזהה המפרסם שלכם (3 עד 32 תווים)
displayNameכןהשם בחנות, עד 60 תווים
versionכןגרסה סמנטית כמו 1.0.0 או 1.1.0-beta.1, בלי v
typeכןtheme, rules, habits, mcp או rex-template (סוגים)
descriptionכןשורה אחת לכרטיס בחנות, עד 200 תווים
licenseכןמזהה SPDX כמו MIT או Apache-2.0
repository, homepageלאכתובות https://, מוצגות בדף בחנות
keywordsלאעד 10 מילים (30 תווים כל אחת), לחיפוש בחנות
iconלא{ "mark": "Re", "color": "#RRGGBB" }: 1 עד 3 תווים על אריח צבעוני
enginesלא{ "ingot": ">=0.1.0" }: הגרסה הישנה ביותר של Ingot שהתוסף עובד איתה
filesלאעד 50 קבצים או תיקיות נוספים לאריזה (סקריפטים, משאבים, קוד שרת)
contributesכןמה התוסף מוסיף; ראו למטה

מזהה התוסף הוא publisher.name (למשל acme.react-rules); הדף שלו בחנות הוא /marketplace/acme.react-rules. שדות לא מוכרים נדחים, וכך גם downloads, installs, rating, ratings, reviews ו-stars: החנות לא מציגה מספרים שהיא לא מדדה.

contributes

מפתחרשומהקבצים
themes{ "id", "label", "uiTheme": "dark" או "light", "path" }.json של ערכת צבעים עם colors ו/או tokenColors
rules{ "path" }.md או .mdc
habits{ "path" }.json עם id, title, match, rule ו-threshold אופציונלי
commands{ "name", "description", "path" }.md; name הופך ל-/name בצ'אט של הסוכן
mcpServers"id": { "command", "args", "env" } או "id": { "url" }אין (רשמו את קוד השרת תחת files)
rexTemplates{ "id", "title", "path" }.md

המפתח ב-contributes שמתאים ל-type חייב לכלול לפחות רשומה אחת. מזהים ושמות פקודות חייבים להיות ייחודיים בתוך החבילה.

בשרתי MCP: command היא התוכנית שרצה, args הארגומנטים שלה (${extensionDir} מוחלף בתיקיית ההתקנה), ו-env ממפה כל שם משתנה ב-UPPER_SNAKE_CASE לתיאור של מה שהמשתמש צריך להזין. לשרת מרוחק יש רק url, שחייב להיות https://.

מה נכנס לחבילה

ingot package כוללת:

  1. ingot.json
  2. README.md, CHANGELOG.md ו-LICENSE (או LICENSE.md, LICENSE.txt) אם הם קיימים
  3. כל קובץ שרשומה ב-contributes מצביעה עליו
  4. כל מה שמופיע ב-files (תיקייה כוללת את כל מה שבתוכה)

שום דבר אחר לא נארז, כך ש-node_modules, .git והערות מקומיות נשארים בחוץ. החנות דוחה חבילה שמכילה משהו אחר.

נתיבים חייבים להיות יחסיים, להשתמש ב-/ ולהישאר בתוך החבילה: בלי .., בלי / בהתחלה ובלי קבצים או תיקיות מוסתרים.

מגבלות

מגבלהערך
גודל החבילה (.ingotx)4 MB
גודל אחרי פריסה20 MB
קובץ בודד2 MB
קבצים בחבילה200
README שמוצג בדף בחנות50,000 תווים
העלאות למפרסם30 בשעה

הפורמט ‎.ingotx

קובץ .ingotx הוא ארכיון ZIP רגיל עם ingot.json בתיקיית השורש. אפשר לפתוח אותו בכל כלי לפריסת ZIP. ה-CLI כותב את הרשומות בסדר קבוע ועם חותמות זמן קבועות, כך שאריזה של אותם מקורות פעמיים נותנת אותם בייטים ואותו SHA-256. החנות בודקת הכול מחדש בהעלאה: את המניפסט, כל נתיב, תוכן הקבצים והמגבלות שלמעלה.