Skip to content

Commit bd0215b

Browse files
kkoomenkkoomen
authored
Merge pull request #632 from kkoomen/feature/html-parser
[Feature] Support HTML, SvelteJS and VueJS
2 parents 0ba8ed3 + af4c73e commit bd0215b

File tree

15 files changed

+315
-246
lines changed

15 files changed

+315
-246
lines changed

‎README.md‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -74,24 +74,24 @@ Is your favorite language not supported?
7474
Is your favorite doc standard not supported?
7575
[Suggest a new doc standard][suggest-doc-standard] :tada:
7676

77-
| | Language | Doc standards |
78-
| :----------------- | :--------------------------------------------- | :--------------------------------------------------------------------------- |
79-
| :white_check_mark: | Python | [reST][py-rest], [Numpy][py-numpy], [Google][py-google], [Sphinx][py-sphinx] |
80-
| :white_check_mark: | PHP | [phpdoc][phpdoc] |
81-
| :white_check_mark: | JavaScript (Including: ES6, FlowJS and NodeJS) | [JSDoc][jsdoc] |
82-
| :white_check_mark: | TypeScript | [JSDoc][jsdoc] |
83-
| :white_check_mark: | Svelte | [JSDoc][jsdoc] |
84-
| :white_check_mark: | Lua | [LDoc][ldoc] |
85-
| :white_check_mark: | Java | [JavaDoc][javadoc] |
86-
| :white_check_mark: | Groovy | [JavaDoc][javadoc] |
87-
| :white_check_mark: | Ruby | [YARD][yard] |
88-
| :white_check_mark: | C++ | [Doxygen][doxygen] |
89-
| :white_check_mark: | C | [Doxygen][doxygen], [KernelDoc][kerneldoc] |
90-
| :white_check_mark: | C# | [XMLDoc][xmldoc] |
91-
| :white_check_mark: | Bash | [Google][sh-google] |
92-
| :white_check_mark: | Rust | [RustDoc][rustdoc] |
93-
| :white_check_mark: | R | [Roxygen2][roxygen2] |
94-
| :white_check_mark: | Scala | [ScalaDoc][scaladoc] |
77+
| | Language | Doc standards |
78+
| :----------------- | :----------------------------------------------------- | :--------------------------------------------------------------------------- |
79+
| :white_check_mark: | Python | [reST][py-rest], [Numpy][py-numpy], [Google][py-google], [Sphinx][py-sphinx] |
80+
| :white_check_mark: | PHP | [phpdoc][phpdoc] |
81+
| :white_check_mark: | JavaScript (Vanilla, ES6, FlowJS, NodeJS, Svelte, Vue) | [JSDoc][jsdoc] |
82+
| :white_check_mark: | TypeScript | [JSDoc][jsdoc] |
83+
| :white_check_mark: | HTML (through inline `<script>` tags) | [JSDoc][jsdoc] |
84+
| :white_check_mark: | Lua | [LDoc][ldoc] |
85+
| :white_check_mark: | Java | [JavaDoc][javadoc] |
86+
| :white_check_mark: | Groovy | [JavaDoc][javadoc] |
87+
| :white_check_mark: | Ruby | [YARD][yard] |
88+
| :white_check_mark: | C++ | [Doxygen][doxygen] |
89+
| :white_check_mark: | C | [Doxygen][doxygen], [KernelDoc][kerneldoc] |
90+
| :white_check_mark: | C# | [XMLDoc][xmldoc] |
91+
| :white_check_mark: | Bash | [Google][sh-google] |
92+
| :white_check_mark: | Rust | [RustDoc][rustdoc] |
93+
| :white_check_mark: | R | [Roxygen2][roxygen2] |
94+
| :white_check_mark: | Scala | [ScalaDoc][scaladoc] |
9595

9696
# Getting started
9797

@@ -165,7 +165,7 @@ Here is the full list of available doc standards per filetype:
165165
| `g:doge_doc_standard_python` | `'reST'` | `'reST'`, `'numpy'`, `'google'`, `'sphinx'` |
166166
| `g:doge_doc_standard_php` | `'phpdoc'` | `'phpdoc'` |
167167
| `g:doge_doc_standard_javascript` | `'jsdoc'` | `'jsdoc'` |
168-
| `g:doge_doc_standard_svelte` | `'jsdoc'` | `'jsdoc'` |
168+
| `g:doge_doc_standard_html` | `'jsdoc'` | `'jsdoc'` |
169169
| `g:doge_doc_standard_lua` | `'ldoc'` | `'ldoc'` |
170170
| `g:doge_doc_standard_java` | `'javadoc'` | `'javadoc'` |
171171
| `g:doge_doc_standard_groovy` | `'javadoc'` | `'javadoc'` |
@@ -221,6 +221,7 @@ Default:
221221
'typescript',
222222
'typescript.tsx',
223223
],
224+
'html': ['svelte', 'vue'],
224225
'java': ['groovy'],
225226
}
226227
```
@@ -233,11 +234,11 @@ Example:
233234

234235
```vim
235236
let g:doge_filetype_aliases = {
236-
\ 'javascript': ['vue']
237+
\ 'javascript': ['typescript']
237238
\}
238239
```
239240

240-
If you use the above settings and you open `myfile.vue` then it will behave like
241+
If you use the above settings and you open `myfile.ts` then it will behave like
241242
you're opening a JavaScript filetype.
242243

243244
### `g:doge_buffer_mappings`

‎ftplugin/html.vim‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
let s:save_cpo = &cpoptions
2+
set cpoptions&vim
3+
4+
" The HTML filetype also gets triggerred for PHP files (and perhaps others).
5+
if &filetype !=? 'html'
6+
finish
7+
endif
8+
9+
let b:doge_parser = 'html'
10+
let b:doge_insert = 'above'
11+
12+
let b:doge_supported_doc_standards = ['jsdoc']
13+
let b:doge_doc_standard = doge#buffer#get_doc_standard('html')
14+
15+
let &cpoptions = s:save_cpo
16+
unlet s:save_cpo

‎ftplugin/svelte.vim‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)