Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BREAKING CHANGES #82

Open
JoosepAlviste opened this issue Nov 18, 2023 · 5 comments
Open

BREAKING CHANGES #82

JoosepAlviste opened this issue Nov 18, 2023 · 5 comments

Comments

@JoosepAlviste
Copy link
Owner

JoosepAlviste commented Nov 18, 2023

The comments of this issue will include all breaking changes together with migration guides.

Please open a separate issue if there are any issues following the migration guides. I'd like to keep this thread clean so that it would be easy to find information for everyone.

@JoosepAlviste JoosepAlviste pinned this issue Nov 18, 2023
@JoosepAlviste
Copy link
Owner Author

JoosepAlviste commented Nov 18, 2023

The minimum Neovim version for this plugin is now version 0.9: 34ff1fa

Migration guide

Update to Neovim version 0.9

@JoosepAlviste
Copy link
Owner Author

JoosepAlviste commented Nov 18, 2023

Usage as a nvim-treesitter module has been deprecated: #80. Configuration as a nvim-treesitter module configuration will still work, but you should see a message notifying you of the deprecation. It will be removed some time in the future (unsure when, probably in a couple months).

The plugin is set up automatically now.

This also increases the minimal Neovim version to 0.9.4.

Migration guide

Upgrade your Neovim version to at least 0.9.4.

If you're using the default configuration, then just delete the nvim-treesitter module configuration:

Before:

require('nvim-treesitter.configs').setup {
  context_commentstring = {
    enable = true,
  },
}

After:

require('nvim-treesitter.configs').setup {}
-- nvim-ts-context-commentstring is set up automatically

If you're using any custom configuration, then use require('ts_context_commentstring').setup:

Before:

require('nvim-treesitter.configs').setup {
  context_commentstring = {
    enable = true,
    enable_autocmd = false,
    -- or "config" if you're still using the old configuration key
    languages = {
      typescript = '// %s',
    },
  },
}

After:

require('ts_context_commentstring').setup {
  enable_autocmd = false,
  languages = {
    typescript = '// %s',
  },
}

@marcelarie

This comment was marked as resolved.

@JoosepAlviste

This comment was marked as resolved.

yogan added a commit to yogan/dotfiles that referenced this issue Nov 22, 2023
@marcelarie

This comment was marked as resolved.

kevinmcgill added a commit to kevinmcgill/nvim that referenced this issue Nov 30, 2023
This also includes removing `enable_autocmd = false`, we can restore
this later if needed. See migration guide JoosepAlviste/nvim-ts-context-commentstring#82 (comment)
jondoveston added a commit to jondoveston/neovim-config that referenced this issue Dec 2, 2023
fnichol added a commit to fnichol/dotneovim that referenced this issue Dec 6, 2023
Repository owner locked and limited conversation to collaborators Dec 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants