update_lint_rules: Update .textlintrc

In uribo/textlintr: Natural Language Linter Tools for 'R Markdown' and R Code

Update .textlintrc

Description

Update the rule file (.texlintrc) which textlint checks. To adopt the rule of the character string specified as argument. When NULL is given, all installed rules are applied.

Usage

update_lint_rules(
  rules = NULL,
  lintrc = ".textlintrc",
  overwrite = FALSE,
  .node_module_path = NULL
)

Arguments

rules	the name of rule; see rule_sets() and https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule.
lintrc	file path to .textlintrc. Default, searcing from current directory.
overwrite	logical. If set TRUE, existing rules will be overwritten by the input rules.
.node_module_path	By default, it refers to the global path and local directory. If an arbitrary path is given, it refers to that path.

Examples

## Not run: 
# Register all installed rules
update_lint_rules()
# Added a rule
update_lint_rules(rules = "common-misspellings", overwrite = FALSE)
# Overwrite rules
update_lint_rules(rules = "common-misspellings", overwrite = TRUE)

## End(Not run)

uribo/textlintr documentation built on Oct. 22, 2022, 4:10 a.m.