Commit 6e5bc2a

authored

Merge pull request #125 from Hwlhwlxyz/patch-windows

add windows support, and update the README.md

2 parents 9234b2e + c8d22b1 commit 6e5bc2aCopy full SHA for 6e5bc2a

File tree

+23

-6

lines changed

+23

-6

lines changed

Lines changed: 10 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -67,14 +67,23 @@ make clean`
`67`	`67`	`make install`
`68`	`68`	```
`69`	`69`
`70`		`-If you want install lehre manually, you can install from npm.`
	`70`	`+If you want to install lehre manually, you can install from npm.`
`71`	`71`
`72`	`72`	```console
`73`	`73`	`$ yarn add -D lehre`
`74`	`74`	```
`75`	`75`
`76`	`76`	Set installed `/path/to/node_modules/.bin/lehre` path to `g:jsdoc_lehre_path`.
`77`	`77`
	`78`	`+#### Installing on Windows`
	`79`	`+`
	`80`	+```console
	`81`	`+# cd to <vim-jsdoc path>/lib`
	`82`	`+npm install`
	`83`	+```
	`84`	`+`
	`85`	+If you want to set the path of [lehre](https://www.npmjs.com/package/lehre) manually on Windows, you should use the path with the file extension `.cmd`, such as `/path/to/node_modules/.bin/lehre.cmd`.
	`86`	`+`
`78`	`87`	`## Usage`
`79`	`88`
`80`	`89`	1. Move cursor on `function` keyword line

Lines changed: 13 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,11 +9,19 @@ set cpo&vim`
`9`	`9`
`10`	`10`	`let g:jsdoc_templates_path = get(g:, 'jsdoc_templates_path', '')`
`11`	`11`	`let g:jsdoc_formatter = get(g:, 'jsdoc_formatter', 'jsdoc')`
`12`		`-let g:jsdoc_lehre_path = get(`
`13`		`- \ g:,`
`14`		`- \ 'jsdoc_lehre_path',`
`15`		`- \ printf('%s/lib/lehre', expand('<sfile>:p:h:h'))`
`16`		`- \ )`
	`12`	`+if has("win64") \|\| has("win32") \|\| has("win16")`
	`13`	`+ let g:jsdoc_lehre_path = get(`
	`14`	`+ \ g:,`
	`15`	`+ \ 'jsdoc_lehre_path',`
	`16`	`+ \ printf('%s/lib/node_modules/.bin/lehre.cmd', expand('<sfile>:p:h:h'))`
	`17`	`+ \ )`
	`18`	`+else`
	`19`	`+ let g:jsdoc_lehre_path = get(`
	`20`	`+ \ g:,`
	`21`	`+ \ 'jsdoc_lehre_path',`
	`22`	`+ \ printf('%s/lib/lehre', expand('<sfile>:p:h:h'))`
	`23`	`+ \ )`
	`24`	`+endif`
`17`	`25`
`18`	`26`	`let s:is_method_regex = '^.\{-}\s$[a-zA-Z_$][a-zA-Z0-9_$]$\s(\s$[^)]$\s).*$'`
`19`	`27`	`let s:is_declarelation = '^.\{-}=\s$\([a-zA-Z_$][a-zA-Z0-9_$]$\s(\s$[^)]$\s)\\|(\s$[^)]$\s\).$'`

Comments

(0)