Skip to content
Please note that GitHub no longer supports Internet Explorer.

We recommend upgrading to the latest Microsoft Edge, Google Chrome, or Firefox.

Learn more
Flycheck integration for DrString, a Swift documentation linter
Emacs Lisp
Branch: master
Clone or download
Cannot retrieve the latest commit at this time.
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
screenshots
.gitignore Initial commit Feb 1, 2020
LICENSE
README.md
flycheck-drstring-test.el
flycheck-drstring.el

README.md

flycheck-drstring

Lint Swift documentation using DrString.

This library provides a flycheck checker for Swift source code using DrString.

Screenshot

Sample screenshot with flycheck-drstring in action

Installation

MELPA

A MELPA package is not available yet.

Manual

Ensure flycheck is installed, then download this code and add the directory to your Emacs load-path.

Then, in your init.el:

(eval-after-load 'flycheck
  '(add-hook 'flycheck-mode-hook #'flycheck-drstring-setup))

Or, if you use use-package:

(use-package flycheck-drstring
  :after flycheck
  :hook
  (flycheck-mode . flycheck-drstring-setup))

Make sure that the drstring binary is present on Emacs' exec-path.

Usage

When flycheck is enabled (e.g. with global-flycheck-mode), swift-mode buffers will be automatically checked using this checker.

This checker includes an error explainer. Invoking flycheck-explain-error-at-point will show a Help buffer with information about any particular lint warning.

You can’t perform that action at this time.