External Repositories

To create and share your own Trunk superpowers, you can publish a plugins repo: a Git repository which contains linter definitions that can be merged into your .trunk/trunk.yaml.
Get started
Let's walk through how to create a simple linter that warns about TODOs in your codebase.
We'll start by creating a new Git repository:
PLUGIN_PATH=~/my-first-trunk-plugin
mkdir "${PLUGIN_PATH}" && cd "${PLUGIN_PATH}"
git init
And then create a linter that can find TODOs in your codebase using grep and sed:
cat >trunk.yaml <<EOF
version: 0.1
lint:
  definitions:
    - name: todo-finder
      files: [ALL]
      commands:
        - output: parsable
          run: grep --with-filename --line-number --ignore-case todo ${target}
          success_codes: [0, 1]
          read_output_from: stdout
          parser:
            run: "sed -E 's/(.*):([0-9]+):(.*)/\\1:\\2:0: [error] Found todo in \"\\3\" (found-todo)/'"
EOF
Now we can turn this linter on in a repository where we have trunk set up:
trunk plugins add my-first-plugin "${PLUGIN_PATH}"
trunk check enable my-first-plugin.todo-finder@SYSTEM
And now, to demonstrate how this works, let's trunk check some files where we know we have TODOs:
trunk check $(git grep -li todo | head -n 10)
which will show you something like this:
.eslintrc.yaml:19:0
  19:0  high  Found todo in "  # TODO(chris): Figure out why this causes a massive slowdown ... .trunk/dev-out/O1F.txt  local.todo-finder/found-todo
 101:0  high  Found todo in "  node/no-unpublished-import: off # TODO: do we want this?"                                local.todo-finder/found-todo
Organizing your code
In the example we gave above, we put the linter's source code in trunk.yaml, which is fine for an example, but not really great for anything more than that. We can take the sed command from the plugin we created earlier and push that into the shell script:
#!/bin/bash
sed -E 's/(.*):([0-9]+):(.*)/\1:\2:0: [error] Found todo in \"\3\" (found-todo)/'"
Tip: Remember to run chmod u+x todo-finder-parser.sh so that trunk can run it!
and also point the definition of todo-finder at it:
version: 0.1
lint:
  definitions:
    - name: todo-finder
      files: [ALL]
      commands:
        - output: parsable
          run: grep --with-filename --line-number --ignore-case todo ${target}
          success_codes: [0, 1]
          read_output_from: stdout
          parser:
            run: ${plugin}/todo-finder-parser.sh
We can also go another step and push the entire linter definition into a shell script:
#!/bin/bash
grep --with-filename --line-number --ignore-case todo "${1}" | \
  sed -E 's/(.*):([0-9]+):(.*)/\1:\2:0: [error] Found todo in \"\3\" (found-todo)/'"
version: 0.1
lint:
  definitions:
    - name: todo-finder
      files: [ALL]
      commands:
        - output: parsable
          run: ${plugin}/todo-finder.sh
          success_codes: [0]
See our documentation on custom linters and custom parsers for more on what you can do, such as writing your parser in Javascript or Python!
Publishing your plugin
To share your plugin with the world, all you have to do is tag a release and push it to GitHub, Gitlab, or some other repository hosting service:
git add .
git commit "Create a TODO finder"
git tag -a v0.0.0 --message "Initial TODO finder release"
git remote add origin ${repo_url}
git push origin main v0.0.0
Now that it's available on the Internet, everyone else can just use your plugin by running:
trunk plugins add their-first-plugin ${repo_url} v0.0.0
Exported Configs
Tools
Last modified 1mo ago