tdd - Trực tuyến trên Đám mây

CHƯƠNG TRÌNH:

TÊN

todo - một chương trình nhắc nhở / nhiệm vụ nhằm vào các nhà phát triển

SYNOPSIS

tất cả []
Không có tùy chọn, hiển thị các mục trong thư mục hiện tại.

vân vân [-P ] [-NS ] []
Thêm một mục mới, tùy chọn ghép nó như một con của mục đã cho.

tde
Chỉnh sửa mục đã cho.

tdr
Loại bỏ các mục đã cho.

tdd
Đánh dấu các mục được chỉ định là đã hoàn thành.

tất cả - liên kết [-NS ]
Liên kết cơ sở dữ liệu devtodo đã chỉ định với cơ sở dữ liệu hiện tại, tùy chọn ghép nó với
một con của chỉ mục được chỉ định.

MÔ TẢ

tất cả là một chương trình nhắm mục tiêu đặc biệt đến các lập trình viên (nhưng có thể được sử dụng bởi bất kỳ ai tại
thiết bị đầu cuối) để hỗ trợ cho sự phát triển hàng ngày.

Nó duy trì một danh sách các hạng mục vẫn chưa được hoàn thành. Điều này cho phép lập trình viên
theo dõi các lỗi còn tồn tại hoặc các hạng mục cần được hoàn thành với rất ít nỗ lực.

Các mục có thể được ưu tiên và cũng có thể được hiển thị theo thứ bậc, để một mục có thể
phụ thuộc vào cái khác.

Với việc sử dụng một số tập lệnh shell nhỏ (script. * Trong thư mục doc của nguồn
phân phối), todo cũng có thể hiển thị các mục còn tồn đọng trong thư mục khi bạn thay đổi
vào nó. Vì vậy, ví dụ: nếu bạn cd vào thư mục nguồn để tự làm việc, bạn nên
xem danh sách các mục còn tồn đọng ... trừ khi tất cả các lỗi đã được sửa;).

LỰA CHỌN

Tùy chọn có thể có cả dạng dài và dạng ngắn.

Các tùy chọn ngắn có thể được kết hợp thành một đối số bằng cách sử dụng dấu gạch nối theo sau bởi một chuỗi
các tùy chọn ngắn. Các tham số của các tùy chọn ngắn cũng có thể được thêm vào chuỗi này.

-v, --dài dòng
Hiển thị chi tiết

-một, --cộng []
Thêm ghi chú (sẽ nhắc ghi chú nếu chưa được cung cấp).

-NS, --ghép
Kết hợp với --cộng or - liên kết, ghép mục mới với mục đã chỉ định.

-l, - liên kết
Liên kết tệp việc cần làm được chỉ định vào phần nội dung của tệp này. Nếu cơ sở dữ liệu được liên kết có
một bộ tiêu đề, bộ tiêu đề này sẽ được sử dụng làm phần nội dung của mục liên kết, nếu không thì
tên thư mục của cơ sở dữ liệu được liên kết sẽ được sử dụng. Sử dụng --remove (hoặc tdr) để xóa
cơ sở dữ liệu được liên kết - điều này thực hiện không loại bỏ chính cơ sở dữ liệu, chỉ liên kết.

-R, - đại diện [, ]
Thay đổi cấp độ gốc của chỉ mục mục đầu tiên thành chỉ mục mục thứ hai. Nếu không có thứ hai
chỉ mục được đưa ra, mục được gắn lại với gốc của cây.

-P, --sự ưu tiên
Cùng với --add hoặc --edit, hãy đặt mức độ ưu tiên (mặc định | rất cao | cao |
vừa | thấp | rất thấp)

-e, --chỉnh sửa
Chỉnh sửa ghi chú được lập chỉ mục theo số nhất định.

--tẩy
Xóa ghi chú được lập chỉ mục bởi các số đã cho, bao gồm cả bất kỳ con nào.

-NS, --xong
Đánh dấu các ghi chú được chỉ định (và con của chúng) là xong.

-NS, --không được thực hiện
Đánh dấu các ghi chú được chỉ định (và tất cả các ghi chú con) là chưa xong.

- cơ sở dữ liệu toàn cầu
Chỉ định cơ sở dữ liệu để sử dụng nếu -G or --toàn cầu các tùy chọn được chỉ định.

-NS, --toàn cầu
Buộc thực hiện để sử dụng cơ sở dữ liệu được chỉ định với - cơ sở dữ liệu toàn cầu. Nếu cái này được đặt
trong ~ / .todorc nó sẽ buộc phải sử dụng cơ sở dữ liệu đó để loại trừ tất cả
Khác.

- cơ sở dữ liệu
Thay đổi cơ sở dữ liệu từ bất kỳ giá trị mặc định nào (thường là '.todo') thành tệp
được chỉ định.

-NS, --LÀM
Tạo tệp văn bản đầu ra TODO điển hình từ Todo DB.

-MỘT, --tất cả các
Phím tắt cho bộ lọc '+ xong, + con' để hiển thị tất cả các ghi chú.

-NS, --lọc
Chỉ hiển thị những ghi chú vượt qua bộ lọc. Vui lòng tham khảo phần LỌC cho
thêm thông tin.

--màu sắc
Ghi đè màu mặc định của các mục việc cần làm. Vui lòng tham khảo phần Màu sắc để biết thêm
thông tin.

- lực-màu
Buộc sử dụng màu ngay cả khi không xuất ra TTY. Điều này rất hữu ích khi đường ống
đến ít(1) -NS.

--bệnh tăng bạch cầu đơn nhân Loại bỏ tất cả các chuỗi thoát ANSI khỏi đầu ra - hữu ích cho màu sắc bị suy giảm
thiết bị đầu cuối.

--Cứu giúp Hiển thị trợ giúp này.

--phiên bản
Phiên bản hiển thị của ToDo.

--chức vụ []
Đặt tiêu đề của ghi chú việc làm của thư mục này.

--Định dạng ngày tháng
Định dạng hiển thị các giá trị thời gian. Định dạng được sử dụng bởi thời gian căng thẳng(3). Các
định dạng mặc định là '% c'. Tùy chọn này được chỉ định tốt nhất trong ~ / .todorc.

--định dạng =
Chỉ định định dạng của đầu ra. Vui lòng tham khảo phần ĐỊNH DẠNG để biết thêm
thông tin.

- định dạng sử dụng =
Sử dụng chuỗi định dạng được xác định bởi (được định nghĩa với --format) là
chuỗi định dạng để sử dụng khi định dạng với định dạng nội trang .

--loại
Sắp xếp cơ sở dữ liệu với biểu thức được chỉ định. Tham khảo phần SẮP XẾP cho
thông tin chi tiết hơn.

--hoang tưởng
Hãy hoang tưởng về một số cài đặt, bao gồm cả quyền.

--trình tải cơ sở dữ liệu <bộ nạp danh sách>
Hãy thử các định dạng cơ sở dữ liệu theo thứ tự nhất định. Các định dạng hợp lệ là xml và nhị phân. ví dụ.
todo --database-loaders binary, xml. Định dạng mặc định là XML.

--sao lưu []
Sao lưu cơ sở dữ liệu lên đến lần, ngay trước khi nó được viết tới. Nếu như không phải là
đã chỉ định, một bản sao lưu sẽ được thực hiện. Các tên tệp được sử dụng để lưu trữ các bản sao lưu là
tên cơ sở dữ liệu mặc định với bản sửa đổi của chúng được thêm vào như sau: .todo.1, .todo.2, v.v.
Để thực sự sử dụng một trong những bản sao lưu này, bạn có thể mv nó sang .todo hoặc sử dụng
--database .todo. để chỉ định rõ ràng việc sử dụng nó.

-S, --tóm lược
Chuyển sang chế độ "tóm tắt", trong đó các mục dài được cắt bớt thành một dòng.

-NS, --bình luận
Chỉnh sửa hoặc hiển thị các nhận xét tương ứng.

--hết giờ []
If được chỉ định, thời gian chờ giữa các lần hiển thị cơ sở dữ liệu được đặt thành số này
trong số giây. Nếu không được chỉ định, hành vi là hiển thị cơ sở dữ liệu
có thể nếu nó không được hiển thị trong số giây được chỉ định bởi --timeout
với các được cho. ví dụ. tất cả --hết giờ 10 --hết giờ sẽ chỉ hiển thị
cơ sở dữ liệu nhiều nhất 10 giây một lần. Đưa một thời gian chờ 10 trong ~ / .todorc là một
tùy chọn tốt, sau đó - thời gian chờ trong doc / scripts. * nghĩa là cơ sở dữ liệu
sẽ không được hiển thị mỗi khi bạn cd vào một thư mục.

--gege []
Xóa tất cả các mục đã hoàn thành cũ hơn . Nếu bị bỏ qua, tất cả
hồ sơ hoàn thành được thanh lọc.

ƯU TIÊN

Các mức độ ưu tiên có thể được chỉ định một cách tượng trưng bằng cách sử dụng các từ mặc định, rất cao, cao, trung bình,
thấp và rất thấp.

mặc định ưu tiên có ý nghĩa đặc biệt ở chỗ nó sẽ sử dụng ưu tiên mặc định cho bất kỳ
hoạt động. Điều này có nghĩa là khi chỉnh sửa một mục hiện có, quyền ưu tiên của nó được giữ nguyên; khi nào
tạo một mục mới, mức độ ưu tiên sẽ được đặt thành trung bình; khi ghép một mặt hàng mới, nó
ưu tiên sẽ là của cha mẹ của nó. DevTodo sẽ không nhắc ưu tiên nếu đây là
được chỉ định, làm cho nó trở thành một tính năng hữu ích cho todorc của bạn. Như với tất cả các tùy chọn, mức độ ưu tiên
có thể được ghi đè trên dòng lệnh.

LỌC

Bộ lọc bao gồm danh sách các biểu thức được sử dụng để xác định các ghi chú
hiển thị.

Định dạng chung của biểu thức bộ lọc là:

([- | = | +] (hết | con | xong | | )) | (/ biểu thức>)

Nói chung, nếu một biểu thức bộ lọc có tiền tố là '-' thì nó sẽ không hiển thị các mặt hàng
khớp với biểu thức, nếu có tiền tố '+', nó sẽ hiển thị các mục khớp với biểu thức này
cùng với các biểu thức khác, hoặc nếu có tiền tố '=' (hoặc không có tiền tố nào cả) thì nó sẽ
trưng bày có thể những mục phù hợp với biểu thức. Lưu ý rằng điều này sẽ chỉ tìm kiếm các mục
không bị loại trừ bởi các bộ lọc khác, vì vậy để tìm kiếm toàn bộ cơ sở dữ liệu, bạn sẽ phải làm
cái gì đó như: tất cả --lọc tất cả, / some-search-string.

Dạng thứ hai của biểu thức bộ lọc được sử dụng để tìm kiếm văn bản trong cơ sở dữ liệu. <tìm kiếm
biểu thức> là một biểu thức chính quy được so khớp với nội dung văn bản của mỗi mục.

Các nguyên tử lọc được lọc theo thứ tự theo trạng thái đã hoàn thành, mức độ ưu tiên, sau đó tìm kiếm. Vì vậy, các mục đầu tiên
không phù hợp với bộ lọc "đã hoàn thành" sẽ bị loại trừ, sau đó những bộ lọc không phù hợp với
bộ lọc ưu tiên, v.v.

Các biểu thức chi tiết:

tất cả các Buộc tất cả các mục được hiển thị. Các tiền tố khác nhau không ảnh hưởng đến điều này
biểu hiện.

trẻ em
Thu gọn hoặc mở rộng các mục con. Nếu tiền tố '-' là hiện tại thì con là
bị sập, nếu không thì hiển thị trẻ em.

thực hiện Lọc xem một mục đã được hoàn thành hay chưa.


Các chỉ số ghi chú được chỉ định dưới dạng số. Phạm vi có thể được cung cấp cho ala '1.2.10-20'.


Các mức độ ưu tiên được chỉ định như được mô tả trong ƯU TIÊN phần. Tiền tố của '-'
sẽ hiển thị tất cả các mục có mức độ ưu tiên nhỏ hơn hoặc bằng mức độ ưu tiên đã cho.
Với tiền tố '+', tất cả các mục có mức độ ưu tiên lớn hơn hoặc bằng
ưu tiên được hiển thị. Nếu '=' hoặc không có tiền tố nào được đưa ra, chỉ các mục có giá trị được chỉ định
ưu tiên được hiển thị.

Ví dụ:

todo - lọc xong, -trẻ em, + thấp

Điều này sẽ chỉ hiển thị những mục đã hoàn thành và có mức độ ưu tiên thấp hoặc cao hơn. Trong
Ngoài ra, trẻ em sẽ bị suy sụp.

todo / [Tt] anh ấy

Chỉ hiển thị những mục có từ 'the' trong đó, chữ cái đầu tiên có thể viết thường
hoặc chữ hoa. Có thể cần phải trích dẫn biểu thức tìm kiếm để đảm bảo trình bao
không giải thích chúng.

ĐỊNH DẠNG

Đầu ra của việc cần làm có thể được thay đổi thành nhiều hơn theo ý thích của bạn bằng cách xác định của riêng bạn
định dạng chuỗi. Những chuỗi này tương tự như những chuỗi được sử dụng trong printf(3) thời gian căng thẳng(3).

Các ví dụ sau, có thể được đặt trong ~ / .todorc, sẽ bắt chước mặc định
hành vi:

# Hiển thị ở định dạng mặc định
format display =% i% [info]% f% 2n.% [priority]% T

# Hiển thị ở định dạng mặc định
định dạng được tạo =% 2i-% T% 2i (đã thêm% d, ưu tiên% p) \ n \ n

Có bốn tùy chọn định dạng riêng biệt: trưng bày, tạo ra, hiển thị chi tiết và tiết-
tạo ra. Hai phần sau được sử dụng để định dạng văn bản tương ứng của chúng khi --verbose là
được chỉ định làm đối số cho việc cần làm.

Ngoài ra, người dùng có thể tạo chuỗi định dạng của riêng họ bằng cách chuyển
định danh cho định dạng. Điều này sau đó có thể được kích hoạt bằng cách sử dụng - định dạng sử dụng. ví dụ.

định dạng báo cáo đầy đủ =% i% [thông tin]% f% 2n.% [ưu tiên]% + 1T% + 1i% [thông tin] Đã thêm:% [bình thường]% c
% [thông tin] Đã hoàn thành:% [bình thường]% d \ n% + 1i% [thông tin] Thời lượng:% [bình thường]% D% [thông tin] Mức độ ưu tiên:
% [bình thường]% p \ n \ n
# Ghi đè định dạng hiển thị để sử dụng "báo cáo đầy đủ".
use-format display = full-report

Các cờ khác nhau có sẵn là:

% > > cờ đặt số lượng khoảng trắng để sử dụng cho tất cả các lần thụt lề trong tương lai.

% [+ | -] [ ]tôi
Thụt lề đến độ sâu của mục hiện tại. chỉ định độ sâu để thụt lề. Nếu như is
bỏ qua, mức hiện tại được sử dụng. Giá trị tương đối có thể được sử dụng. ví dụ. '% + 1T' sẽ
thụt lề lên một cấp cao hơn mức thụt lề hiện tại.

% [+ | -] [ ]NS
Hiển thị văn bản của mục, được bao bọc ở 80 ký tự và được thụt lề vào
mức quy định. Ngữ nghĩa của như với %i. Lưu ý rằng văn bản được bao bọc
tự động thêm '0 vào cuối văn bản, ngược lại %t sẽ không.

%t Văn bản chưa được gói, chưa được định dạng của mục.

%s Văn bản tóm tắt (tức là chỉ một dòng, tương đương với --tóm lược).

%p Mức độ ưu tiên của mục hiện tại.

%c Ngày tạo các mục hiện tại, được định dạng theo --date-format.

%d Ngày mà mục được đánh dấu là xong, được định dạng theo định dạng --date.

%D Thời hạn của mục, được định dạng theo --date-format.

% [ ]n
Số chỉ mục của mục hiện tại. Giá trị số tùy chọn chỉ định
số ký tự mà số sẽ chiếm. Số được đệm bằng dấu cách
để điền vào số ký tự này.

%f Cờ trạng thái của mục hiện tại. Các giá trị được hiển thị cho cờ này là '+'
có nghĩa là trẻ em, '-' có nghĩa là xong ',' * 'có nghĩa là xong với trẻ em.

%F Cờ trạng thái có thể đọc được của con người của mục hiện tại. Các giá trị được hiển thị cho điều này
cờ là 'con', 'xong' có nghĩa là xong ',' xong, con 'và' mở '.

% [ ]
Màu sắc có thể được chỉ định với lá cờ này. Các giá trị hợp lệ cho là:
rất thấp, thấp, trung bình, cao, rất cao, tiêu đề, Thông tinvà ưu tiên. Đây là những công bằng
tự giải thích, ngoại trừ ưu tiên thay đổi đối với màu ưu tiên của các mục hiện tại. ví dụ.
%[sự ưu tiên]

Xin lưu ý rằng khi thụt lề, bạn sẽ thường muốn sử dụng giá trị tiền tố là '+1'
với T. I E. % + 1T. Điều này buộc văn bản phải thụt lề sâu hơn một cấp so với hiện tại
, làm cho nó không có bất kỳ định dạng nào khác mà bạn có thể đã sử dụng.

SẮP XẾP

Việc hiển thị các mục trong cơ sở dữ liệu có thể được sắp xếp trên nhiều khóa khác nhau. Đưa ra một loạt các
các phím cần làm sắp xếp trên mỗi phím kế tiếp, chỉ tiếp tục đến phím tiếp theo nếu phím trước đó
so sánh là bằng nhau. Ví dụ:

todo --sort -done, text

Điều này đầu tiên sẽ phân loại theo việc một mục đã được hoàn thành hay chưa và thứ hai là theo văn bản của chúng. Cái này
nhóm một cách hiệu quả các mục thành hai khối - những mục đã hoàn chỉnh và những mục chưa hoàn chỉnh.

Các chìa khóa có sẵn là tạo ra, hoàn thành, văn bản, ưu tiên, thời gian, không ai và
thực hiện. Mỗi khóa, ngoại trừ không ai có thể được bắt đầu bằng dấu - để đảo ngược thứ tự mặc định của nó và
nhiều khóa phải được phân tách bằng dấu,.

Nếu gặp nhiều tham số --sort thì tham số cuối cùng sẽ được sử dụng. Điều này có nghĩa là một
mục nhập 'sắp xếp' trong ~ / .todorc sẽ được ghi đè bởi bất kỳ trên dòng lệnh.

CHỈ SỐ

Các chỉ báo được sử dụng làm tùy chọn cho nhiều đối số dòng lệnh. Nhiều chỉ số ghi chú
được phân tách bằng dấu phẩy (dấu cách là không cho phép). Trẻ em được xác định phạm vi sử dụng dấu '.'.

Ví dụ, với các ghi chú sau:

1. Do man trang
1. Làm cho chúng đẹp hơn.
2. Tạo tài liệu HTML.

Mục con thứ hai sẽ được biểu diễn như sau: 1.2

Ký tự đại diện '*' có thể được sử dụng để đại diện cho tất cả các nút con của một nút. ví dụ. 1. *

Phạm vi ghi chú có thể được chỉ định bằng cách sử dụng ' - '. Ví dụ, để đánh dấu các ghi chú 10.1.2,
10.1.3 và 10.3.4 là xong, bạn có thể làm: todo --done 10.1.2-4

Màu sắc

Nhiều mặt hàng có thể được tô màu. Các mặt hàng có thể rất cao, cao, trung bình, thấp, rất thấp,
tiêu đề và Thông tin. Thông tin được sử dụng để hiển thị số mục và thông tin chung.

Các mục này có thể được đặt thành một trong tám màu. Những màu đó là đen, đỏ, màu xanh lá,
màu vàng, màu xanh da trời, màu đỏ tươi, cyan, trắng và mặc định. Màu sắc mặc định được sử dụng để chỉ định
màu đầu cuối nền trước mặc định.

Màu sắc được chỉ định như vậy:

=[+]

Nếu tùy chọn + trong biểu thức này được sử dụng nó sẽ làm cho mục trở nên đậm.

Ví dụ: một dòng trong ~ / .todorc có thể trông giống như:

màu trung bình = + trắng

Điều gì sẽ làm cho trung bình văn bản đậm trắng.

TODORC

todo có thể tải các tùy chọn từ một số tệp tài nguyên. Thứ tự mà chúng được phân tích cú pháp
là như sau:

1. Tệp được chỉ định trong biến môi trường TODORC hoặc, nếu điều đó không tồn tại,
/ etc / todorc.
2. ~ / .todorc

Các tùy chọn được tích lũy trong đó những tùy chọn được tải từ $ TODORC sẽ được ghi đè hoặc thêm vào bởi
những người trong ~ / .todorc.

Các tùy chọn này được chỉ định dưới dạng các cặp khóa / giá trị, một cặp trên mỗi dòng Khóa là tên dài của một
đối số dòng lệnh và giá trị là tham số của đối số đó, nếu có. Ngoài ra,
các biến môi trường được mở rộng.

Ví dụ: đối số dòng lệnh --filter chấp nhận một tham số là bộ lọc
biểu hiện. Một bộ lọc mặc định có thể được thêm vào ~ / .todorc tệp như vậy:

# Không hiển thị các mục con theo mặc định
bộ lọc-trẻ em

Sự khác biệt duy nhất giữa các tùy chọn được chỉ định trong tệp rc và các tùy chọn trên dòng lệnh
là các tùy chọn trong tệp rc không có tiền tố là -.

Ngoài ra, có hai lệnh có sẵn trong tệp RC không có sẵn trên
dòng lệnh. Họ đang:

Lệnh đầu tiên, on, được sử dụng để thêm các lệnh cụ thể có điều kiện. Định dạng của cái này
lệnh là: on [ ]. Các sự kiện hợp lệ là thêm vào, tẩy, lượt xem, chỉnh sửa,
tạo ra, thực hiện, không được thực hiện, tiêu đề, cha mẹ, tải, tiết kiệm, liên kết này, tạo và purge. Nhiều
các lệnh có thể được chuyển cho on bằng cách đặt chúng trong dấu ngoặc nhọn (bắt buộc phải có khoảng trắng giữa
mã thông báo). Ví dụ đầy đủ bên dưới.

Lệnh thứ hai là giám đốc điều hành <vỏ lệnh>. Lệnh này sẽ thực thi đối số mà nó là
được đưa ra trong một vỏ. Biến môi trường $ TODODB chứa tên tệp của hiện tại
cơ sở dữ liệu. ví dụ. giám đốc điều hành chmod 600 $ TODODB

Có một tệp rc mẫu trong thư mục con doc của bản phân phối nguồn.

VÍ DỤ

Để hiển thị bất kỳ mục nào còn tồn đọng trong thư mục hiện tại, chỉ cần nhập:

tất cả

Để xóa ghi chú 1, 2 và 4:

việc cần làm - bỏ 1,2,4

Để hiển thị TẤT CẢ các mục:

làm tất cả

Để chỉ hiển thị các mục cấp cao nhất và không hiển thị các mục con của chúng:

việc cần làm

(mặc dù -bọn trẻ không phải là một đối số hợp lệ, điều này hoạt động bởi vì todo diễn giải bất kỳ
đối số dòng lệnh nó không nhận ra là một phần của biểu thức bộ lọc)

Một ví dụ phức tạp hơn. Điều này thêm một mục mới, với văn bản của mục được chỉ định trên
dòng lệnh, với mức độ ưu tiên là cao là con của con thứ ba của mục thứ hai (nếu
điều đó có ý nghĩa gì):

todo -a "Sửa trang người đàn ông" -p cao -g 2.3

Đây là một ví dụ về cách sử dụng tính năng TODO của việc làm. Nó làm cho todo tạo ra một
TODO tệp từ thông tin được lưu trữ trong cơ sở dữ liệu. Ví dụ cụ thể này xuất ra tất cả
các mục vào tệp TODO, ngay cả những mục được đánh dấu là xong.

việc cần làm - lọc tất cả --TODO

Ví dụ này cho thấy cách sử dụng tốt các trình kích hoạt sự kiện. Khi một cơ sở dữ liệu mới được tạo, nó
sẽ buộc quyền của nó thành 0600.

khi tạo {
dài dòng
thực thi chmod 600 .todo
}

Sử dụng tdd trực tuyến bằng các dịch vụ onworks.net