atom / language-todo Goto Github PK

For some reason this isn't highlighting with Go syntax highlighting for me.

Running Atom 1.0.3, go-plus, go-oracle, etc. (not sure if it's impacted by another package).

When I add a FIXME in my bash script, the FIXME is barely distinguishable. The style of the highlight should be at least configurable.

Prerequisites

• [ X] Put an X between the brackets on this line if you have done all of the following:
  • Reproduced the problem in Safe Mode: http://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode
  • Followed all applicable steps in the debugging guide: http://flight-manual.atom.io/hacking-atom/sections/debugging/
  • Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq
  • Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom
  • Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages

Description

Syntax highlighting and scope detection for the TODO keyword does not work anymore (not sure what changed).

Steps to Reproduce

1. Launch atom in safe mode
2. Create a new cpp file
3. Type in a comment with TODO in it
4. Watch in horror as nothing happens

Expected behavior: TODO gets highlighted. If scope is checked on the TODO token, it should not say "comment block"

Actual behavior: TODO does not get highlighted. If scope is checked on the TODO token, it should not say "comment block"

Reproduces how often: 100% of time

Versions

1.32.0

Additional Information

See YouTube video of this:

https://www.youtube.com/watch?v=7YI3qwZWyTE&feature=youtu.be

Hello, I'm trying to use this with language-rust but can't get it to work.

I've tried changing things in both the language-rust and language-todo packages but can't figure out why languages such as e.g. java, cpp, etc. all use language-todo without problem but rust doesn't.

Thank you for your time.

Do releases happen automatically with a version number bump? Or are they a manual process? What constitutes a release?

Just checking if there is anything else I need to do with regards to my PR #68

How do you guys feel about adding snippets?

What is the best way? Different snippets for each comment type? Something like this:

'.source.ruby, .source.coffee':
  'todo':
    'prefix': 'todo'
    'body': '# TODO: $0'
  'fixme':
    'prefix': 'fix'
    'body': '# FIXME: $0'
  'xxx':
    'prefix': 'xxx'
    'body': '# XXX: $0'
'.text.haml':
  'todo':
    'prefix': 'todo'
    'body': '-# TODO: $0'
  'fixme':
    'prefix': 'fix'
    'body': '-# FIXME: $0'
  'xxx':
    'prefix': 'xxx'
    'body': '-# XXX: $0'

To drag out a dead horse, Sublime has a constant that matched to comments for each language. So my solution was:

<snippet>
  <content><![CDATA[$TM_COMMENT_START${2:TODO}: ${1:}$TM_COMMENT_END]]></content>
  <tabTrigger>todo</tabTrigger>
</snippet>

Is something like that possible?

Can be reproduced by creating a new file named TODO*.

Version 0.135.0 (0.135.0) on OS X

I see that I can use NOTE but to me NB signifies not just a note but an important note: Note Bene!

https://en.wikipedia.org/wiki/Nota_bene
Tia!

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Reproduced the problem in Safe Mode: https://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode
  • Followed all applicable steps in the debugging guide: https://flight-manual.atom.io/hacking-atom/sections/debugging/
  • Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq
  • Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom
  • Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages

Description

Steps to Reproduce

Expected behavior:
#TODO should be highlighted in shell script files

Actual behavior:
#TODO is not highlighted in shell script files

Reproduces how often:
100%

Versions

Atom : 1.45.0
Electron: 4.2.7
Chrome : 69.0.3497.128
Node : 10.11.0

OS: Ubuntu 20.04

In a project with teams it would be nice to see who wrote the comment so i think it would be nice if the snippet would generate something like this:

// TODO: (<name>) validate username 

where name is taken from git config user.name and fallback to the name of the account in the OS

Would be good if OPTIMIZE was highlighted (as per http://rubyquicktips.com/post/385665023/fixme-todo-and-optimize-code-comments).

Prerequisites

• [ X ] Put an X between the brackets on this line if you have done all of the following:
  • Reproduced the problem in Safe Mode: http://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode
  • Followed all applicable steps in the debugging guide: http://flight-manual.atom.io/hacking-atom/sections/debugging/
  • Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq
  • Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom
  • Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages

Description

language-todo won't highlight in C files

Steps to Reproduce

1. Write TODO: comment in a C/C++ file (doesn't matter if it is a single line comment or a block comment)

Expected behavior: TODO: comment should be highlighted

Actual behavior: TODO: comment isn't highlighted

Reproduces how often: 100%

Versions

Atom : 1.32.2
Electron: 2.0.9
Chrome : 61.0.3163.100
Node : 8.9.3

OS: OS X Sierra 10.12.6

Currently, when we write a todo comment we must write "todo" in uppercase and only "todo" is highlighted.

Proposed changes:

Accept any combination of case. "todo", "Todo", "tOdO", etc.

Highlight the entire line for better visibility.

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Reproduced the problem in Safe Mode: http://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode
  • Followed all applicable steps in the debugging guide: http://flight-manual.atom.io/hacking-atom/sections/debugging/
  • Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq
  • Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom
  • Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages

Description

Atom is not highlighting "TODO" statements at all.

Steps to Reproduce

1. Open Atom
2. Open or create any file (tested with ".js" and ".c")
3. Type "// TODO: test", "// TODO test", "// todo: test", or "// todo test"

Expected behavior:
"TODO" should have been highlighted (last I recall, in a purple color, I think)

Actual behavior:
"TODO" looks like just any other word in a comment: gray and boring

Reproduces how often:
100% of the time (it used to work, but today I noticed that it had stopped working. Don't actually know how long it's been since it stopped working, but it was working last Sunday).

Versions

Atom : 1.32.0
Electron: 2.0.12
Chrome : 61.0.3163.100
Node : 8.9.3

Additional Information

No errors were reported in the Developer Console while I was testing it, except for some warning that started with:

Electron Security Warning /usr/lib/electron/re...ity-warnings.js
Security Policy Set or a policy with "unsafe-eval" enabled. This exposes users of this app to unnecessary security risks

Would be nice for the TODO in python docstring to be a different colour.
Currently it stays green like the docstring and does not stand out. The snippet also adds an unnecessary comment (#) symbol.
Works fine everywhere else.

TODO et al. are not highlighted when using Babel ES6 Javascript syntax (https://atom.io/packages/language-babel).

Description

Highlight is not working in js files (JavaScript grammar selected). But it works in other files/grammars.

Versions

Atom version 1.32.2
OS Linux Mint 19 Tara

Additional Information

Have tried a fresh install on other pc (thought the problem maybe with packages) - same problem.

If I create a file and use TODO somewhere in the middle of a sentence, it highlights correctly. If I then save the file and reopen it, the highlighting disappears. See GIF

Description

The TODO highlight is not working in Solidity (.sol) file.

Versions

Atom: 1.28.1 x64
OS: Mac OSX 10.12.6

A generic entity class has an ID field defined.
When the idea snippet is defined, the following will be listed whe enter entity.i.

• idea
• ID

Is there any way to disable the idea snippet?
Or whether you can set whether to use the idea snippet or not?

I am using language-todo while commenting out idea part of language-todo/snippets/todo.cson.

I think that it is not much to use the idea snippet compared to the ID field.
I think that there are many people in trouble for the same reason.
I am really happy to provide it as a package feature. plz

Sometimes I use the TEMP tag or DEBUG, it would be nice if we can add custom snippets, and I think this can fix issues like #58 if the plugin just handle by default the most used tags like TODO and FIX so users can add its own tags/snippets.

It would be really nice to have todo highlighting in my typescript probjects.

Prerequisites

• [ X] Put an X between the brackets on this line if you have done all of the following:
  • Reproduced the problem in Safe Mode: http://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode
  • Followed all applicable steps in the debugging guide: http://flight-manual.atom.io/hacking-atom/sections/debugging/
  • Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq
  • Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom
  • Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages

Description

TODO highlighting doesnt work on Clojure

Steps to Reproduce

1. Open a Clojure file (*.clj)
2. type ;; TODO: non sense

Expected behavior:
3. After typing ;; TODO I expected the TODO to be highlighted

Actual behavior: Nothing happens, it is just rendered as a normal comment

Reproduces how often: Only on Clojure files (so far). It works on Javascript files though.

Versions

Atom : 1.9.8
Electron: 0.37.8
Chrome : 49.0.2623.75
Node : 5.10.0

apm 1.10.0
npm 2.13.3
node 0.10.40
python 2.7.12+
git 2.9.3

OS: Ubuntu 16.10

Description

I'm not seeing highlights in YAML files.

Steps to Reproduce

1. I put this in a YAML file:

something:
  - someitem

# TODO: Needs fixed

2. Note that TODO doesn't highlight

Expected behavior:
I expected TODO to be highlighted in some fashion.

Actual behavior:
https://i.imgur.com/XhsmH1C.png

Reproduces how often:
100%

Versions

Atom : 1.20.0
Electron: 1.6.9
Chrome : 56.0.2924.87
Node : 7.4.0
OSX

Additional Information

I'm fairly certain that line is being detected as a comment, but not sure why the highlighting isn't firing.
https://i.imgur.com/WRPf8Mf.png

Summary

Motivation

Describe alternatives you've considered

Additional context

One thing which I miss is possibility to ignore some folders for example vendor. Sometimes there are some leftover TODO comments in 3rd party code which I can't remove.

Is it possible to ignore folders/files now?

It would be great if you could show a list of all parsed TODOs and click-jump to them (like symbols tree, etc)

Eg.

[... Code ...]

// TODO: Blahblah

[... Code ...]

Is this intentional?

(Reference from: mrodalgaard/atom-todo-show#173)

Just a thought, but perhaps each type could highlight the entire line. I've done a very hacky stylesheet-only implementation of this together using only pseudoclasses:

.syntax--todo, .syntax--fixme {
  background: rgba(0,255,0,.05);
  display: inline-block;
  position: relative;
  color:  rgba(0,255,0,.5);
  font-weight: bold;
  &:before, &:after {
    position: absolute;
    display: block;
    content: '';
    top: 0;
    z-index: 999;
    height: 100%;
    width: 1024px;
    background: inherit;
    pointer-events: none;
    z-index: 9999;
  }
  &:before {
    right: 100%;
    content: '';
    text-align: right;
  }
  &:after {
    left: 100%;
  }
}

.syntax--fixme {
  color: rgba(255,0,0,1);
  background: rgba(255,0,0,.1);
}

Ends up looking like this:

This is, of course, an enhancement, and not a bug :)

I am developing a new grammar for Julia files.

I have the following in my grammars/julia.cson:

  comments:
    patterns: [
      {
        begin: "#="
        beginCaptures:
          "0":
            name: "punctuation.definition.comment.begin.julia"
        end: "=#"
        endCaptures:
          "0":
            name: "punctuation.definition.comment.end.julia"
        name: "comment.block.number-sign-equals.julia"
      }
      {
        captures:
          "1":
            name: "punctuation.definition.comment.julia"
        match: "(?<!\\$)(#)(?!\\{).*$\\n?"
        name: "comment.line.number-sign.julia"
      }
    ]

and I am including the #comments repository. (so single line comments start with #)

I know that this scope is being captured properly, by the following screen shot:

but for some reason I can't get the storage.type.class.todo scope to appear.

I am pretty sure I have the language-todo package installed properly because if I just copy/paste this comment line into a python file and then check the scope at the same cursor position I get the following:

Am I doing something wrong here? Thanks for entertaining!

DEBUG is pretty common and should be added

Prerequisites

• I have done all of the following:
  • Reproduced in safe-mode
  • Checked that my issue isn't already filed:

Description

I guess the title says all, you can use the test comments below to check if this is the case for you

# FIXME: Python, Shell Script, Ruby don't work but CoffeScript and YAML do

// FIXME: C and C++ don't work but C# and Java do

; FIXME: Clojure works

/*  */  FIXME: CSS highlights all of this 
/* FIXME: This is highlighted as expected in CSS*/


<!--  FIXME: Html doesn't work, but Markdown does -->

Steps to Reproduce

1. Open file
2. Set language
3. Write special comment in language

Expected behavior: [What you expect to happen]

Comments starting with TODO, FIXME, BUG, etc. should be highlighted

Actual behavior: [What actually happens]

In some languages highlighting fails

Reproduces how often: [What percentage of the time does it reproduce?]

Consistently

Versions

OS: macOS Sierra

Atom : 1.32.2
Electron: 2.0.9
Chrome : 61.0.3163.100
Node : 8.9.3

apm 2.1.2
npm 6.2.0
node 8.9.3 x64
atom 1.32.2
python 2.7.15
git 2.14.3

This is missing the ability to "show TODO's" and then open up a separate HTML page with the results in it.

That should be easy to add, right? Since atom is chromium based?

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Reproduced the problem in Safe Mode: http://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode
  • Followed all applicable steps in the debugging guide: http://flight-manual.atom.io/hacking-atom/sections/debugging/
  • Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq
  • Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom
  • Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages

Description

TODO/REVIEW aren't highlighted since Atom 1.32 anymore.

Steps to Reproduce

1. Update to Atom 1.32
2. Tested on One Dark theme

Expected behavior: TODO/REVIEW highlighted

Actual behavior: TODO/REVIEW not highlighted

Reproduces how often: Always

Versions

1.32.0

Additional Information

Any additional information, configuration or data that might be necessary to reproduce the issue.

In JS files, I get the keywords highlighted no matter what. However, in typescript this doesn't happen for single line comments.

  /**
   *   TODO will be highlighted
   */

  // TODO won't be highlighted

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Reproduced the problem in Safe Mode: https://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode
  • Followed all applicable steps in the debugging guide: https://flight-manual.atom.io/hacking-atom/sections/debugging/
  • Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq
  • Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom
  • Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages

Description

TODO, FIXME and the like are not highlight in JS files.

Steps to Reproduce

1. Open a .js file
2. Add a TODO (ex: // TODO: add element)

Expected behavior:

"TODO" should be highlighted

Actual behavior:

"TODO" remains the comment color gray.

Reproduces how often:

100% of the time

Versions

OS X 10.14.6
Atom 1.39.1

Additional Information

• Works fine in other file types like PHP, HTML, and CSS/SCSS

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Reproduced the problem in Safe Mode: http://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode
  • Followed all applicable steps in the debugging guide: http://flight-manual.atom.io/hacking-atom/sections/debugging/
  • Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq
  • Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom
  • Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages

Description

Looks like it is just a typo in the TEMP .text.html.php snippet.

Steps to Reproduce

1. Open a php file
2. try to use the temp snippet outside of php tags

Expected behavior: <?php // TEMP: ?>

Actual behavior: <?php // COMBAK: ?>

Reproduces how often: 100%

Versions

Atom : 1.21.1
Electron: 1.6.15
Chrome : 56.0.2924.87
Node : 7.4.0
apm 1.18.5

npm 3.10.10
node 6.9.5 x64
python 2.7.10
git 2.14.1

OS X El Capitan 10.11.6

You have the core package "language-todo" installed as a community package. See https://github.com/atom/atom/blob/master/packages/dalek/README.md for how this causes problems and instructions on how to correct the situation.

<unknown> (<embedded>:11:177147)
Generator.next (null:null:null)
step (<embedded>:11:176983)
<unknown> (null:null:null)
process._tickCallback (internal/process/next_tick.js:188:7)

Sorry for the newbie question but I didn't foudn the keybindings.
Maybe be a option to put into readme?

Thanks in advance.

Is it possible to specify different colors for specific keywords? I know how to change the keywords, though I am unsure where it's grabbing the colors from and how I would give certain ones certain colors.

I do have my own syntax theme, and already have colors set up for them, if that helps point me in the right direction.

Thanks in advance.

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Reproduced the problem in Safe Mode: http://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode
  • Followed all applicable steps in the debugging guide: http://flight-manual.atom.io/hacking-atom/sections/debugging/
  • Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq
  • Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom
  • Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages

Description

Highlighting has stopped working in JavaScript and Python files

Steps to Reproduce

1. Open a JavaScript/Python file or an unsaved new file and set the language to JavaScript/Python
2. Type TODO in a comment

Expected behavior: TODO is highlighted, is in its own <span> with class syntax--storage

Actual behavior: TODO is grey/the same colour as the rest of the comment, is in the same <span> as the rest of the comment without class syntax--storage

Versions

Atom: 1.29.0
Electron: 2.0.5
Chrome: 61.0.3163.100
Node: 8.9.3

Additional information

Highlighting still works for C#

highlight of // NOTE is not working when no indentation in html file

env: Ubuntu, Atom v1.10.2, atom UI: Atom Dark, atom Theme: Atom Dark

Demo:

sample.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title></title>
    <script type="text/javascript">
    var foo = 'bar';
// NOTE
  // NOTE
    // NOTE
      // NOTE
        // NOTE
    </script>
  </head>
</html>

<script type="text/javascript">
var foo = 'bar';
// NOTE
  // NOTE
    // NOTE
</script>

Hi,

I'm a developer of the Sublime C Improved package and I'm thinking about to port it also to Atom and VS Code. Recently I was asked to add an ad-hoc highlighting of TODO, FIXME, etc. task tags within the syntax definition, since ST doesn't support injectionSelector, which powers the language-todo package and its TM ancestor. I aim to keep the syntax compatible with existing solutions as much as possible, and that's how I came across this package.

However, I'm confused about the support.type.class choice for the task tags. The thing is, I'd like to make a PR for a color scheme customizing highlighting of TODO, FIXME, etc. task tags, and I'm stuck for specifying the right scope selector for that.
Obviously I can't just match support.type.class because it also covers valid source tokens like class or struct.
Should it be (comment | text.plain) support.type.class then? And what if the list of injection scopes gets expanded like proposed in #36?

Basically, what is the rationale behind choosing this particular scope for task tags? Am I missing something or it is likely just a legacy scope retained for backward compatibility? If so, what's about attaching additional more specific scopes for task tags?

I'd like to override the lowercase todo's that are now cropping up all over.

The thing I really, really like about uppercase is that it is a very explicit declaration. You don't generally type TODO like that by accident.

I am getting false-positives in a lot of places.

How difficult would it be to allow building the language regex from settings? Thoughts?

Will this package ever get the ability to add custom syntax for todo etc? E.g. @todo ?

For the life of me I can't figure out how to do this, or I would've submitted a PR.

I'm trying to get @todo to highlight (including the @ prefix). I've been able to make it lower case and get that working, (just experimenting and verifying I'm modifying the right package), but I can't get the @ symbol to higlight.

I think this is a common use case for JSDoc and makes it more official.

Any pointers for how to accomplish that?

Does language-todo support modifying its regex in config.cson to match new words? If it does, can you show how that entry would look like if I'd like to include all existing keywords + e.g. MYWORD keyword? Thanks.

P.S. This is related to: mrodalgaard/atom-todo-show#199 (comment)

For example, below are todo-show config.cson entries:

  "todo-show":
    findTheseTodos: [
      "TODO"
      "FIXME"
      "CHANGED"
      "XXX"
      "IDEA"
      "HACK"
      "NOTE"
      "REVIEW"
      "NB"
      "BUG"
      "QUESTION"
      "COMBAK"
      "TEMP"
      "COMEBACK"
    ]
    findUsingRegex: "/# \\b(${TODOS})[:;.,]?\\d*($|\\s.*$|[\\{\\[\\(].+$)/g"

OS: Win 10 64bit Home Prem
Atom: 1.23.2 x64

test.sh:

#!/bin/bash
echo something
# TODO something <- this todo won't get highlighted

Highlighting works in other files, but not coffee-script (files ending in .coffee).
Is this by-design?