tdd - אונליין בענן

תָכְנִית:

שֵׁם

todo - תוכנית תזכורת/משימה המיועדת למפתחים

תַקצִיר

TODO []
ללא אפשרויות, מציג את הפריטים בספרייה הנוכחית.

tda [-עמ' ] [-ג ] []
הוסף פריט חדש, אופציונלי שתלי אותו כילד של הפריט הנתון.

tde
ערוך את הפריט הנתון.

tdr
הסר את הפריטים הנתונים.

tdd
סמן את הפריטים שצוינו כמבוצעים.

TODO --קישור [-ג ]
קשר את מסד הנתונים של devtodo שצוין למסד הנתונים הנוכחי, אופציונלי שתלה אותו בתור
ילד מהמדד שצוין.

תיאור

TODO היא תוכנית המיועדת במיוחד למתכנתים (אך ניתנת לשימוש על ידי כל אחד ב-
מסוף) כדי לסייע בפיתוח יומיומי.

הוא מחזיק רשימה של פריטים שטרם הושלמו. זה מאפשר למתכנת
עקוב אחר באגים או פריטים מצטיינים שיש להשלים עם מעט מאוד מאמץ.

ניתן לתעדף פריטים וניתן גם להציג אותם בהיררכיה, כך שפריט אחד עשוי
תלוי באחר.

עם שימוש בכמה סקריפטים מעטפת קטנים (סקריפטים.* בספריית ה-doc של המקור
הפצה), todo יכול גם להציג את הפריטים המצטיינים בספרייה תוך כדי שינוי
לתוך זה. אז, למשל, אם אתה מתקליט לתוך ספריית המקור עבור Todo עצמו, אתה צריך
ראה רשימה של פריטים מצטיינים...אלא אם כן כל הבאגים תוקנו ;).

אפשרויות

לאפשרויות יכולות להיות צורה ארוכה וקצרה.

ניתן לשלב אפשרויות קצרות לארגומנט אחד על ידי שימוש במקף ואחריו מחרוזת של
אפשרויות קצרות. ניתן לצרף פרמטרים של אפשרויות קצרות למחרוזת זו.

-ב, --מִלוּלִי
הצג בצורה מילולית

-א, --לְהוֹסִיף []
הוסף הערה (תבקש הערה אם לא סופקה).

-ג, --שֶׁתֶל
בשיתוף עם --לְהוֹסִיף or --קישור, השתל את הפריט החדש לפריט שצוין.

-ל, --קישור
קשר את קובץ המשימות שצוין לגוף הקובץ הזה. אם יש למסד הנתונים המקושר
ערכת כותרות, זה ישמש כגוף הפריט המקשר, אחרת
ישמש שם הספרייה של מסד הנתונים המקושר. השתמש ב--remove (או tdr) כדי להסיר
מסדי נתונים מקושרים - זה כן לֹא להסיר את מסד הנתונים עצמו, רק את הקישור.

-ר,--הורה [, ]
שנה את האב של אינדקס הפריט הראשון לאינדקס הפריט השני. אם אין שניה
index נתון שהפריט יוחזר לשורש העץ.

-פ, --עדיפות
בשילוב עם --add או --edit, הגדר את העדיפות (ברירת מחדל | גבוהה מאוד | גבוהה |
בינוני | נמוך | מאוד נמוך)

, --לַעֲרוֹך
ערוך את ההערה שמתווספת לפי המספר הנתון.

--לְהַסִיר
הסר את ההערה המופיעה באינדקס במספרים הנתונים, כולל ילדים.

-ד, --בוצע
סמן את ההערות שצוינו (וילדיהם) כבוצעו.

-ד, --לא מוכן
סמן את ההערות שצוינו (וכל הילדים) כלא בוצעו.

--גלובל-בסיס נתונים
ציין את מסד הנתונים שבו יש להשתמש אם אחד מהם -G or --גלוֹבָּלִי האפשרויות מצוינות.

-G, --גלוֹבָּלִי
לאלץ לעשות להשתמש במסד הנתונים שצוין עם --גלובל-בסיס נתונים. אם זה ממוקם
בך ~/.todorc זה יאלץ לעשות שימוש במסד הנתונים הזה ללא הכללה של כולם
אחרים.

--מאגר מידע
שנה את מסד הנתונים מכל ברירת המחדל (בדרך כלל '.todo') לקובץ
נָקוּב.

-T, --לעשות
צור קובץ טקסט פלט TODO טיפוסי מ-Todo DB.

-א, --את כל
קיצור דרך למסנן '+בוצע,+ילדים' כדי להציג את כל ההערות.

-ו, --לְסַנֵן
הצג רק את ההערות שעוברות את המסנן. אנא עיין בסעיף מסננים ל
עוד מידע.

--צֶבַע
לעקוף את צבעי ברירת המחדל של פריטי מטלות. אנא עיין בסעיף צבע במשך יותר
מידע.

--צבע-כוח
כפה שימוש בצבע גם כאשר לא מוציאים ל-TTY. זה שימושי בעת צנרת
ל פחות(1) -ר.

--מונו הסר את כל רצפי הבריחה של ANSI מהפלט - שימושי ללקויי צבע
מסופים.

- עזרה הצג עזרה זו.

--גִרְסָה
גרסת תצוגה של ToDo.

--כותרת []
הגדר את הכותרת של הערות המטלות של ספרייה זו.

--פורמט תאריך
עיצוב תצוגת ערכי הזמן. הפורמט הוא זה שבו משתמשים זמן אחסון(3). ה
פורמט ברירת המחדל הוא '%c'. אפשרות זו מצוינת בצורה הטובה ביותר ב- ~/.todorc.

--פוּרמָט =
ציין את העיצוב של הפלט. אנא עיין בסעיף עיצוב לפרטים נוספים
מידע.

--השתמש בפורמט =
השתמש במחרוזת הפורמט המזוהה על ידי (מוגדר עם --format) בתור ה
מחרוזת פורמט לשימוש בעת עיצוב בפורמט המובנה .

--סוג
מיין את מסד הנתונים עם הביטוי שצוין. עיין בסעיף מִיוּן ל
מידע מפורט יותר.

--פרנואיד
היו פרנואידים לגבי הגדרות מסוימות, כולל הרשאות.

--מטעני מסד נתונים <מטען רשימה>
נסה את הפורמטים של מסד הנתונים בסדר הנתון. פורמטים חוקיים הם xml ו בינרי. לְמָשָׁל.
todo --מאסי מסד נתונים בינארי,xml. פורמט ברירת המחדל הוא XML.

--גיבוי []
גבה את מסד הנתונים עד פעמים, רגע לפני שנכתב אליו. אם לא
שצוין, יתבצע גיבוי אחד. שמות הקבצים המשמשים לאחסון הגיבויים הם
שם מסד הנתונים המוגדר כברירת מחדל עם הגרסה שלהם מצורפת כך: .todo.1, .todo.2 וכו'.
כדי להשתמש בפועל באחד מהגיבויים הללו, אתה יכול להעביר אותו ל-.todo או להשתמש
--database .todo. לציין במפורש את השימוש בו.

-ס, --סיכום
החלף מצב "סיכום", שבו פריטים ארוכים נחתכים לשורה אחת.

-ג, --תגובה
ערוך או הצג הערות בהתאמה.

--פסק זמן []
If מוגדר, הזמן הקצוב בין תצוגות מסד הנתונים מוגדר למספר זה
של שניות. אם לא מוגדר, ההתנהגות היא להציג את מסד הנתונים
רק אם הוא לא הוצג במשך מספר השניות שצוין ב--timeout
עם מה היא נָתוּן. לְמָשָׁל. TODO --פסק זמן 10 --פסק זמן יציג רק את
מסד נתונים לכל היותר פעם ב-10 שניות. לשים א פסק זמן 10 בך ~/.todorc הוא
אפשרות טובה, ואז ה--timeout ב- doc/scripts.* פירושו שבסיס הנתונים
לא יוצג בכל פעם שתקליט לתוך ספרייה.

--לְטַהֵר []
נקה את כל הפריטים שהושלמו ישנים יותר מ . אם מושמט, הכל
רשומות שהושלמו נמחקות.

סדרי עדיפויות

ניתן לציין סדרי עדיפויות באופן סמלי באמצעות המילים ברירת מחדל, גבוה מאוד, גָבוֹהַ, בינוני,
נמוך ו מאוד נמוך.

השמיים ברירת מחדל לעדיפות יש משמעות מיוחדת בכך שהיא תשתמש בעדיפות ברירת המחדל עבור כל
פעולה. המשמעות היא שבעת עריכת פריט קיים, העדיפות שלו נשמרת; מתי
יצירת פריט חדש, העדיפות תוגדר ל בינוני; כאשר משתילים פריט חדש, זה
העדיפות תהיה זו של ההורה שלה. DevTodo לא יבקש עדיפות אם כן
שצוין, מה שהופך אותו לתכונה שימושית עבור ה-todorc שלך. כמו בכל האפשרויות, העדיפות
ניתן לעקוף בשורת הפקודה.

מסננים

מסננים מורכבים מרשימה של ביטויים המשמשים להגדרת ההערות שהן
מוצג.

הפורמט הכללי של ביטוי מסנן הוא:

([-|=|+](כל|ילדים|בוצע| | )) | (/ ביטוי>)

בדרך כלל, אם יש קידומת של ביטוי מסנן עם '-' לֹא להציג פריטים ש
התאם את הביטוי, אם הקידומת '+' זה יציג פריטים התואמים לזה
ביטוי בנוסף לאחרים, או אם תחילו '=' (או ללא קידומת כלל) הוא יעשה זאת
תצוגה רק אותם פריטים התואמים את הביטוי. שים לב שזה יחפש רק פריטים
לא נכלל על ידי מסננים אחרים, אז כדי לחפש במסד הנתונים כולו תצטרך לעשות
משהו כמו: TODO --לְסַנֵן הכל,/מחרוזת-חיפוש מסויימת.

הצורה השנייה של ביטוי מסנן משמשת לחיפוש טקסט במסד נתונים. <חיפוש
ביטוי> הוא ביטוי רגולרי המותאם לגוף הטקסט של כל פריט.

אטומי סינון מסוננים לפי סדר לפי מצב ביצוע, עדיפות ואז חיפוש. אז פריטים ראשונים
שאינם תואמים למסנן "בוצע" לא ייכללו, ולאחר מכן אלה שאינם תואמים את
מסנן עדיפות וכן הלאה.

הביטויים בפירוט:

את כל מאלץ את כל הפריטים להיות מוצגים. לקידומות השונות אין השפעה על כך
ביטוי.

ילדים
כווץ או הרחב פריטי צאצא. אם הקידומת '-' קיימת ילדים
התמוטט, אחרת ילדים מוצגים.

עשה מסנן אם פריט הושלם או לא.


מדדי הערות מצוינים כמספרים. ניתן לתת טווחים אלא '1.2.10-20'.


סדרי העדיפויות מצוינים כמתואר ב סדרי עדיפויות סָעִיף. קידומת של '-'
יציג את כל הפריטים עם עדיפות נמוכה או שווה לעדיפות הנתונה.
עם קידומת '+', כל הפריטים בעלי עדיפויות גדולות או שווה לנתון
מוצגות עדיפות. אם '=' או לא ניתנת קידומת, רק פריטים עם המפורט
מוצגות עדיפות.

דוגמאות:

todo --פילטר בוצע,-ילדים,+נמוך

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

todo /[Tt]he

הצג רק את הפריטים עם המילה 'the', כאשר האות הראשונה יכולה להיות נמוכה יותר
או אותיות גדולות. ייתכן שיהיה צורך לצטט את ביטוי החיפוש כדי לוודא שהמעטפת כן
לא לפרש אותם.

עיצוב

ניתן לשנות את הפלט של todo כך שיתאים יותר לטעמך על ידי הגדרה משלך
עיצוב מחרוזות. מחרוזות אלו דומות לאלו המשמשות ב הדפס(3) ו זמן אחסון(3).

הדוגמאות הבאות, שניתן למקם בהן ~/.todorc, יחקה את ברירת המחדל
התנהגות:

# תצוגה בפורמט ברירת מחדל
format display=%i%[info]%f%2n.%[priority]%T

# תצוגה בפורמט ברירת מחדל
format generated=%2i-%T%2i (נוסף %d, עדיפות %p)\n\n

ישנן ארבע אפשרויות פורמט נפרדות: תצוגה, נוצר, תצוגה מילולית ו מִלוּלִי-
נוצר. שני האחרונים משמשים לעיצוב הטקסט המתאים כאשר --verbose הוא
צוין כטיעון לעשות.

בנוסף, משתמשים יכולים ליצור מחרוזות פורמט משלהם על ידי העברת מחרוזת אחרת
מזהה ל פוּרמָט. לאחר מכן ניתן להפעיל זאת באמצעות --השתמש בפורמט. לְמָשָׁל.

format full-report=%i%[info]%f%2n.%[priority]%+1T%+1i%[info]נוסף: %[normal]%c
%[info]הושלם: %[normal]%d\n%+1i%[info]משך: %[רגיל]%D %[info]עדיפות:
%[רגיל]%p\n\n
# תעקוף את פורמט התצוגה כדי להשתמש ב"דוח מלא".
use-format display = דוח מלא

הדגלים השונים הזמינים הם:

% > השמיים > הדגל קובע את מספר הרווחים לשימוש עבור כל הזחה עתידית.

%[+|-][ ]אני
כניסה לעומק הפריט הנוכחי. מציין את העומק שאליו יש להיכנס. אם is
מושמט, נעשה שימוש ברמה הנוכחית. ניתן להשתמש בערכים יחסיים. לְמָשָׁל. '%+1T' יעשה זאת
הזחה לרמה אחת גבוהה יותר מרמת ההזחה הנוכחית.

%[+|-][ ]ט
הצג את הטקסט של הפריט, עטוף ב-80 תווים ומוכנס ל-
רמה מוגדרת. סמנטיקה של הם כמו עם %i. שימו לב לטקסט העטוף
מוסיף אוטומטית '0 בסוף הטקסט, ואילו %t לא יהיה.

%t טקסט לא עטוף, לא מעוצב של הפריט.

%s טקסט סיכום (כלומר שורה אחת בלבד, שווה ערך ל --סיכום).

%p רמת העדיפות של הפריט הנוכחי.

%c תאריך יצירת הפריטים הנוכחי, מעוצב לפי --date-format.

%d התאריך שבו הפריט סומן כבוצע, מעוצב לפי --date-format.

%D משך הזמן של הפריט, מעוצב לפי --date-format.

%[ ]נ
מספר האינדקס של הפריט הנוכחי. הערך המספרי האופציונלי מציין את
מספר התווים שהמספר צריך לתפוס. המספר מרופד ברווחים
כדי למלא את מספר התווים הזה.

%f דגל המדינה של הפריט הנוכחי. הערכים המוצגים עבור דגל זה הם '+'
פירושו ילדים, '-' פירושו נעשה', '*' פירושו נעשה עם ילדים.

%F דגל המדינה הקריא לאדם של הפריט הנוכחי. הערכים המוצגים עבור זה
הדגל הם 'ילדים', 'בוצע' פירושו בוצע', 'בוצע, ילדים' ו'פתוח'.

%[ ]
ניתן לציין צבעים עם דגל זה. הערכים החוקיים עבור הם:
מאוד נמוך, נמוך, בינוני, גָבוֹהַ, גבוה מאוד, כותרת, מידע, ו עדיפות. אלה הם הוגנים
מובן מאליו, למעט עדיפות שינויים בצבע העדיפות הנוכחי של הפריטים. לְמָשָׁל.
%[עדיפות]

שים לב שבזמן ההזחה, תעשה זאת בדרך כלל רוצה להשתמש בערך הקידומת '+1'
עם %T. כְּלוֹמַר. %+1T. זה מאלץ את הטקסט להכנס לרמה אחת עמוק יותר מהזרם
רמה, מה שגורם לו להתרחק מכל עיצוב אחר שאולי השתמשת בו.

מִיוּן

ניתן למיין את הצגת הפריטים במסד הנתונים במגוון מקשים. בהינתן סדרה של
keys todo ממיין על כל מפתח עוקב, ממשיך למקש הבא רק אם המפתח הקודם
ההשוואה הייתה שווה. לדוגמה:

todo --מיין -בוצע,טקסט

זה ימיין ראשית לפי אם פריט הושלם ושנית לפי הטקסט שלו. זֶה
למעשה מקבץ פריטים לשני בלוקים - אלה שלמים ואלה שלא.

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

אם נתקלים במספר פרמטרים ---sort, נעשה שימוש באחרון. זה אומר שא
'מיין' כניסה ~/.todorc יעקוף על ידי כל אחד בשורת הפקודה.

מדדים

מדדים משמשים כאפשרויות למגוון ארגומנטים של שורת הפקודה. מדדי הערה מרובים
מופרדים בפסיקים (רווחים הם לֹא מוּתָר). ילדים מקבלים טווח באמצעות '.'.

לדוגמה, בהינתן ההערות הבאות:

1. עשה דפי אדם
1. הפוך אותם ליפים יותר.
2. צור תיעוד HTML גם כן.

סעיף המשנה השני יוצג כך: 1.2

ניתן להשתמש בתו הכללי '*' כדי לייצג את כל הילדים של צומת. לְמָשָׁל. 1.*

ניתן לציין טווחי הערות באמצעות ' - '. לדוגמה, כדי לסמן הערות 10.1.2,
10.1.3 ו-10.3.4 כפי שנעשה, אתה יכול לעשות: todo --done 10.1.2-4

צבע

ניתן לצבוע פריטים שונים. פריטים שיכולים להיות גבוה מאוד, גָבוֹהַ, בינוני, נמוך, מאוד נמוך,
כותרת ו מידע. מידע משמש להצגת מספרי פריטים ומידע כללי.

ניתן להגדיר פריטים אלה לאחד משמונה צבעים. הצבעים האלה הם שחור, אָדוֹם, ירוק,
צהוב, כָּחוֹל, מגנטה, ציאן, לבן ו ברירת מחדל. הצבע ברירת מחדל משמש לציון
ברירת המחדל של צבע מסוף הקדמי.

הצבעים מוגדרים כך:

=[+]

אם האופציונלי + בביטוי זה נעשה שימוש זה יגרום לפריט להיות מודגש.

לדוגמה, שורה ב- שלך ~/.todorc עשוי להיראות כמו:

צבע בינוני=+לבן

מה שיגרום בינוני טֶקסט סיכה לבן.

TODORC

todo יכול לטעון אפשרויות ממספר קבצי משאבים. הסדר שבו מנותחים אלה
הוא כדלקמן:

1. הקובץ שצוין במשתנה הסביבה TODORC או, אם זה לא קיים,
/etc/todorc.
2. ~/.todorc

האפשרויות מצטברות בכך שאלו שנטענו מ-$TODORC יעקפו או יתווספו על ידי
אלה שנמצאים ב ~/.todorc.

אפשרויות אלו מצוינות כזוגות מפתח/ערך, אחד בכל שורה המפתח הוא השם הארוך של a
ארגומנט שורת הפקודה והערך הוא הפרמטר לארגומנט זה, אם קיים. בנוסף,
משתני סביבה מורחבים.

לדוגמה, ארגומנט שורת הפקודה --filter מקבל פרמטר שהוא מסנן
ביטוי. ניתן להוסיף מסנן ברירת מחדל ל- ~/.todorc קובץ כך:

# אל תציג פריטי צאצא כברירת מחדל
מסנן -ילדים

ההבדל היחיד בין האפשרויות המצוינות בקובץ rc לאלו בשורת הפקודה
הוא שהאפשרויות בקובץ rc אינן קידומת של --.

בנוסף, קיימות שתי פקודות זמינות בקובץ RC שאינן זמינות ב-
שורת הפקודה. הם:

הפקודה הראשונה, on, משמש להוספת פקודות ספציפיות באופן מותנה. הפורמט של זה
הפקודה היא: on [ ]. אירועים תקפים הם להוסיף, להסיר, נוף, עריכה,
ליצור, עשה, לא מוכן, כותרת, הורה מחדש, לִטעוֹן, להציל, קישור, לִיצוֹר ו לטהר. מרובות
ניתן להעביר פקודות on על ידי סגירתן בסוגרים (נדרש רווח לבן בין
אסימונים). דוגמה מלאה למטה.

הפקודה השנייה היא Exec <קליפה פקודה>. פקודה זו תפעיל את הארגומנט שהוא
נתון בקליפה. משתנה הסביבה $TODODB מכיל את שם הקובץ של הנוכחי
מאגר מידע. לְמָשָׁל. Exec chmod 600 $TODODB

יש קובץ rc לדוגמה בספריית המשנה doc של הפצת המקור.

דוגמאות

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

TODO

כדי להסיר הערות 1, 2 ו-4:

todo --הסר 1,2,4

כדי להציג את כל הפריטים:

לעשות הכל

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

todo -ילדים

(למרות ש -יְלָדִים אינו טיעון תקף, זה עובד כי todo מפרש כל טיעון
ארגומנטים של שורת הפקודה שהוא לא מזהה כחלק מביטוי מסנן)

דוגמה מורכבת יותר. זה מוסיף פריט חדש, עם הטקסט של הפריט שצוין ב-
שורת הפקודה, עם עדיפות של גָבוֹהַ בתור ילד של הילד השלישי של הפריט השני (אם
זה הגיוני):

todo -a "תקן את דף האיש" -p high -g 2.3

זוהי דוגמה לשימוש בתכונת TODO של todo. זה גורם ל-todo ליצור חדש
קובץ TODO מהמידע המאוחסן במסד הנתונים. הדוגמה הספציפית הזו מפיקה את הכל
פריטים לקובץ TODO, אפילו אלה שסומנו כבוצעו.

todo --פילטר הכל --TODO

דוגמה זו מראה שימוש יפה בטריגרים של האירוע. כאשר נוצר מסד נתונים חדש
יאלץ את ההרשאות שלו ל-0600.

ביצירה {
מִלוּלִי
exec chmod 600 .todo
}

השתמש ב-tdd באינטרנט באמצעות שירותי onworks.net