מאמרי עזרה על Lightbuild CLI

‫Lightbuild CLI הוא כלי שורת הפקודה הרשמי של Lightbuild. בדף הזה מתוארות הפקודות והאפשרויות של הכלי. כדי להתקין את ה-CLI של Lightbuild, קראו את המאמר התקנת ה-CLI של Lightbuild. במאמר יצירת פרויקטים ב-Lightbuild משורת הפקודה מוסבר איך לבצע משימות נפוצות, כמו בנייה ובדיקה של הפרויקט.

תחביר

התחביר של Lightbuild CLI:

lightbuild [-V] [--project=path] [COMMAND]

הוא תומך באפשרויות הגלובליות הבאות:

אפשרות תיאור
-V, --version מדפיסה מידע על הגרסה ויוצאת.
-p, --project=path הנתיב המוחלט לפרויקט. ברירת המחדל היא הספרייה הנוכחית, שחייבת להכיל פרויקט.

כדי להציג את רשימת הפקודות הזמינות, מריצים את הפקודה lightbuild help. כדי לקבל עזרה לגבי פקודה ספציפית, מריצים את הפקודה lightbuild help [command].

lightbuild build

בונה יעד בפרויקט.

lightbuild build [target]
ארגומנט תיאור
target היעד ל-build. ברירת המחדל היא כל היעדים שנמצאים מתחת לספרייה הנוכחית.

לדוגמה, כדי ליצור את המודול app, מריצים את הפקודה:

lightbuild build app

כדי לבנות את כל היעדים בפרויקט, מריצים את הפקודה:

lightbuild build

lightbuild clean

הפקודה הזו מסירה את פלט ה-build והמטמון של הפרויקט.

lightbuild clean [target]
ארגומנט תיאור
target היעד לניקוי. ברירת המחדל היא כל היעדים שנמצאים מתחת לספרייה הנוכחית.

לדוגמה, כדי להסיר את פלט ה-build ואת המטמונים של כל הפרויקט, מריצים את הפקודה:

lightbuild clean

lightbuild help

מציגה את הפקודות הזמינות או את העזרה לפקודה ספציפית.

lightbuild help [COMMAND]
ארגומנט תיאור
COMMAND הפקודה שרוצים להציג את העזרה שלה. ברירת המחדל היא כל הפקודות.

כדי לראות את רשימת הפקודות שזמינות לפרויקט, מריצים את הפקודה:

lightbuild help

כדי להציג את העזרה לפקודה ספציפית, כמו query, מריצים את הפקודה הבאה:

lightbuild help query

lightbuild query

מציגה את יעדי ה-build, קובצי הפלט שנוצרו או קבוצות המקורות שתואמים לתבנית מסוימת במודולים של הפרויקט.

lightbuild query [target-pattern] [--format=format] [--output=type]
אפשרות או ארגומנט תיאור
target-pattern תבנית נתיב היעד, לדוגמה ... או app.
--format=format פורמט הפלט, לדוגמה json. ברירת המחדל היא טבלה.
--output=type הפורמט של הפלט: files למיקומים של הקבצים שהיעדים התואמים יוצרים, sourcesets לקבוצות המקורות שלהם או sourceset_types לסוגים של קבוצות המקורות שלהם.

כדי להציג את כל היעדים בפרויקט, מריצים את הפקודה:

lightbuild query ...

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

lightbuild query app --output=files

lightbuild resolve

פותר את יחסי התלות החיצוניים של הפרויקט ויוצר את קובצי הנעילה של יחסי התלות אופליין (resolved.deps) בשביל המודולים שלו.

lightbuild resolve [--cache=path] [--locked-dependencies] [target]
אפשרות או ארגומנט תיאור
target המודול שרוצים לפתור את יחסי התלות שלו, לדוגמה app. ברירת המחדל היא כל היעדים שנמצאים מתחת לספרייה הנוכחית.
--locked-dependencies הפעולה מסתיימת עם שגיאה אם קובץ הנעילה של התלות המקומית (resolved.deps) לא מסונכרן.
--cache=path הספרייה שבה יישמר המטמון של יחסי התלות.

לדוגמה, כדי ליצור את קובצי ה-resolved.deps לכל המודולים בפרויקט, מריצים את הפקודה:

lightbuild resolve

מידע נוסף על קובצי resolved.deps זמין במאמר יחסי תלות שנקבעו.

lightbuild test

מריצה את הבדיקות בפרויקט: בדיקות מקומיות, שפועלות במחשב הפיתוח, ובדיקות אינסטרומנטציה, שפועלות במכשיר מחובר או באמולטור פועל. כדי לבדוק מודול אחד, מציינים את היעד שלו, למשל app-core. כדי להריץ רק סוג אחד של בדיקה, מוסיפים ליעד את :hostTest לבדיקות מקומיות או את :deviceTest לבדיקות אינסטרומנטציה.

lightbuild test [target] [--locked-dependencies]
אפשרות או ארגומנט תיאור
target היעד לבדיקה. כברירת מחדל, כל הבדיקות בפרויקט.
--locked-dependencies ה-build נכשל אם קובץ הנעילה של התלות המקומית (resolved.deps) לא מסונכרן.

לדוגמה, כדי להריץ את כל הבדיקות בפרויקט, מריצים את הפקודה:

lightbuild test

כדי להריץ את הבדיקות המקומיות במודול app-core, מריצים את הפקודה:

lightbuild test app-core:hostTest

כדי להריץ את בדיקות האינסטרומנטציה במודול app-core במכשיר או באמולטור, מריצים את הפקודה:

lightbuild test app-core:deviceTest