Skip to content

Leirda01/journal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 

Repository files navigation

Simple journaling script made in bash

this is what I use to write, read & efficiently manage my journal.

Usage

Users

  • $JOURNAL_NAME should be the name of the folder containing all pages.

  • $JOURNAL_SEP should be the separator between date & page name.

  • $EDITOR should be the editor you wish to use to edit your journal.

Developpers

  • $command_path should not be changed. tell where to search for COMMAND.

  • $command_path should only contain executable files.

  • $call_mode the custom COMMAND you try to execute.

  • $call_command the UNIX command you try to execute otherwise.

  • $date the current date in the specified format.

  • $page the date + page name user wish to edit in the specified format.

  • $path the path where to create the page user wish to edit.

TODO

  • Un sommaire pour afficher le titre des pages

    • en fonction du jour

    • dans l’intégralité du journal

    • dans un intervalle de temps

  • Rendre le script compatible à MacOS.

    • Notamment l’appel à la commande date.

  • trop de variables pour exprimer des concepts pas clair. Simplifier.

    • Spécifier un format style y-m-d/j, y/m/d/j, y/m/d-j, y-m-d_j, etc.?

    • Généraliser les noms pour avec l’usage de dirname et basename.

  • Ajouter des tests, parce que ça devient compliqué de vérifier à la main…

    • Pas grand chose de satisfaisant pour faire des tests en bash ?

    • Ne pas tester des retours de commandes qui n’ont à priori pas besoin de l’être.

    • La commande test ([[) semble utile…, dans l’idée d’automatiser.

  • Faire valider les scripts par shellcheck

About

simple bash journaling script

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages