branch: master commit 94bc0dca8dde3688bc69289a72707f150720768e Author: Jackson Ray Hamilton <jack...@jacksonrayhamilton.com> Commit: Jackson Ray Hamilton <jack...@jacksonrayhamilton.com>
Add note about comments and strings. Update screenshots. --- README.md | 25 +++++++++++++------------ scopifier.png | Bin 2516 -> 2609 bytes screenshot.png | Bin 21829 -> 22006 bytes 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b2e2c57..a16c26a 100644 --- a/README.md +++ b/README.md @@ -9,20 +9,21 @@ Highlights code according to function context. - Code in the global scope is one color. Code in functions within the global scope is a different color, and code within such functions is another color, and so on. -- Identifiers retain the color of the scope in which they were declared. -- Comments are a neutral color. +- Identifiers retain the color of the scope in which they are declared. Lexical scope information at-a-glance can assist a programmer in understanding -the overall structure of a program. It can also help curb nasty bugs like name -shadowing or unexpected assignment. A rainbow can indicate excessive -complexity. A spot of contrast followed by an assignment expression could be a -side-effect. The state of a closure could be undergoing change. - -This coloring strategy is probably more useful than conventional *syntax* -highlighting. Highlighting keywords can help one to detect spelling errors, and -highlighting the content between quotation marks can alert one to unclosed -string literals. But a [linter][] could also spot those errors, and if -integrated via [flycheck][], an extra spot opens up in your editing toolbelt. +the overall structure of a program. It can help to curb nasty bugs like name +shadowing. A rainbow can indicate excessive complexity. State change within a +closure is easily monitored. + +By default, Context Coloring still highlights comments and strings +syntactically. It is still easy to differentiate code from non-code, and strings +cannot be confused for variables. + +This coloring strategy is probably more useful than conventional syntax +highlighting. Highlighting keywords can help one to detect spelling errors, but +a [linter][] could also spot those errors, and if integrated with [flycheck][], +an extra spot opens up in your editing toolbelt. Give context coloring a try; you may find that it *changes the way you write code*. diff --git a/scopifier.png b/scopifier.png index 1d690cb..1ec5d10 100644 Binary files a/scopifier.png and b/scopifier.png differ diff --git a/screenshot.png b/screenshot.png index fe45d9b..89665b7 100644 Binary files a/screenshot.png and b/screenshot.png differ