markdown-body entry-content container-lg" itemprop="text">

Arduino Hooks

This project provides pre-commit hooks for arduino command line tooling. This is an un-official project.

Currently, this includes:

arduino-lint - Linter for checking arduino projects for problems and conformance to conventions.
arduino-cli - Limited to compile calls for verifying arduino code can be compiled.

This project uses CliPy-Hooks, to handle most of the cross-platform, sub-process nastiness.

Getting Started

To configure pre-commit see their official docs for instructions.

To use any of the arduino hooks below you must have the respective executables installed and on path. If you are running in an environment where putting this on path is difficult, you may pass an --install-dir argument to define the absolute path to the arduino executable.

The hooked tools do not work with individual source files as is done with most pre-commit hooks, as these tools work against complete arduino projects. By default, the hooks will treat the root directory as the project root, as is typical in arduino repositories. In cases where this is not true, you can pass a --project-dir argument with the project root path to the hook.

Due to limitations in argparse, it is highly suggested that you pass all arguments with values using --key=value rather than --key value.

Arduino Lint

Sample .pre-commit-config.yaml:

  - repo: https://github.com/creatingnull/arduino-hooks
    rev: v0.3.0
    hooks:
      - id: arduino-lint

You can find instructions on how to install arduino-lint and pre-compiled binaries in the official docs.

For convenience this hook recognises the following arguments:

--fail-on-warn flag that will fail on any warning returned by arduino lint. Similar result to compliance=strict but even stricter.

You also may pass in supported arduino-cli arguments which will be handed through to the executable.

  - repo: https://github.com/creatingnull/arduino-hooks
    rev: v0.3.0
    hooks:
      - id: arduino-lint
      - args: [--install-dir=/opt/arduino/, --fail-on-warn, --project-dir=src/]

Arduino CLI

Sample .pre-commit-config.yaml:

  - repo: https://github.com/creatingnull/arduino-hooks
    rev: v0.3.0
    hooks:
      - id: arduino-cli
        args: [--fqbn=arduino:avr:nano]

You can find instructions on how to install arduino-cli and pre-compiled binaries in the official docs

Must provide the full qualified board name for the target microcontroller, this parameter should be passed in "" quotes due to yaml restrictions on : use. You'll also need to have previously installed the core for this target and any libs required by your project.

As a Github Action

You can add these hooks to your existing pre-commit workflow by adding a step to install the required dependencies.

See the following example step added to a ubuntu-latest pre-commit workflow:

  - name: Install Dependencies
    run: |
      curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/install.sh | sh
      curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
      bin/arduino-cli core install arduino:avr
      bin/arduino-cli lib install NullPacketComms
      echo "${PWD}/bin/" >> $GITHUB_PATH

The process followed is to:

Install arduino-cli if used
Install arduino-lint if used
Install required cores for the arduino-cli hook(s)
Install required 3rd party libs for the arduino-cli hook(s)
Put arduino tooling on path

For more information you can check out this project implementing these hooks in a github workflow.

Donations

I just do this stuff for fun in my spare time, but feel free to:

License

The source of this repo uses the MIT open-source license, for details on the current licensing see LICENSE or click the badge above.