Can't uncomment HTML in JSX files

Question

Can't uncomment HTML in JSX files

kkoomen opened this issue 5 years ago · comments

No matter which keystroke I use, I can't uncomment HTML in JSX files.

Tom Link · Answer 1 · Sat Mar 16 2019 12:29:17 GMT+0800 (China Standard Time)

Could you please tell me, at each step, the result of :call tcomment#debug#CollectInfo() at the beginning of the line in question. Thanks.

Kim 金可明 · Answer 2 · Sat Mar 16 2019 20:21:42 GMT+0800 (China Standard Time)

| = cursor

Scenario

import React, { Component } from 'react';

class Test extends Component {
  render() {
    return (
      |<div className="Test" />
    );
  }
}

export default Test;

Debug

TCOMMENT: &ft = javascript.jsx
TCOMMENT: ft  = javascript.jsx
TCOMMENT: stx = jsx
TCOMMENT: ct  = {'commentstring': '{/* %s */}', 'mode': '', 'filetype': 'jsx'}

Scenario (pressed gcc)

import React, { Component } from 'react';

class Test extends Component {
  render() {
    return (
      |{/* <div className="Test" /> */}
    );
  }
}

export default Test;

Debug


TCOMMENT: &ft = javascript.jsx
TCOMMENT: ft  = javascript.jsx
TCOMMENT: stx = javascriptObjectBraces
TCOMMENT: ct  = {'rxmid': '', 'rxend': '', 'commentstring': '// %s', 'commentstring_rx': '\%%(// %s\|/* %s */\)', 'mode': '', 'filetype': 'javascript', 'replacements': {'*/': {'subst': '|)}>#', 'guard_rx': '^\s*/\?\*'}, '/*': {'subst': '#<{(|', 'guard_rx': '^\s*/\?\*'}}, 'rxbeg': '\*\+'}

I think this should already give you enough information.

Tom Link · Answer 3 · Sun Mar 17 2019 13:37:05 GMT+0800 (China Standard Time)

So the braces are recognized as javascript braces which is why it uses the wrong comment definition. This is a weird special case. I don't know yet how, if at all, tcomment should handle this. IMHO it would be better to adapt the jsx syntax definition to highlight {/* ... */} as comment but I don't know jsx and I cannot tell if this would make sense.

Tom Link · Answer 4 · Sun Mar 17 2019 21:31:40 GMT+0800 (China Standard Time)

BTW what software did you use to create the screencast?

Kim 金可明 · Answer 5 · Mon Mar 18 2019 02:33:38 GMT+0800 (China Standard Time)

@tomtom It does makes sense, but here's the thing: JSX should use {/* ... /*} only when the cursor is in or surrounded by HTML. When the cursor is at a location which is just javascript, it should just the // plain javascript syntax. Will you fix this? Because you closed this issue without reason.

I used Kap to record a part of the screen.

Tom Link · Answer 6 · Mon Mar 18 2019 03:05:49 GMT+0800 (China Standard Time)

I closed the issue because the latest commit should fix the uncommenting issue, doesn't it. It's beyond the scope of tcomment to check the context (previous syntax name) of a syntax. This should be done in the syntax vim file that should assign a different syntax name to braces within html comments. vim's syntax definitions provide a way to define hierachies of syntax groups (i.e. one group following another), tcomment does not.

Kim 金可明 · Answer 7 · Mon Mar 18 2019 17:16:30 GMT+0800 (China Standard Time)

@tomtom I pulled from master and this is indeed fixed. Thanks!

Alexander Tesfamichael · Answer 8 · Thu Mar 21 2019 18:46:24 GMT+0800 (China Standard Time)

@tomtom thanks for another improvement!
This has been bugging me since you last made the improvements that made commenting work well (thanks!), which sadly revealed the uncommenting to still be troublesome. I felt guilty continuously asking for improvements, when you'd already been responsive and helpful, and decided to wait until it bugged me enough to open a PR. I see it's already picked up! Thanks for that!

Sadly, this doesn't seem to be working for me. Can we reopen?
Version is 46d8351, which is master as of right now.
Keystrokes are: gcc gcc g<c g<c
Debug info for each step, starting with the state before any commenting is:

TCOMMENT: &ft = javascript.jsx
TCOMMENT: ft  = javascript.jsx
TCOMMENT: stx = jsx
TCOMMENT: ct  = {'commentstring': '{/* %s */}', 'commentstring_rx': '\%%(// %s\|{/* %s */}\)', 'mode': '', 'filetype': 'jsx'}

TCOMMENT: &ft = javascript.jsx
TCOMMENT: ft  = javascript.jsx
TCOMMENT: stx = javascriptBraces
TCOMMENT: ct  = {'rxmid': '', 'rxend': '', 'commentstring': '// %s', 'commentstring_rx': '\%%(// %s\|/* %s */\)', 'mode': '', 'filetype': 'javascript', 'replacements': {'*/': {'subst': '|)}>#', 'guard_rx': '^\s*/\?\*'}, '/*': {'subst': '#<{(|', 'guard_rx': '^\s*/\?\*'}}, 'rxbeg': '\*\+'}


TCOMMENT: &ft = javascript.jsx
TCOMMENT: ft  = javascript.jsx
TCOMMENT: stx = jsxRegion
TCOMMENT: ct  = {'commentstring': '{/* %s */}', 'commentstring_rx': '\%%(// %s\|{/* %s */}\)', 'mode': '', 'filetype': 'jsx'}

Same for tsx files.

Let me know if I can be of any more help!

Alexander Tesfamichael · Answer 9 · Thu Mar 21 2019 18:47:17 GMT+0800 (China Standard Time)

@kkoomen this Kap thing is neat by the way. If I can ever offer you a hot thank you beverage of choice let me know!

Kim 金可明 · Answer 10 · Fri Mar 22 2019 04:22:15 GMT+0800 (China Standard Time)

@alextes I am on 46d8351 as well now and this is what I have ^ -- which works as expected, so re-opening is not needed I suppose. Do you have neovim?

Alexander Tesfamichael · Answer 11 · Fri Mar 22 2019 20:43:17 GMT+0800 (China Standard Time)

@kkoomen yup, neovim, I'll try and rule out plugins.

Alexander Tesfamichael · Answer 12 · Fri Mar 22 2019 20:53:21 GMT+0800 (China Standard Time)

othree/yajs.vim and mxw/vim-jsx together break this. Thanks for the hint kkoomen. I'll see if I can solve it. Mind telling me what you use for JSX highlighting in the meantime?

Tom Link · Answer 13 · Fri Mar 22 2019 21:12:03 GMT+0800 (China Standard Time)

Are you certain, you use the HEAD version from github?

Alexander Tesfamichael · Answer 14 · Sat Mar 23 2019 07:41:36 GMT+0800 (China Standard Time)

Yup, certain @tomtom , but a friendly person already pointed out it's plugins interfering. To be specific ohtree/yajs.vim doesn't assign a jsx syntax group but a JS one. I'll link the issue when I get around to creating it.

Kim 金可明 · Answer 15 · Sat Mar 23 2019 21:34:54 GMT+0800 (China Standard Time)

@alextes I had some issues once using vim-jsx before, but they seem to be solved.

I am using vim-polyglot these days which supports a massive amount of languages to get a good syntax highlighting. It is an up-to-date repository. I do recommend to use this rather then scraping your own packages of the internet ;)

Andrés Cuellar · Answer 16 · Sat Sep 19 2020 13:35:58 GMT+0800 (China Standard Time)

Recently I've come across the same issue. Except that I've tried pretty much every jsx syntax plugin and it still gives me the behavior described by OP. Using vim-polyglot doesn't work either. If this is an issue with the jsx syntax plugins and not related to tcomment please let me know and I'll open an issue in the correct repo. I'll post the result of tcomment#debug#CollectInfo() when trying to uncomment JSX if it's of any help. I'm using a .js file, but the behavior using .jsx / .tsx is the same.

TCOMMENT: &ft = javascript => javascript
TCOMMENT: stx = jsxElement => jsxElement
TCOMMENT: ct  = {'rxmid': '', 'rxend': '', 'commentstring': '// %s', 'commentstring_rx': '\%%(// %s\|/* %s */\)', 'mode': '', 'filetype': 'javascript', 'replacements': {'*/': {'subst': '|)}>#', 'guard_rx': '^\s*/\?\*'}, '/*': {'subst': '#<{(|', 'guard_rx': '^\s*/\?\*'}}, 'rxbeg': '\*\+'}

Tom Link · Answer 17 · Fri Oct 09 2020 18:54:05 GMT+0800 (China Standard Time)

I'm sorry but I cannot follow the thread that closely. Could you please describe exactly what you're trying to achieve. JSX files seem to work fine with the default vim plugins. But I don't do jsx and I need some help to find out what's going wrong.

It would also help if you installed tlib and the run Tlibtraceset --file=tcomment.log +tcommentas described in :help tcomment-debug.

Andrés Cuellar · Answer 18 · Wed Oct 14 2020 06:14:36 GMT+0800 (China Standard Time)

@tomtom It's the same issue with uncommenting discussed earlier (gif originally by alextes):

Here's the output of running Tlibtraceset --file=tcomment.log +tcomment: https://pastebin.com/pQd00zqV

As of jsx-plugins I'm using vim-polyglot but I've used pretty much all of jsx plugins available right now and the issue still persists.