mikaeljorhult / brackets-todo

Brackets/Edge Code extension that displays all TODO comments in current document or project.
144 stars 37 forks source link

Display TODO's from all files in project #51

Closed thany closed 10 years ago

thany commented 10 years ago

Can this be done? For projects with many files it's a bit tedious to keep going over all files to see if any TODO's are remaining.

mikaeljorhult commented 10 years ago

Yes, by adding a .todo file in your project you change the search scope from the current file to the entire project. There is multiple examples in the documentation how to change the behaviour of the extension.

Please let me know if you run into any problems.

thany commented 10 years ago

That's not what I mean. Sure, I could add a file to my project, but I prefer putting TODO comments near the code that it applies to, instead of in a separate file.

mikaeljorhult commented 10 years ago

Yes, I understand. By default the Todo extension will only search the currently active file, but by adding a .todo file you can change the search scope so that all files are searched at once.

Create a file with the name .todo in your project root and add the following code:

{
    "search": {
        "scope": "project"
    }
}

All files within you projects will be searched and all comments, in all files, shown in the todo panel.

thany commented 10 years ago

Ooh, I get it. I though the .todo file was a file with project-wide todo entries, but I understand it's just a config file. Sorry for misunderstandig :)

mikaeljorhult commented 10 years ago

No problem. I'll have a look to see if I can make the documentation a bit clearer.