linter-ibmstyleguide
Linter plugin providing ibmstyleguide advice.
Gaurav Nelson 414 1 2.0.0 MIT GitHub

Services

This package provides:

Dependencies

  • vfile@>=2.0.1
  • retext@>=5.0.0
  • unified@>=6.1.2
  • minimatch@>=3.0.3
  • quotation@>=1.1.0
  • vfile-sort@>=2.0.0
  • object-keys@>=1.0.9
  • nlcst-search@>=1.4.0
  • retext-english@>=3.0.0
  • vfile-reporter@>=3.0.0
  • nlcst-to-string@>=2.0.0
  • atom-package-deps@>=4.5.0
  • lodash.difference@>=4.5.0
  • unist-util-position@>=3.0.0
  • retext-ibmstyleguide@>=1.0.0
  • unist-util-find-after@^2.0.0
  • unist-util-find-before@^2.0.0

Keywords

  • asciidoc
  • text
  • ibmstyleguide
  • writing
  • language
  • english
  • linter

atom-linter-ibmstyleguide

An Atom package for the retext-ibmstyleguide module. It uses the Atom Linter package to highlight errors and provide usage advice while writing and editing documents in Atom.

Dependencies

Features (v 2.0.0)

  • Highlights incorrect words as you type marked as 'Use it: no' and 'Use it: with caution'.
  • Option to ignore words by adding them to 'Ignore Words' list in settings.
  • Options to enable or disable product specific conventions.
  • Move mouse over an incorrect word to read description and correct word usage.
  • Works for ASCIIDOC, DOCXML, MARKDOWN files and can be configured to work with other filetypes as well.

Configuration Options

  • Show errors as you type: This behavior can be changed by unchecking Lint on Change checkbox for the Atom Linter package settings. The errors will then only be highlighted when you save the file.
  • Set severity: The default level is Warning. Setting the severity level to Error or Info helps distinguish its highlighting from the highlighting of an ordinary spell checker, or higher priority linter.
  • Ignore Files: Add filenames for which you do not want this package to show errors.
  • Ignore Words: Add comma-seperated list of words for which you do not want to see errors.
  • Enable or Disable product specifc conventions: Select all the produts for which you want to show product specific errors.
  • Enable for other filetypes: Enable it for other filetypes by adding the scope name for a grammar. For example, add source.gfm to enable this package for Markdown files.