iridakos - opensource articles

stup - ένα εργαλείο κονσόλας για καθημερινές σημειώσεις

Fri, 01 May 2020 12:00:00 +0300

Τα τελευταία χρόνια συμμετέχω σε καθημερινά Stand-up meetings και μου δημιουργήθηκε η ανάγκη να βρω έναν βολικό και αποτελεσματικό τρόπο να κρατάω σημειώσεις σχετικά με το τι έκανα κάθε μέρα.

Χρειαζόμουν:

να κρατώ κατηγοριοποιημένες σημειώσες για τα issues πάνω στα οποία εργαζόμουν, τις συναντήσεις στις οποίες συμμετείχα, πράγματα που εμπόδιζαν τη δουλειά μου κ.λπ.
να μπορώ εύκολα να ανακτήσω αυτές τις σημειώσεις βάσει της ημερομηνίας στην οποία καταχωρήθηκαν
να έχω μια γενική εικόνα για το τι έκανα (για παράδειγμα την τελευταία εβδομάδα)
όλα τα παραπάνω:
- μέσα από την κονσόλα
- χωρίς να χρειάζεται να διαμορφώσω και να συντηρώ ένα αρχείο με όλες τις σημειώσεις χειροκίνητα
- χωρίς να χρειάζεται να διαμορφώνω και να συντηρώ ένα αρχείο για κάθε μέρα με όλες τις σημειώσεις χειροκίνητα

stup

Υλοποίησα το stup (το όνομα προέρχεται από τον όρο stand-up), ένα πρόγραμμα ανοιχτού κώδικα, για να καλύψω τις ανάγκες αυτές.

Ο πηγαίος κώδικας είναι διαθέσιμος στο GitHub εδώ.

Παραδείγματα χρήσης

Παραθέτω κάποια παραδείγματα που παρουσιάζουν τις βασικότερες χρήσεις του stup.

Προσθήκη σημειώσεων

# Προσθήκη σημείωσης στην προεπιλεγμένη κατηγορία για την τρέχουσα ημερομηνία
stup add -n "Worked on issue #ABC123"

# Προσθήκη σημείωσης στην προεπιλεγμένη κατηγορία υπονοώντας την τρέχουσα ημερομηνία
stup add today -n "Worked on issue #ABC123"

# Προσθήκη σημείωσης στην κατηγορία "meetings"
stup add today -c "meetings" -n "2 hours with @phoebe for the project kick off"

# Προσθήκη σημείωσης στην κατηγορία "blocking" στις 10 Απριλίου, 2020
stup add @ 2020-04-10 -c "blocking" -n "connectivity issues"

Εμφάνιση σημειώσεων συγκεκριμένης ημέρας

# Εμφάνιση χθεσινών σημειώσεων (υπονοώντας την ημέρα)
$ stup

# Εμφάνιση χθεσινών σημειώσεων (με σαφή προσδιορισμό της ημέρας)
$ stup yesterday

# Εμφάνιση των σημερινών σημειώσεων
$ stup today

# Εμφάνιση σημειώσεων σε συγκεκριμένη ημερομηνία
$ stup show @ 2020-04-18

# Εμφανίση σημειώσεων για συγκεκριμένη κατηγορία σε συγκεκριμένη ημέρα
$ stup show @ 2020-04-18 -c "meetings"

Λίστα όλων των σημειώσεων για ένα χρονικό διάστημα

# Λίστα των σημειώσεων της τρέχουσας εβδομάδας
stup log week

# Λίστα των σημειώσεων της τρέχουσας εβδομάδας (υπονοώντας την ενέργεια log)
stup week

# Λίστα των σημειώσεων της προηγούμενης εβοδμάδας
stup log previous-week

# Λίστα των σημειώσεων της προηγούμενης εβοδμάδας (υπονοώντας την ενέργεια log)
stup previous-week

# Λίστα σημειώσεων μεταξύ δύο ημερομηνιών
stup log --from 2020-01-20 --to 2020-03-02

# Λίστα σημειώσεων μεταξύ δύο ημερομηνιών για συγκεκριμένη κατηγορία
stup log --from 2020-01-20 --to 2020-03-02 -c "meetings"

Πως λειτουργεί σε τεχνικό επίπεδο

Οι σημειώσεις είναι οργανωμένες σε κατηγορίες.

Όταν προστίθεται μια σημείωση, το stup αποθηκεύει ένα αρχείο markdown και το τοποθετεί μέσα στο φάκελο της κατηγορίας της σημείωσης δημιουργώντας υποφακέλους που αντιστοιχούν στην ημερομηνία της.

CATEGORIES_ROOT_DIRECTORY/CATEGORY/YEAR/MONTH/YYYY-MM-DD.md

# Για παράδειγμα, οι σημειώσεις της κατηγορίας "programming"
# για τις 18 Απριλίου 2020 αποθηκεύονται στον φάκελο:
CATEGORIES_ROOT_DIRECTORY/programming/2020/04/2020-04-18.md

Αυτό επιτρέπει τους χρήστες να ανακτήσουν όποιες σημειώσεις προστέθηκαν σε μια συγκεκριμένη ημερομηνία για μια συγκεκριμένη ή για όλες τις κατηγορίες σημειώσεων.

# Ανάκτηση σημειώσεων για όλες τις κατηγορίες
$ stup show @ 2020-04-18

# Ανάκτηση σημειώσεων για την κατηγορία "programming"
# της προηγούμενης εβδομάδας
$ stup log previous-week -c programming

# Ανάκτηση όλων των σημειώσεων για συγκεκριμένο χρονικό διάστημα
$ stup log --from 2020-04-01 --to 2020-04-15

Περισσότερες πληροφορίες

Μπορείτε να:

να επισκεφτείτε το αποθετήριο του προγράμματος στο Github εδώ.
να δείτε όλη την τεκμηρίωση και τις χρήσεις του stup (με παραδείγματα) εδώ.
να δείτε issues/features προς υλοποίηση εδώ.

Ευχαριστώ για την ανάγνωση!

Εύρεση παλίνδρομων ημερομηνιών στην Linux κονσόλα - επεξήγηση

Mon, 10 Feb 2020 09:00:00 +0200

Πρόσφατα είδα μια πολύ ωραία εντολή που βρίσκει τις παλίνδρομες ημερομηνίες μεταξύ του τώρα και x ημερών στο παρελθόν.

Η εντολή κοινοποιήθηκε στο Twitter από το λογαριασμό @climagic (ένας πολύ ωραίος λογαριασμός σχετικά με tweets που σχετίζονται με την γραμμή εντολών).

Σε αυτό το άρθρο θα σπάσω την εντολή σε τμήματα και θα εξηγήσω πως λειτουργεί το καθένα.

Τι είναι το παλίνδρομο - Καρκινική γραφή

Καρκινικές επιγραφές ή καρκίνοι ονομάζονται συμμετρικές φράσεις οι οποίες μπορούν να διαβαστούν είτε από την αρχή είτε από το τέλος. – Καρκινική γραφή - Wikipedia

Πριν λίγες μέρες, η ημερομηνία ήταν παλίνδρομη: 02/02/2020

Η εντολή

printf "now - %d days\n" {1..332044} |date -f- +%Y%_m%_d$'\n'%Y%m%d |tr -d ' ' > alldates.txt; rev alldates.txt >revdates.txt; paste alldates.txt revdates.txt |awk '$1==$2{print $1}'

και παρακάτω μια περισσότερο αναγνώσιμη εκδοχή της, χρησιμοποιώντας νέα γραμμή μετά από κάθε σωλήνωση.

printf "now - %d days\n" {1..332044} |
date -f- +%Y%_m%_d$'\n'%Y%m%d |
tr -d ' ' > alldates.txt; rev alldates.txt >revdates.txt; paste alldates.txt revdates.txt |
awk '$1==$2{print $1}'

Θα εξηγήσω κάθε τμήμα της εντολής χωριστά.

Σημειώστε ότι το αποτέλεσμα (output - έξοδος) του κάθε τμήματος αποτελεί είσοδο (input) για το επόμενο τμήμα (αυτό που ακολουθεί τη σωλήνωση |).

printf "now - %d days\n" {1..332044}

Το πρώτο τμήμα είναι αρκετά απλό αλλά έχει και ένα ενδιαφέρον κομμάτι, το μηχανισμό επέκτασης αγκυλών τον οποίο δε γνώριζα.

Ανοίξτε ένα τερματικό και πληκτρολογήστε τις ακόλουθες εντολές:

# Από το 1 έως το 10
$ echo {1..10}
1 2 3 4 5 6 7 8 9 10

# Από το a έως το z
$ echo {a..z}
a b c d e f g h i j k l m n o p q r s t u v w x y z

# Από το 10 έως το 20
$ echo Before-{10..20}-After
Before-10-After Before-11-After Before-12-After Before-13-After Before-14-After Before-15-After Before-16-After Before-17-After Before-18-After Before-19-After Before-20-After

Όπως μπορείτε να δείτε, ο μηχανισμός επέκτασης αγκυλών επιτρέπει την παραγωγή τιμών βασισμένων σε μια ακολουθία - sequence που του ορίζουμε.

Μάθετε περισσότερα για τον μηχανισμό επέκτασης αγκυλών εδώ.

Επεξήγηση εντολής

τυπώνουμε τη φράση “now - x days” τόσες φορές όσες το πλήθος των τιμών που προκύπτουν από την ακολουθία - sequence
η ακολουθία {1..332044} θα παράξει 332044 τιμές ξεκινώντας από το 1 αυξανόμενη κατά ένα κάθε φορά
προσθέτουμε μια νέα γραμμή στο τέλος του παραγόμενου λεκτικού

Αποτελέσματα - Output

now - 1 days
now - 2 days
now - 3 days
now - 4 days
now - 5 days
...
now - 332038 days
now - 332039 days
now - 332040 days
now - 332041 days
now - 332042 days
now - 332043 days
now - 332044 days

date -f- `+%Y%\_m%\_d$'\n'%Y%m%d`

Σε αυτό το τμήμα της εντολής χρησιμοποιούμε την εντολή date για να μετατρέψουμε σε ημερομηνία την κάθε γραμμή του αποτελέσματος της προηγούμενης εντολής (της εντολής πριν τη σωλήνωση) και να τυπώσουμε δύο γραμμές για κάθε ημερομηνία, μια που θα γεμίσει τις μονοψήφιες ημέρες και τους μονοψήφιους μήνες με ένα μηδενικό και μια που θα γεμίσει τις μονοψήφιες ημέρες και τους μονοψήφιους μήνες με ένα κενό (space).

Εξοικειωθείτε με την εντολή στη γραμμή εντολών:

# Δείξε την τρέχουσα ημερομηνία = now
$ date
Thu Feb  6 07:30:10 EET 2020

# Δείξε τη χθεσινή ημερομηνία
$ date --date="now - 1 days"
Wed Feb  5 07:31:22 EET 2020

# Δείξε τη χθεσινή ημερομηνία ως ηη/μμ/χχχχ (γέμισμα με μηδενικά)
$ date --date="now - 1 days" +%d/%m/%Y
05/02/2020

# Δείξε τη χθεσινή ημερομηνία ως ηη/μμ/χχχχ (γέμισμα με κενά)
$ date --date="now - 1 days" +%_d/%_m/%Y
 5/ 2/2020

# Δείξε τη χθεσινή ημερομηνία ως ηη/μμ/χχχχ (σωρίς γέμισμα)
$ date --date="now - 1 days" +%-d/%-m/%Y
5/2/2020

Επεξήγηση εντολής

χρησιμοποιούμε την επιλογή -f για να ορίσουμε ότι η είσοδος της εντολής date θα είναι οι γραμμές ενός αρχείου, ακολουθούμενη από μια παύλα (hyphen) - για να ορίσουμε ότι το αρχείο αυτό είναι η τυπική είσοδος - stdin
ορίζουμε τη μορφή των τυπωμένων τιμών (ό,τι ακολουθεί το σύμβολο +) ώστε να είναι η αριθμητική αναπαράσταση του έτους (%Y), του μήνα (γεμισμένου με κενά: %_m, γεμισμένου με μηδενικά: %m) και της ημέρας του μήνα (γεμισμένης με κενά: %_d, γεμισμένης με μηδενικά: %d)
η μορφή με τα κενά είναι %Y%\_m%\_d και η μορφή με τα μηδενικά %Y%m%d
συνδυάζουμε αυτές τις δύο μορφές για κάθε μία ημερομηνία ενώνοντάς τες με μια νέα γραμμή $'\n' οπότε, για κάθε ημερομηνία παράγουμε δύο γραμμές, μια με μηδενικά και μια με κενά για τους μονοψήφιους μήνες και τις μονοψήφιες ημέρες του μήνα

Σημείωση: αντί να γεμίσουμε με κενά (χρησιμοποιώντας την κάτω παύλα _ στη μορφή), θα μπορούσαμε να χρησιμοποιήσουμε την παύλα - ώστε να μη γεμίζουν με τίποτα οι μονοψήφιες τιμές. Με αυτόν τον τρόπο δε θα χρειαζόταν να αφαιρέσουμε τα κενά όπως περιγράφεται στο επόμενο τμήμα.

Αποτέλεσμα - Output

tr -d ' ' > alldates.txt; rev alldates.txt >revdates.txt; paste alldates.txt revdates.txt

Σε αυτό το τμήμα αφαιρούμε τα κενά που παρήχθησαν προηγουμένως και δημιουργούμε δύο αρχεία, ένα με όλες τις ημερομηνίες ως έχουν και ένα με όλες τις ημερομηνίες αντεστραμμένες.

Στη συνέχεια συγχωνεύουμε αυτά τα δύο αρχεία, ενώνοντας κάθε γραμμή του πρώτου αρχείου με την αντίστοιχη γραμμή του δεύτερου παρεμβάλλοντας ένα στηλοθέτη - TAB.

Εξοικειωθείτε με τις εντολές στη γραμμή εντολών σας:

# Αφαίρεσε τα κενά
$ echo "Good night " | tr -d " "
Goodnight

# Αφαίρεσε τις παύλες
$ echo "Good-night" | tr -d "-"
Goodnight

# Τύπωσε a-x-z όπου χ ένας αριθμός μεταξύ του 1 και του 9
$ printf "a-%d-z\n" {1..9}
a-1-z
a-2-z
a-3-z
a-4-z
a-5-z
a-6-z
a-7-z
a-8-z
a-9-z

# και αντέστρεψε τη σειρά των χαρακτήρων της κάθε γραμμής
$ printf "a-%d-z\n" {1..9} | rev
z-1-a
z-2-a
z-3-a
z-4-a
z-5-a
z-6-a
z-7-a
z-8-a
z-9-a

Επεξήγηση εντολής

tr -d '': αφαιρούμε τα κενά από την είσοδο - input (που είναι η έξοδος - output της προηγούμενης εντολής) και αποθηκεύουμε την έξοδο σε ένα αρχείο με όνομα alldates.txt
rev: αντιστρέφουμε του χαρακτήρες κάθε γραμμής του αρχείου alldates.txt και αποθηκεύουμε την έξοδο σε ένα νέο αρχείο με όνομα revdates.txt
paste: ενώνουμε τα δύο αρχεία; κάθε γραμμή του αρχείου alldates.txt ενώνεται με την αντίστοιχη γραμμή του αρχείου revdates.txt παρεμβάλλοντας ένα στηλοθέτη - tab (τα δύο αρχεία έχουν τον ίδιο αριθμό γραμμών).

Αποτελέσματα - Output

202025	520202
20200205	50200202
202024	420202
20200204	40200202
202023	320202
20200203	30200202
202022	220202
20200202	20200202
202021	120202
20200201	10200202

awk '$1==$2{print $1}'

Σε αυτό το τελευταίο τμήμα της εντολής, χρησιμοποιούμε την awk για να τυπώσουμε τα παλίνδρομα.

Εξοικειωθείτε με τη σχετική λειτουργικότητα της awk στη γραμμή εντολών σας:

# Τύπωσε ολόκληρη την είσοδο (η προεπιλεγμένη συμπεριφορά της awk) αν τα πεδία είναι ίδια
$ echo "a a" | awk '$1==$2'
a a

# Τύπωσε ολόκληρη την είσοδο (η προεπιλεγμένη συμπεριφορά της awk) αν τα πεδία είναι ίδια
$ echo "a a" | awk '$1!=$2'
# δεν τυπώνεται τίποτα εδώ

# Τύπωσε ολόκληρη την είσοδο (η προεπιλεγμένη συμπεριφορά της awk) αν τα πεδία είναι ίδια
$ echo "a b" | awk '$1!=$2'
a b

# Τύπωσε το πρώτο πεδίο αν τα πεδία δεν είναι ίδια
$ echo "a b" | awk '$1!=$2 {print $1}'
a

# Τύπωσε το δεύτερο πεδίο αν τα πεδία δεν είναι ίδια
$ echo "a b" | awk '$1!=$2 {print $2}'
b

Επεξήγηση εντολής

τα αποτελέσματα του προηγούμενου τμήματος της εντολής που είναι η είσοδος αυτού του τμήματος αποτελούνται από γραμμές και κάθε γραμμή έχει δύο τιμές χωρισμένες με στηλοθέτη - TAB. Αυτού του τύπου την είσοδο η awk την διαβάζει ως δύο πεδία για κάθε γραμμή. Μπορούμε να προσπελάσουμε αυτά τα πεδία χρησιμοποιώντας της μεταβλητές $1 και $2 αντίστοιχα.
όπως περιγράφεται σε προηγούμενο άρθρο μου, οι δηλώσεις (statements) στην awk αποτελούνται από ένα μοτίβο (pattern) ή έκφραση (expression) και μια συσχετισμένη ενέργεια (associated action).
```
<pattern/expression> { <action> }
```
Αν το μοτίβο/έκφραση επιτύχει τότε εκτελείται η συσχετισμένη ενέργεια. Στην περίπτωσή μας, η έκφραση μεταφράζεται ως “αν τα δύο πεδία είναι ίδια” ($1==$2) και η ενέργεια ως “τύπωσε το πρώτο πεδίο” (printf $1).
αν τα πεδία είναι ίδια τότε έχουμε μια παλίνδρομη ημερομηνία αφού κάθε ζεύγος πεδίων είναι η ημερομηνία και η αντίστροφη τιμή της.

Αποτελέσματα - Output

Γατοφωτογραφία

Τελειώσαμε, ευχαριστώ για την ανάγνωση.

Αναφορές

Bash: Προσθέτοντας tab συμπλήρωση στα script

Wed, 13 Nov 2019 10:30:00 +0200

Πρόσφατα χρειάστηκε να προσθέσω tab συμπλήρωση σε ένα script μου και βρήκα τη λειτουργικότητα πολύ ενδιαφέρουσα.

Σε αυτό το άρθρο θα εξοικειωθείτε με τη διαδικασία προσθήκης tab συμπλήρωσης στα script σας στη γραμμή εντολών του Bash.

Τι είναι η tab συμπλήρωση (bash completion);

Η tab συμπλήρωση είναι μια λειτουργικότητα μέσω της οποίας το Bash επιτρέπει στους χρήστες να πληκτρολογήσουν τις εντολές τους πιο εύκολα και γρήγορα. Αυτό το πετυχαίνει με το να παρουσιάζει πιθανές επιλογές ως συνέχεια της εντολής όταν οι χρήστες πατούν το tab πλήκτρο καθώς την γράφουν.

$ git<tab><tab>
git                 git-receive-pack    git-upload-archive  
gitk                git-shell           git-upload-pack     
$ git-s<tab>
$ git-shell

Πως δουλεύει;

Το script συμπλήρωσης είναι κώδικας που χρησιμοποιεί την συστημική bash εντολή complete για να ορίσει ποιες προτάσεις συμπλήρωσης θα εμφανιστούν για ένα δεδομένο εκτελέσιμο πρόγραμμα. Η φύση των προτάσεων αυτών ποικίλει από απλές στατικές έως περίπλοκες και δυναμικές επιλογές.

Γιατί να ασχοληθώ;

Είναι καλό να παρέχεται αυτή η λειτουργικότητα στους χρήστες των script:

για να διευκολύνεται η πληκτρολόγηση κειμένου όταν μπορεί να συμπληρωθεί αυτόματα
για να μπορούν να βλέπουν ποιες είναι οι πιθανές συνέχειες στις εντολές που πληκτρολογούν και
για την αποφυγή λαθών και για την βελτίωση της εμπειρίας τους κρύβοντας τις μη διαθέσιμες και εμφανίζοντας τις διαθέσιμες επιλογές βάσει του τι έχουν ήδη πληκτρολογήσει

Ας ξεκινήσουμε

Να τι θα κάνουμε σε αυτό το βοήθημα.

Αρχικά, θα δημιουργήσουμε ένα πολύ απλό εκτελέσιμο script που θα το πούμε dothis. Αυτό θα είναι το script που στη συνέχεια θα προσθέσουμε τη λειτουργικότητα για την tab συμπλήρωση. Το μόνο που θα κάνει το script είναι να εκτελεί την εντολή που βρίσκεται σε μια συγκεκριμένη θέση στο ιστορικό των εντολών του χρήστη. Τη θέση της εντολής στο ιστορικό θα την δέχεται σαν παράμετρο κατά την εκτέλεση. Για παράδειγμα, η παρακάτω εντολή θα εκτελέσει την εντολή ls -a δεδομένου ότι η τελευταία βρισκεται στη θέση 235 στο ιστορικό εντολών του χρήστη:

dothis 235

Στη συνέχεια θα δημιουργήσουμε το script tab συμπλήρωσης που θα εμφανίζει τις εντολές μαζί με τη θέση τους, από το ιστορικό εντολών του χρήστη και τέλος θα το συνδέσουμε με το πρόγραμμα dothis που προανέφερα.

$ dothis <tab><tab>
ls
ls -la
cd ~
man history
git status
history | cut -c 8-

Συγκεντρωθείτε bash και τα καταφέρουμε με την πρώτη.

Δημιουργία του εκτελέσιμου προγράμματος

Δημιουργήστε ένα αρχείο με το όνομα dothis στο φάκελο που επιθυμείτε και προσθέστε τον παρακάτω κώδικα:

if [ -z "$1" ]; then
  echo "No command number passed"
  exit 2
fi

exists=$(fc -l -1000 | grep ^$1 -- 2>/dev/null)

if [ -n "$exists" ]; then
  fc -s -- "$1"
else
  echo "Command with number $1 was not found in recent history"
  exit 2
fi

Σημειώσεις:

Πρώτα ελέγχουμε αν το πρόγραμμα κλήθηκε με παράμετρο
Στη συνέχεια ελέγχουμε αν ο συγκεκριμένος αριθμός αντιστοιχεί σε κάποια από τις τελευταίες 1000 εντολές του ιστορικού του χρήστη.
- αν ναι τότε την εκτελούμε με χρήση της εντολής fc
- διαφορετικά εμφανίζουμε ένα μήνυμα λάθους

Μετατρέψτε το script σε εκτελέσιμο με την παρακάτω εντολή:

chmod +x ./dothis

Θα εκτελούμε συχνά αυτό το script σε αυτό το βοήθημα οπότε συνιστώ να το μεταφέρετε σε ένα φάκελο που ανήκει στην μεταβλητή PATH του περιβάλλοντός σας ωτε να μπορούμε να το προσπελάσουμε από παντού απλά πληκτρολογώντας dothis.

Το δικό μου το έβαλα στο home bin πληκτρολογώντας:

install ./dothis ~/bin/dothis

Μπορείτε να κάνετε το ίδιο δεδομένου ότι έχετε φάκελο ~/bin ο οποίος εμπεριέχεται στην PATH μεταβλητή σας.

Δοκιμάστε να δείτε ότι δουλεύει:

dothis

Θα έπρεπε να δείτε αυτό:

$ dothis
No command number passed

Done.

Δημιουργία του script tab συμπλήρωσης

Δημιουργήστε ένα αρχείο με όνομα dothis-completion.bash. Από εδώ και στο εξής θα αναφέρομαι στο αρχείο αυτό με τον όρο script συμπλήρωσης.

Αφού του προσθέσουμε κώδικα, θα εκτελέσουμε την εντολή source για να το “ενεργοποιήσουμε”. Θα εκτελούμε την source σε αυτό το αρχείο κάθε φορά που αλλάζουμε το περιεχόμενό του ώστε να ισχύουν οι αλλαγές.

Θα συζητήσουμε επιλογές ώστε να να γίνεται η ενεργοποίηση αυτή κάθε φορά που ανοίγει νέα bash κονσόλα αργότερα.

Στατική συμπλήρωση

Υποθέστε ότι το dothis υποστήριζε μια στατική λίστα από παραμέτρους, για παράδειγμα:

τώρα
αύριο
ποτέ

Θα χρησιμοποιήσουμε την εντολή complete για να καταχωρήσουμε αυτή τη λίστα ως επιλογές για tab συμπλήρωση. (Για να χρησιμοποιήσουμε τη σωστή ορολογία, θα χρησιμοποιήσουμε την εντολή complete για να ορίσουμε τις προδιαγραφές συμπλήρωσης (compspec) για το πρόγραμμά μας.)

Προσθέστε αυτά στο script συμπλήρωσης.

#/usr/bin/env bash
complete -W "τώρα αύριο ποτέ" dothis

Τι κάναμε με τη χρήση της παραπάνω εντολής complete:

χρησιμοποιήσαμε την επιλογή -W (wordlist) για να παρέχουμε τη λίστα που θα χρησιμοποιηθεί για συμπλήρωση
ορίσαμε σε ποιο πρόγραμμα αυτή η λίστα θα παρέχεται για tab συμπλήρωση (η τελευταία παράμετρος: dothis)

“Ενεργοποιήστε” το αρχείο (δεν βρήκα πιο δόκιμο όρο για να περιγράψω τη σημασία της εκτέλεσης της εντολής “source”):

source ./dothis-completion.bash

Τώρα προσπαθήστε να πατήσετε το πλήκτρο tab δύο φορές όπως παρακάτω:

$ dothis <tab><tab>
αύριο ποτέ τώρα

Προσπαθήστε ξανά αφού βάλετε και ένα τ:

$ dothis τ<tab><tab>
τώρα

Magic! Οι επιλογές συμπλήρωσης φιλτράρονται αυτόματα ώστε να εμφανιστούν μόνο αυτές που ξεκινούν από τ.

Σημείωση: Οι επιλογές συμπλήρωσης δεν εμφανίζονται με τη σειρά που τις ορίσαμε στη λίστα λέξεων, ταξινομούνται αυτόματα.

Υπάρχουν πολλές άλλες επιλογές πέραν της -W που χρησιμοποιήσαμε προηγουμένως. Οι περισσότερες παράγουν συμπληρώσεις με στατικό τρόπο, εννοώντας ότι δεν επεμβαίνουμε δυναμικά στο φιλτράρισμα τους.

Για παράδειγμα, αν θέλαμε να έχουμε ως tab συμπληρώσεις για το εκτελέσιμο dothis τους φακέλους που βρίσκονται στον τρέχων φάκελο, θα αλλάζαμε την εντολή ως εξής:

complete -A directory dothis

Πατώντας το tab μετά το dothis, θα λαμβάναμε μια λίστα σαν την παρακάτω:

$ dothis <tab><tab>
dir1/ dir2/ dir3/

Βρείτε ολόκληρη τη λίστα με τις διαθέσιμες επιλογές εδώ.

Δυναμική tab συμπλήρωση

Θέλουμε να παράγουμε τις προτάσεις συμπλήρωσης για το εκτελέσιμο script μας με την ακόλουθη λογική:

αν ο χρήστης πατήσει το tab αμέσως μετά την εντολή, θα δείχνουμε τις τελευταίες 50 εκτελεσθείσες εντολές μαζί με τον αριθμό που αντιστοιχεί στη θέση τους στο ιστορικό
αν ο χρήστης πατήσει το tab αφού έχει πληκτρολογήσει και έναν αριθμό τότε θα εμφανίζουμε όλες τις εντολές των οποίων η θέση στο ιστορικό του, είναι ή ξεκινά με αυτόν τον αριθμό
αν ο χρήστης πατήσει το tab αφού έχει πληκτρολογήσει και έναν αριθμό και υπάρχει μόνο μια εντολή με θέση που είναι ή ξεκινά με τον αριθμό αυτό τότε θα συμπληρώσουμε απευθείας όλο τον αριθμό (αν έχετε μπερδευτεί μην ανησυχείτε, θα ξεκαθαρίσουν όλα παρακάτω)

Ας ξεκινήσουμε με το να ορίσουμε μια μέθοδο που θα εκτελείται κάθε φορά που ο χρήστης θα “ζητά” προτάσεις συμπλήρωσης για την εντολή dothis (πατώντας το tab). Αλλάξτε το script συμπλήρωσης ως εξής:

#/usr/bin/env bash
_dothis_completions()
{
  COMPREPLY+=("τώρα")
  COMPREPLY+=("αύριο")
  COMPREPLY+=("ποτέ")
}

complete -F _dothis_completions dothis

Σημειώστε τα παρακάτω:

χρησιμοποιήσαμε την επιλογή -F στην εντολή complete ορίζοντας ότι η _dothis_completions είναι η μέθοδος που θα παρέχει τις προτάσεις συμπλήρωσης για το dothis εκτελέσιμο
η COMPREPLY είναι μια μεταβλητή τύπου πίνακα που χρησιμοποιείται για να αποθηκεύει τις προτάσεις συμπλήρωσης - ο μηχανισμός συμπλήρωσης χρησιμοποιεί τη συγκεκριμένη μεταβλητή για να εμφανίσει τα περιεχόμενά της ως προτάσεις συμπλήρωσης

Τώρα, ενεργοποιήστε το script συμπλήρωσης και κατόπιν δοκιμάστε να πατήσετε tab μετά το εκτελέσιμο dothis:

$ dothis <tab><tab>
αύριο ποτέ τώρα

Τέλεια. Παράγουμε τις ίδιες προτάσεις συμπλήρωσης όπως πριν που χρησιμοποιήσαμε την επιλογή -W. Ή μήπως όχι; Δοκιμάστε το παρακάτω:

$ dothis ποτ<tab><tab>
αύριο τώρα ποτέ

Όπως βλέπετε, παρόλου που έχουμε πληκτρολογήσει ποτ και μετά ζητήσαμε προτάσεις συμπλήρωσης πατώντας το tab, οι διαθέσιμες προτάσεις συμπλήρωσης παραμένουν οι ίδιες, αφιλτράριστες και τίποτα δε συμπληρώνεται αυτόματα (κανονικά θα έπρεπε κατευθείαν να συμπληρωθεί η λέξη ποτέ χωρίς καν να εμφανιστούν προτάσεις συμπλήρωσης αφού είναι η μόνη επιλογή που ξεκινά από ποτ).

Γιατί συμβαίνει αυτό;

Τα περιεχόμενα της μεταβλητής COMPREPLY εμφανίζονται πάντα. Η μέθοδος είναι υπεύθυνη να προσθέτει/αφαιρεί προτάσεις από εδώ και στο εξής.
Αν η COMPREPLY μεταβλητή είχε μόνο ένα στοιχείο τότε η λέξη θα συμπληρωνόταν αυτόματα στην εντολή dothis. Εφόσον η τρέχουσα υλοποίησή μας πάντα αποθηκεύει στη μεταβλητή τις ίδιες τρεις λέξεις, αυτό δε θα συμβεί.

Θα μας σώσει η compgen: μια συστημική εντολή που παράγει προτάσεις συμπλήρωσης υποστηρίζοντας σχεδόν όλλες τις επιλογές που υποστηρίζει και η συστημική εντολή complete που χρησιμοποιούσαμε ως τώρα (πχ. -W για λίστα λέξεων, -d για φακέλους) και φιλτράρει τις προτάσεις βάσει του τι έχει ήδη πληκτρολογηθεί από το χρήστη.

Και πάλι, μην ανησυχείτε αν έχετε μπερδευτεί, τα πάντα θα ξεκαθαρίσουν παρακάτω.

Πληκτρολογήστε τα παρακάτω στη γραμμή εντολών για να κατανοήσετε καλύτερα τη κάνει η compgen:

$ compgen -W "τώρα αύριο ποτέ"
αύριο
τώρα
ποτέ
$ compgen -W "τώρα αύριο ποτέ" τ
τώρα
$ compgen -W "τώρα αύριο ποτέ" α
αύριο

Οπότε τώρα μπορούμε να χρησιμοποιήσουμε την compgen αλλά πρέπει να βρούμε πρώτα τι έχει πληκτρολογήσει ο χρήστης μετά το dothis. Η λειτουργικότητα tab συμπλήρωσης ευτυχώς παρέχει μεταβλητές που σχετίζονται με την συμπλήρωση που είναι υπό εκτέλεση. Παραθέτω τις πιο σημαντικές:

COMP_WORDS: ένας πίνακας με όλες τις λέξεις που έχουν πληκτρολογηθεί μετά από το όνομα του εκτελέσιμου στο οποίο έχει συνδεθεί το compspec (στην περίπτωσή μας: όλες τις λέξεις που έχουν πληκτρολογηθεί μετά το dothis)
COMP_CWORD: ένας αριθμός που δείχνει σε ποια θέση του πίνακα COMP_WORDS βρίσκεται ο κέρσορας - με άλλα λόγια, σε ποια λέξη ήταν ο κέρσορας όταν πατήθηκε το tab
COMP_LINE: ολόκληρη η τρέχουσα εντολή

Για να προσπελάσουμε την λέξη που πληκτρολογήθηκε αμέσως μετά το dothis αρκεί να χρησιμοποιήσουμε την τιμή του COMP_WORDS[1]

Αλλάξτε το script συμπλήρωσης ξανά:

#/usr/bin/env bash
_dothis_completions()
{
  COMPREPLY=($(compgen -W "τώρα αύριο ποτέ" "${COMP_WORDS[1]}"))
}

complete -F _dothis_completions dothis

Ενεργοποιήστε το και ορίστε:

 $ dothis
αύριο     τώρα       ποτέ
$ dothis α
αύριο

Τώρα, αντί των λέξεων τώρα, αύριο, ποτέ, Θα θέλαμε να δούμε τους αριθμούς που είναι στην ουσία οι θέσεις των εντολών από το ιστορικό του χρήστη.

Η εντολή fc -l ακολουθούμενη από έναν αρνητικό αριθμό -n εμφανίζει τις τελευταίες n εντολές που εκτελέστηκαν. Οπότε θα την χρησιμοποιήσουμε ως εξής:

fc -l -50

εμφανίζοντας τις τελευταίες 50 εντολές μαζί με τον αριθμό της θέσης τους στο ιστορικό. Ο μόνος χειρισμός που πρέπει να κάνουμε είναι να αντικαταστήσουμε τα tabs με κενά διαστήματα ώστε να εμφανίζονται σωστά από τον μηχανισμό των συμπληρώσεων του Bash.

sed βόηθα μας.

Αλλάξτε το script συμπλήρωσης ως εξής:

#/usr/bin/env bash
_dothis_completions()
{
  COMPREPLY=($(compgen -W "$(fc -l -50 | sed 's/\t//')" -- "${COMP_WORDS[1]}"))
}

complete -F _dothis_completions dothis

Ενεργοποιήστε το script συμπλήρωσης και δοκιμάστε στη γραμμή εντολών:

$ dothis <tab><tab>
source dothis-completion.bash   649 source dothis-completion.bash   666 cat ~/.bash_profile
clear                           650 clear                           667 cat ~/.bashrc
source dothis-completion.bash   651 source dothis-completion.bash   668 clear
source dothis-completion.bash   652 source dothis-completion.bash   669 install ./dothis ~/bin/dothis
clear                           653 source dothis-completion.bash   670 dothis
source dothis-completion.bash   654 clear                           671 dothis 6546545646
clear                           655 dothis 654                      672 clear
source dothis-completion.bash   656 dothis 631                      673 dothis
source dothis-completion.bash   657 dothis 150                      674 dothis 651
source dothis-completion.bash   658 dothis                          675 source dothis-completion.bash
clear                           659 clear                           676 dothis 651
dothis 623  ls -la              660 dothis                          677 dothis 659
clear                           661 install ./dothis ~/bin/dothis   678 clear
source dothis-completion.bash   662 dothis                          679 dothis 665
clear                           663 install ./dothis ~/bin/dothis   680 clear
source dothis-completion.bash   664 dothis                          681 clear
clear                           665 cat ~/.bashrc

Καθόλου κακό.

Έχουμε ένα πρόβλημα ωστόσο. Προσπαθήστε να πληκτρολογήσετε έναν αριθμό όπως τον βλέπετε στις προτάσεις συμπλήρωσης και πατήστε το tab ξανά.

$ dothis 623<tab>
$ dothis 623  ls 623  ls -la
...
$ dothis 623  ls 623  ls 623  ls 623  ls 623  ls -la

Αυτό συμβαίνει γιατί στο script συμπλήρωσής μας χρησιμοποιήσαμε την τιμή της ${COMP_WORDS[1]} ώστε να ελέγχουμε την πρώτη πάντα λέξη που πληκτρολογήθηκε μετά το dothis (ο αριθμός 623 στην παραπάνω απόσπασμα). Οπότε ο μηχανισμός συμπλήρωσης συνεχίζει να προτείνει ξανά και ξανά την ίδια επιλογή πατώντας το tab.

Για να το διορθώσουμε αυτό, δε θα επιτρέπουμε κανένα είδος συμπλήρωσης να λάβει χώρα αν τουλάχιστον μια λέξη έχει ήδη συμπληρωθεί. Θα προσθέσουμε λοιπόν μια συνθήκη ελέγχοντας το μέγεθος της προαναφερθείσας COMP_WORDS μεταβλητής.

#/usr/bin/env bash
_dothis_completions()
{
  if [ "${#COMP_WORDS[@]}" != "2" ]; then
    return
  fi

  COMPREPLY=($(compgen -W "$(fc -l -50 | sed 's/\t//')" -- "${COMP_WORDS[1]}"))
}

complete -F _dothis_completions dothis

Ενεργοποιήστε το script συμπλήρωσης και ξαναδοκιμάστε.

$ dothis 623<tab>
$ dothis 623 ls -la<tab> # Επιτυχία, δεν συμβαίνει συμπλήρωση εδώ

Υπάρχει ωστόσο και κάτι άλλο που δε μας αρέσει. Θέλουμε να εμφανίζουμε τις θέσεις μαζί με τις αντίστοιχες εντολές ώστε να βοηθήσουμε τους χρήστες να αποφασίσουν ποια είναι η εντολή που θέλουν να εκτελέσουν αλλά όταν υπάρχει μόνο μια πρόταση συμπλήρωσης και ο μηχανισμός τη συμπληρώνει αυτόματα, δεν θα έπρεπε να συμπληρώνεται και η εντολή παρά μόνο ο αριθμός.

Με άλλα λόγια, το dothis δέχεται μόνο έναν αριθμό και δεν έχουμε προσθέσει ελέγχους για περισσότερες παραμέτρους. Όταν μέθοδος που υπολογίζει τις προτάσεις συμπληρώσεων βρίσκε μόνο ένα αποτέλεσμα τότε θα πρέπει να πετσοκόψουμε (trim :D) το λεκτικό που περιέχει τον αριθμό και την εντολή ώστε να μείνει μόνο ο αριθμός.

Για να το πετύχουμε αυτό, θα κρατήσουμε το αποτέλεσμα τις εντολής compgen σε μια μεταβλητή τύπου πίνακα, και αν το μέγεθος της είναι 1 τότε θα επεξεργαστούμε το μοναδικό στοιχείο της ώστε να μείνει μόνο ο αριθμός. Διαφορετικά θα αφήσουμε την μεταβλητή ως έχει.

Αλλάξτε το script συμπλήρωσης ως εξής:

#/usr/bin/env bash
_dothis_completions()
{
  if [ "${#COMP_WORDS[@]}" != "2" ]; then
    return
  fi

  # keep the suggestions in a local variable
  local suggestions=($(compgen -W "$(fc -l -50 | sed 's/\t/ /')" -- "${COMP_WORDS[1]}"))

  if [ "${#suggestions[@]}" == "1" ]; then
    # if there's only one match, we remove the command literal
    # to proceed with the automatic completion of the number
    local number=$(echo ${suggestions[0]/%\ */})
    COMPREPLY=("$number")
  else
    # more than one suggestions resolved,
    # respond with the suggestions intact
    COMPREPLY=("${suggestions[@]}")
  fi
}

complete -F _dothis_completions dothis

Αυτόματη ενεργοποίηση του script tab συμπλήρωσης

Αν θέλετε να ενεργοποιήσετε τις συμπληρώσεις για το εκτελέσιμο μόνο για εσάς, το μόνο που χρειάζεται να κάνετε είναι να προσθέσετε της παρακάτω εντολή στο αρχείο σας ~/.bashrc:

source <path-to-your-script>/dothis-completion.bash

Αν θέλετε να τις ενεργοποιήσετε για όλους τους χρήστες τότε μπορείτε να αντιγράψετε το script συμπλήρωσης στο φάκελο /etc/bash_completion.d/ και θα φορτώνεται αυτόματα από το Bash.

Τελειοποίηση του script συμπλήρωσης

Μερικά επιπλέον βήματα για καλύτερα αποτελέσματα.

Εμφανίζοντας κάθε πρόταση συμπλήρωσης σε νέα γραμμή

Στο script συμπλήρωσης που χρειάστηκε να δημιουργήσω, επίσης έπρεπε να εμφανίζω προτάσεις που αποτελούνταν από δύο τμήματα. Ήθελα να εμφανίζω το πρώτο τμήμα με το εξ ορισμού χρώμα των γραμμάτων της κονσόλας και το δεύτερο τμήμα με γκρι χρώμα ώστε να φαίνεται ότι ήταν απλά βοηθητικό κείμενο. Στο παράδειγμά μας, θα ήταν ωραίο να παρουσιάζουμε τους αριθμούς με το εξ ορισμού χρώμα αλλά το χρώμα των εντολών να ήταν κάτι λιγότερο χτυπητό στο μάτι.

Δυστυχώς, αυτό δεν είναι δυνατόν (τουλάχιστον για την ώρα) γιατί ο μηχανισμός συμπλήρωσης εμφανίζει τις προτάσεις ως καθαρό κείμενο και οι οδηγίες χρώματος δεν εφαρμόζονται (για παράδειγμα, αυτό \e[34mουρανός θα εμφανιζόταν ακριβώς όπως το βλέπετε και όχι η λέξη ουρανός σε μπλε χρώμα).

Αυτό που μπορούμε ωστόσο να κάνουμε για να βελτιώσουμε την εμπειρία των χρηστών (ή όχι :D) είναι να εμφανίζουμε την κάθε πρόταση συμπλήρωσης σε νέα γραμμή. Ο τρόπος για να το κάνουμε αυτό δεν είναι ο προφανής γιατί δεν μπορούμε απλά να προσθέσουμε στο τέλος κάθε πρότασης τον χαρακτήρα αλλαγής γραμμής αφού ο μηχανισμός συμπλήρωσης δεν θα τον μεταφράσει σε αλλαγή γραμμής αλλά θα τον δείξει ως κείμενο (\n).

Θα ακολουθήσουμε ένα μάλλον hackish τρόπο και θα προσθέτουμε κενά στο τέλος κάθε πρότασης συμπλήρωσης, τόσα ώστε το τελικό πλήθος των χαρακτήρων της πρότασης (με τα κενά) να είναι ίσο με το πλήθος των χαρακτήρων που χωρά η κάθε γραμμή της κονσόλας.

printf βόηθα μας.

Αλλάξτε το script συμπλήρωσης ως εξής:

#/usr/bin/env bash
_dothis_completions()
{
  if [ "${#COMP_WORDS[@]}" != "2" ]; then
    return
  fi

  local IFS=$'\n'
  local suggestions=($(compgen -W "$(fc -l -50 | sed 's/\t//')" -- "${COMP_WORDS[1]}"))

  if [ "${#suggestions[@]}" == "1" ]; then
    local number="${suggestions[0]/%\ */}"
    COMPREPLY=("$number")
  else
    for i in "${!suggestions[@]}"; do
      suggestions[$i]="$(printf '%*s' "-$COLUMNS"  "${suggestions[$i]}")"
    done

    COMPREPLY=("${suggestions[@]}")
  fi
}

complete -F _dothis_completions dothis

Ενεργοποιήστε το και δοκιμάστε:

dothis <tab><tab>
...
499 source dothis-completion.bash                   
500 clear
...       
503 dothis 500

Done.

Προσαρμόσιμη συμπεριφορά

Στην περίπτωσή μας, ορίσαμε καρφωτά να εμφανίζονται οι τελευταίες 50 εκτελέσιμες εντολές όταν πατιέται το tab χωρίς να έχει πληκτρολογηθεί κάποιος αριθμός. Θα ήταν καλύτερο να αφήνουμε το χρήστη να επιλέγει πόσες θέλει να είναι αυτές οι εντολές (π.χ. οι τελευταίες 100) και αν δεν έχει ορίσει την επιθυμία του τότε εξ ορισμού να δείχνουμε τις τελευταίες 50,

Για να το πετύχουμε αυτό, θα ελέγχουμε την τιμή μιας μεταβλητής από το περιβάλλον του χρήστη, ας πούμε DOTHIS_COMPLETION_COMMANDS_NUMBER.

Αλλάξτε για τελευταία φορά το script συμπλήρωσης:

#/usr/bin/env bash
_dothis_completions()
{
  if [ "${#COMP_WORDS[@]}" != "2" ]; then
    return
  fi

  local commands_number=${DOTHIS_COMPLETION_COMMANDS_NUMBER:-50}
  local IFS=$'\n'
  local suggestions=($(compgen -W "$(fc -l -$commands_number | sed 's/\t//')" -- "${COMP_WORDS[1]}"))

  if [ "${#suggestions[@]}" == "1" ]; then
    local number="${suggestions[0]/%\ */}"
    COMPREPLY=("$number")
  else
    for i in "${!suggestions[@]}"; do
      suggestions[$i]="$(printf '%*s' "-$COLUMNS"  "${suggestions[$i]}")"
    done

    COMPREPLY=("${suggestions[@]}")
  fi
}

complete -F _dothis_completions dothis

Ενεργοποιήστε το και δοκιμάστε:

export DOTHIS_COMPLETION_COMMANDS_NUMBER=5
$ dothis <tab><tab>
clear
source ./dothis-completion.bash
dothis clear
clear
export DOTHIS_COMPLETION_COMMANDS_NUMBER=5

Χρήσιμοι σύνδεσμοι

Κώδικας και σχόλια

Μπορείτε να βρείτε τον κώδικα από αυτό το άρθρο στο GitHub.

Για feedback, σχόλια, λάθη κ.λπ. παρακαλώ ανοίξτε ένα issue στο αποθετήριο.

Μεγάλο άρθρο, φωτογραφία γάτας

Να σας συστήσω των debugger μου.

Αυτό ήταν. Τελειώσαμε. Καλή συνέχεια.

iridakos - opensource articles

stup - ένα εργαλείο κονσόλας για καθημερινές σημειώσεις

stup

Παραδείγματα χρήσης

Προσθήκη σημειώσεων

Εμφάνιση σημειώσεων συγκεκριμένης ημέρας

Λίστα όλων των σημειώσεων για ένα χρονικό διάστημα

Πως λειτουργεί σε τεχνικό επίπεδο

Περισσότερες πληροφορίες

Εύρεση παλίνδρομων ημερομηνιών στην Linux κονσόλα - επεξήγηση

Τι είναι το παλίνδρομο - Καρκινική γραφή

Η εντολή

printf "now - %d days\n" {1..332044}

Επεξήγηση εντολής

Αποτελέσματα - Output

date -f- +%Y%\_m%\_d$'\n'%Y%m%d

Επεξήγηση εντολής

Αποτέλεσμα - Output

tr -d ' ' > alldates.txt; rev alldates.txt >revdates.txt; paste alldates.txt revdates.txt

Επεξήγηση εντολής

Αποτελέσματα - Output

awk '$1==$2{print $1}'

Επεξήγηση εντολής

Αποτελέσματα - Output

Γατοφωτογραφία

Αναφορές

Bash: Προσθέτοντας tab συμπλήρωση στα script

Τι είναι η tab συμπλήρωση (bash completion);

Πως δουλεύει;

Γιατί να ασχοληθώ;

Ας ξεκινήσουμε

Δημιουργία του εκτελέσιμου προγράμματος

Δημιουργία του script tab συμπλήρωσης

Στατική συμπλήρωση

Δυναμική tab συμπλήρωση

Αυτόματη ενεργοποίηση του script tab συμπλήρωσης

Τελειοποίηση του script συμπλήρωσης

Εμφανίζοντας κάθε πρόταση συμπλήρωσης σε νέα γραμμή

Προσαρμόσιμη συμπεριφορά

Χρήσιμοι σύνδεσμοι

Κώδικας και σχόλια

Μεγάλο άρθρο, φωτογραφία γάτας

date -f- `+%Y%\_m%\_d$'\n'%Y%m%d`