fish-plugin

March 5, 2021 · View on GitHub

🐟 This is a template for fish plugin projects.

Installation

Install with Fisher:

🐟 Replace the repo name with your own:

fisher install andreiborisov/fish-plugin

🐟 The plugin does nothing yet. Use this repo as a GitHub template or clone it manually:

git clone git@github.com:andreiborisov/fish-plugin.git

🐟 Check out Fishtape to learn how to write tests.

Tests run automatically using GitHub Actions.

To run them locally make sure you have Docker installed and start the Docker Compose configuration:

docker-compose -f docker-compose.test.yml up

This will run tests on each minor fish version starting from 3.0.

Clean up intermediate containers after that with:

docker-compose -f docker-compose.test.yml down --rmi all

🐟 Don't forget to update the copyright notice in the LICENSE file: