Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

flycheck-julia — Flycheck for Julia

License GPL 3 MELPA MELPA Stable Build master

A Julia syntax checker for Emacs and Flycheck using Lint.jl

Installation

General instructions

Installing from a fresh emacs install

  • Setup your package manager

    Add the following to your init file:

    (require 'package)
    (add-to-list 'package-archives '("MELPA Stable" . "https://stable.melpa.org/packages/"))
    ;; If you want always the latest versions uncomment the following line:
    ;; (add-to-list 'package-archives '("MELPA" . "https://melpa.org/packages/"))
    (add-to-list 'package-archives '("gnu" . "https://elpa.gnu.org/packages/"))
    (package-initialize)
  • Install the required packages

    Restart emacs and run M-x list-packages or choose Options -> Manage Packages from the menu and install flycheck, ess, and flycheck-julia.

    In the *Packages* buffer you can select packages by pressing i and install all selected packages by pressing x or simply use the mouse for interaction.

  • Configure emacs for the use with julia, flycheck, and flycheck-julia

    Add the following lines at the end of your init file:

    ;; loads ess, which contains ess-julia-mode
    (require 'ess-site)
    ;; enable flycheck globally
    (add-hook 'after-init-hook #'global-flycheck-mode)
    ;; tell flycheck about the julia linter
    (flycheck-julia-setup)

Installing when using Spacemacs

  • Add the following to your .spacemacs:
    • the syntax-checking and ess layers.
    • to dotspacemacs-additional-packages add flycheck-julia
    • to the dotspacemacs/user-config function add the following lines:
      (flycheck-julia-setup)
      (add-to-list 'flycheck-global-modes 'julia-mode)
      (add-to-list 'flycheck-global-modes 'ess-julia-mode)
  • Restart Emacs, this should automatically install ess, flycheck, and flycheck-julia

Manual Installing

Copy flycheck-julia.el somewhere and add the following to your init file:

(add-to-list 'load-path "/path/to/directory/containing/flycheck-julia.el/file")
(require 'flycheck-julia)
(flycheck-julia-setup)
(add-to-list 'flycheck-global-modes 'julia-mode)
(add-to-list 'flycheck-global-modes 'ess-julia-mode)

Usage

If you configured your Emacs with the instructions above, linting of Julia files should start automatically. If you did not enable global-flycheck-mode, you can enable linting of Julia files by enabling flycheck-mode.

Interaction with errors is done through flycheck, see the manual for details.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

See LICENSE for details.