Write, view, edit and delete comments on files and directories, all from the command line.
Authored by Djordje Lukic.
Original idea by Jonovono.
Install the module globally with npm install c -g
.
Usage: c [-l | list <DIRECTORY|FILE>]
[-rm | remove <DIRECTORY|FILE>]
[-s | set <DIRECTORY|FILE> <COMMENT>]
[-h | help]
[-v | version]
Options:
list | -l Lists all the comments for the specified directory.
set | -s Sets or overwrites a new comment for the file|directory.
remove | -rm Deletes the comment for the file|directory.
help | -h Shows the help menu.
version | -v States the version.
$ c set . "What a great utility!"
$ c list .
"What a great utility!" was applied to "." successfully.
./ What a great utility!
../
SomeDir/
SomeFile.ext
$ c -s someDir "Another comment"
$ c -l .
"Another comment" was applied to "someDir" successfully.
./ What a great utility!
../
SomeDir/ Another comment
SomeFile.ext
$ c remove someDir
$ c list .
someDir comment was deleted successfully.
./ What a great utility!
../
SomeDir/
SomeFile.ext
To release a new version of c
simply do:
$ git tag -a vVERSION -m "Version VERSION"
# For example:
$ git tag -a v1.0.0 -m "Version 1.0.0"
This will create a new release on github and publish the package on npm