rumpl / c

Add comments on any file or folder.

I'm a gopher

I'm Djordje Lukic, developer, I love making tools for developers.

Want to see more?

• rumpl.dev
• twitter

c's Issues

Add a .commentsignore filetype.

With this file you could specify directories or files to be ignored from having comments set on them, and from being listed when running the list command.

npm publish

The npmpublish github action just publishes the code but doesn't update the version in the package.json file before publishing. This means that we need to manually update the package.json file and merge it to master before creating a tag. This is error prone and to manual for my liking.

We need to update the github action to change the version in the package.json before publishing

Graphical bug when using list command

I introduced this recently by accident - the directories are printed with a '/' character at the end, to better show that they are directories. However this causes there comments to be misaligned, printing with an extra space. This should be fixed.

Create a -a flag to show hidden files

By default, c lists all files and directories, even hidden files.
The default behaviour should be set to hiding hidden files and their descriptions, unless and -a flag is set.

This will require the package to be capable of reading multiple flags!

Implement a 'cleaner' to remove '.comment' files.

If a file or directory has a comment and is then deleted, the .comment file relevant to it persists. We could implement a flag (-c or clean) which will look through each .comment, see if it's relevant file/dir is still there and if not, delete that .comment.

Searching the parent directory for a definition of the current directory

When using the list command, a listing for the current directory (./) appears. A function could be implemented whereby, if the current directory has no comment, we could look in it's parent directory to see if it has a comment defined there and, if so, move that into the current directories .comments folder.

Implement Git integration

If the package has git integration, .comments can live within .git and can reflect the structure of the git project. This means that the project will be less cluttered with .comments, if you wish to use it extensively in your project.

Create a README.txt when a new '.comments' directory is created.

If somebody is using the c package and commits there .comments directory to a repository, other developers working on the project may be unsure what it is. Each .comments could therefore have a README explaining what it is/does and how other developers can get involved.

Adding tags to release new NPM version doesn't appear to work

Hey @rumpl I performed $ git tag -a v1.0.2 -m "Version 1.0.2" to release a minor change to the npm package. This doesn't seem to be reflected in the repo or npm. Mind checking this out when you can?

Also, it looks like GitHub allows you to publish npm packages through GitHub following the merger/buyout that happened, so that could be worth doing?

Test suite

I'm prone to breaking things, so a small test suite to ensure that each command still works correctly would go a long way.