Giter VIP home page Giter VIP logo

todog-atom's Introduction

Todo Show Package Build Status

Finds all TODO, FIXME, CHANGED, XXX, IDEA, HACK, NOTE, REVIEW, NB, BUG, QUESTION, COMBAK, TEMP comments in your project and shows them in a nice overview list.

Attention: This package searches for todos. For todo word highlighting see language-todo.

Open todo list using command palette Todo Show: Find In Workspace, Todo Show: Find In Project or Todo Show: Find In Open Files. Keyboard shortcuts CTRL + SHIFT + T on Mac OSX or ALT + SHIFT + T on Windows and Linux.

Install with apm install todog or use Install Packages from Atom Settings.

todog-package

Search Scopes

Five different scopes are available to narrow down your search for todos. Change scope using the button at the top of the todo view or use the corresponding command.

  • Workspace: Searches all open projects.
  • Project: Searches active project (a project is marked as active when you open a file it contains).
  • Open Files: Searches currently open files.
  • Active File: Searches last active file only.
  • Custom: Tree view has a context menu to search for todos in the selected folder or file.

Configuration

Name Default Description
autoRefresh true Automatic refresh of todo list after saving
findTheseTodos ['FIXME', 'TODO', 'CHANGED', 'XXX', 'IDEA', 'HACK', 'NOTE', 'REVIEW', 'NB', 'BUG', 'QUESTION', 'COMBAK', 'TEMP'] An array of todo types used by the search regex
findUsingRegex See 'Regular Expression Search' section Regex string used to find all your todos. ${TODOS} is replaced with FindTheseTodos from above
ignoreThesePaths ['node_modules', 'vendor', 'bower_components', '*.pdf'] An array of files / folders to exclude (syntax according to scandal used internally by Atom).
globally: Ignored Names from atom core settings.
locally: Ignores anything in your .gitignore file, if the current project is a valid git repository and atom core setting Exclude VCS Ignored Paths is checked.
showInTable ['Text', 'Type', 'Path'] An array of properties to show for each todo in table
sortBy 'Text' Sort table by this todo property
sortAscending true Sort table in ascending or descending order
exportAs 'List' Choose which format to use for exported markdown
statusBarIndicator false Show todo count in status bar (this is only shown and updated when the 'Todo Show' tab is open)

Regular Expression Search

The regexes in findTheseRegexes are used for searching the workspace for todo matches. They are configurable to match the users specific needs.

Default regex string: '/\\b(${TODOS})[:;.,]?\\d*($|\\s.*$|\\(.*$)/g'

  • \b start at word boundary
  • ${TODOS} todo type match (is replaced with findTheseTodos)
  • [:;.,]? optional separator after type
  • \d* optional digits for supporting imdone sorting
  • $ to end todos without additional text (newline)
  • Or \s.*$ to match the todo text with a non-optional space in front
  • Or an immediate parentheses, \(.*$, to support Google style guide IDs
  • Because Atom config only accepts strings all \ characters are also escaped

Todos can be tagged using hashtag (e.g. TODO: do this #object #profile), which is presented in the tags column.

To extend the default todo types and search regex, the existing config needs to be copied into your config.cson.

Credits

Originally created by Jamis Charles

Now maintained by Martin Rodalgaard

todog-atom's People

Stargazers

 avatar  avatar

Watchers

 avatar

todog-atom's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.