ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-contrib-avr-gcc

by ChisholmKyle ST3

Linter for avr-gcc

Details

Installs

  • Total 431
  • Win 197
  • OS X 94
  • Linux 140
Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3
Windows 0 0 1 0 1 1 1 0 1 0 0 0 0 1 1 1 0 0 0 0 1 0 1 1 1 2 2 1 1 2 1 0 1 1 0 1 4 0 0 0 0 1 0 1 1 0
OS X 0 0 1 0 0 1 0 0 1 0 0 0 1 0 0 1 0 0 0 0 0 0 1 0 1 1 0 0 0 0 0 0 0 0 1 0 1 0 0 0 1 0 0 0 1 1
Linux 1 0 0 1 1 0 0 1 0 0 0 0 0 0 1 1 1 0 0 0 0 1 0 1 0 0 2 0 0 1 0 0 0 1 0 0 0 0 0 0 0 0 1 0 0 0

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-contrib-avr-gcc

Build Status

This linter plugin for SublimeLinter provides an interface to avr-gcc. It will be used with files that have the “C/C++” syntax. This linter is based on SublimeLinter-contrib-clang.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that avr-gcc is installed on your system. To install avr-gcc, do the following:

Linux

  1. Install avr-gcc with your distro's package manager. On Ubuntu, for example, type the following in a terminal:

    sudo apt-get install git gcc-avr

Mac

  1. Install and update Macports
  2. Type the following in a terminal:

    sudo port install avr-gcc

Windows

  1. Download and extract the Amtel AVR Toolchain for Windows.

Linter configuration

In order for avr-gcc to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once you have installed and configured avr-gcc, you can proceed to install the SublimeLinter-contrib-avr-gcc plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type avr-gcc. Among the entries you should see SublimeLinter-contrib-avr-gcc. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

In addition to the standard SublimeLinter settings, SublimeLinter-contrib-avr-gcc provides its own settings.

Setting Description
include_dirs A list of directories to be added to the header search paths (-I is not needed).
extra_flags A string with extra flags to pass to avr-gcc. These should be used carefully, as they may cause linting to fail.
extra_cflags Extra flags to pass to avr-gcc when linting C syntax code.
extra_cxxflags Extra flags to pass to avr-gcc when linting C++ syntax code.

In project-specific settings, '${project_folder}' can be used to specify a relative path for the include_dirs or extra_flags options. Here is an example of project settings for development targeting an Arduino Mini Pro 5V with the Wire library:

"SublimeLinter":
{
    "linters":
    {
        "avrgcc": {
            "include_dirs": [
                "${project_folder}/include",
                "/Applications/Arduino.app/Contents/Java/hardware/arduino/avr/cores/arduino",
                "/Applications/Arduino.app/Contents/Java/hardware/arduino/avr/variants/eightanaloginputs",
                "/Applications/Arduino.app/Contents/Java/hardware/arduino/avr/libraries/Wire/src",
                "/Applications/Arduino.app/Contents/Java/hardware/arduino/avr/libraries/Wire/src/utility"
            ],
            "extra_flags": "-mmcu=atmega328p -DF_CPU=16000000L -DARDUINO_ARCH_AVR -DARDUINO_AVR_PRO",
            "extra_cflags": "-std=gnu99",
            "extra_cxxflags": "-std=gnu++14"
        }
    }
},

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modifications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.
  • Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!