Skip to content

Instantly share code, notes, and snippets.

@gwpantazes
Last active December 11, 2017 15:22
Show Gist options
  • Save gwpantazes/515c000941c61fb5ffd4774cb8a0fb75 to your computer and use it in GitHub Desktop.
Save gwpantazes/515c000941c61fb5ffd4774cb8a0fb75 to your computer and use it in GitHub Desktop.
Atom Highlighted TODO Keywords List

Atom language-todo package provides the TODO highlighting.

Atom Text Editor Highlighted Words List

These words have special atom highlighting.

  1. BUG
  2. CHANGED
  3. COMBAK (Literally "Come Back")
  4. DEBUG
  5. FIXME (class name is fix)
  6. HACK
  7. IDEA
  8. NB (not just a note but an important note: Note Bene!)
  9. NOTE
  10. OPTIMIZE
  11. QUESTION
  12. REVIEW
  13. TEMP
  14. TODO
  15. XXX

I already knew about TODO, but my new favourites on this list are BUG, IDEA, NOTE, and QUESTION for notetaking purposes in markdown files. I am as of yet unsure how to add new additions to the list (TODO).

These keywords have to be written in all caps to trigger the highlighting. Also, these words do not highlight in Plain Text syntax, but do appear highlighted in Markdown and programming language syntax comments.

Styling

They can be styled in Atom's style sheet styles.less by targeting the syntax class of the keyword

atom-text-editor.editor .syntax--type.syntax--class.syntax--question {
  color: green;
}

DEPRECATED: targeting the direct class name in the shadow DOM is deprecated.

atom-text-editor::shadow .type.class.todo {
  color: green;
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment