Skip to content
This repository was archived by the owner on Mar 21, 2022. It is now read-only.

Commit 0b7ca17

Browse files
committed
README: Add deprecation warning
Now that Vim and NeoVim support jsonc (with an implementation based on this plugin) there's no need to use this plugin. Warn users to avoid it. Signed-off-by: Kevin Locke <[email protected]>
1 parent 1447a9b commit 0b7ca17

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
⚠️ Deprecated ⚠️
2+
==============
3+
4+
Support for the jsonc filetype is included in Vim 8.2.3117 and later
5+
([#8500](https://github.com/vim/vim/pull/8500)) and NeoVim 0.6.0 and later
6+
([#15494](https://github.com/neovim/neovim/pull/15494)). Using the built-in
7+
jsonc filetype plugin is recommended.
8+
9+
**Note:** The built-in jsonc filetype is currently only applied to files with
10+
the .jsonc extension. To use the filetype for additional files, consider
11+
adding a [`modeline`](https://vimhelp.org/options.txt.html#modeline) comment
12+
and/or copying [`ftdetect/jsonc.vim`](ftdetect/jsonc.vim) from this plugin into
13+
[`'runtimepath'`](https://vimhelp.org/options.txt.html#%27runtimepath%27).
14+
15+
116
JSON with Comments for Vim
217
==========================
318

0 commit comments

Comments
 (0)