Skip to content

Add support for custom rule files #114

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add support for custom rule files #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,17 @@ For example, below setting enables `PASSIVE_VOICE` rule in all filetypes.
let g:grammarous#enabled_rules = {'*' : ['PASSIVE_VOICE']}
```

### How can I pass my own rules file?

Please use `g:grammarous#custom_rules` to pass the name of a file.

For example, to set `path/to/config/data/languagetool/rules.xml` as the rulefile.

```vim
let config_path = stdpath('config')
let g:grammarous#custom_rules = config_path . '/data/languagetool/rules.xml'
```

### Some rules annoy me.

Please use `g:grammarous#disabled_rules` to disable specific rules.
Expand Down
11 changes: 11 additions & 0 deletions autoload/grammarous.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ let g:grammarous#info_win_direction = get(g:, 'grammarous#info_win_
let g:grammarous#use_fallback_highlight = get(g:, 'grammarous#use_fallback_highlight', !exists('*matchaddpos'))
let g:grammarous#enabled_rules = get(g:, 'grammarous#enabled_rules', {})
let g:grammarous#disabled_rules = get(g:, 'grammarous#disabled_rules', {'*' : ['WHITESPACE_RULE', 'EN_QUOTES']})
let g:grammarous#custom_rules = get(g:, 'grammarous#custom_rules', "")
let g:grammarous#enabled_categories = get(g:, 'grammarous#enabled_categories', {})
let g:grammarous#disabled_categories = get(g:, 'grammarous#disabled_categories', {})
let g:grammarous#default_comments_only_filetypes = get(g:, 'grammarous#default_comments_only_filetypes', {'*' : 0})
Expand Down Expand Up @@ -305,6 +306,16 @@ function! s:invoke_check(range_start, ...)
\ substitute(tmpfile, '\\\s\@!', '\\\\', 'g')
\ )

if g:grammarous#custom_rules !=# ''
let custom_rules = printf("%s", substitute(g:grammarous#custom_rules, ' ', '\\ ', 'g'))
if !filereadable(g:grammarous#custom_rules)
call grammarous#error("Custom rules file '%s' does not exist or is not readable", g:grammarous#custom_rules)
return
else
let cmdargs = '--rulefile ' . custom_rules . ' ' . cmdargs
endif
endif

let disabled_rules = get(g:grammarous#disabled_rules, &filetype, get(g:grammarous#disabled_rules, '*', []))
if !empty(disabled_rules)
let cmdargs = '-d ' . join(disabled_rules, ',') . ' ' . cmdargs
Expand Down