stephenb / node-notes Goto Github PK

Hi,

I just noticed that the module doesn't have a software license. It would be nice to have one added to the repo and NPM module.

I'm getting reports from the coverage html files which shows the same notes multiple times.

Maybe notes should consider only .js and .ts files, or at the very least allow exclusion of extensions?

It would be a cool feature to add ignore files feature to pick from .gitignore or some other file specified in params.

Since I always end up specifying the same directories over and over again, I guess it will be kinda useful to add support for .notesrc file.

Here is the main idea. If no arguments are supplied to the executable, it will check the cwd for .notesrc file and if one is found it will extract its content and it will search in the mentioned directories. Also the other benefit is that if a whole team is using this tool, they won't have to maintain/build their own .notesrc file, since it can be added in the version control.

The implementation is trivial, no code other than the executable will be changed.

Let me know if you are interested in me implementing this.

Cheers!

Hi,

I noticed that the library does not support spotting TODO/NOTE inside multi-line comments. I may try and have a go at implementing support for this in a Pull Request.

Hello.
Thanks for the awesome addition to node! This feature was awesome in rails, will be just as useful in node apps.

The filter directories array defined on line 32 of notes.js does not filter directories added to it.

Maybe I am not understanding your intention, but should this not skip the directories listed?

Notes.filterDirectories = ["node_modules", "app/vendor", "build"];

Notes does not skip the app/vendor or build directories.

Thanks
Greg

Hey guys,

I bumped into @ahmadassaf's fork of this via Hacker News and really like the idea of it. I was sad to see the two projects were being developed apart from each other when essentially they are the same features. Have you thought of merging them together?

@ahmadassaf if you decide to keep going your own way consider not leaving it a fork. It's not possible to make issues on them.

I really like the project, as it could me improving me workflow by putting in comments in there during longtime development of a feature.

To make it really useful, it would be great to set reporting levels.

I'm thinking of the return of a status code 1 in case any TODO were discovered.
Or even a returned status code if anything is discovered.

This would allow me to put it into a CI system or use it inside of a git hook to not accidentally commit any TODO comments.

I want to add simple executable. This way it will allow us to search in any directory without having a Cakefile, simply by installing the module globally. If you are interested in this feature, I can create a pull requests. Cheers!

XXX in a comment is usually a heads-up. It could be:

• Something that's not implemented completely correctly.
• Something that should be fixed later on.
• Highlighting a possible problem spot.
• Something you're not sure about, a question.