pablomxnl / vale-cli-plugin

Plugin for JetBrains IDE's that uses Vale CLI to check markdown,asciidoc and other documentation formats

Vale CLI plugin

Plugin for JetBrains IDE’s that uses Vale CLI to check markdown,asciidoc and other documentation formats

Tip	Pet project. Not associated with Errata (Vale CLI creators) or JetBrains whatsoever

Documentation

See the plugin user documentation at the JetBrains Plugin Marketplace or at the project Gitlab Pages

Build the plugin locally

./gradlew buildPlugin

Run the plugin on an IntelliJ sandbox

./gradlew runForManualTests

This task configures the IntelliJ sandbox to not confirm exit or show tips at startup among other things. It opens a sample project with a couple of markdown files to test with the plugin.

./gradlew runIde

The standard gradle intellij plugin task that runs the IDE with the developed plugin installed.

Run tests inside container simulating a pipeline run

1. First build the builder docker image

   docker build  . -t myuser/builder

2. Get an interactive session on the builder container, mounting the project folder.

   docker run -it --rm -u gradle -v "$PWD":/home/gradle/project -w /home/gradle/project myuser/builder /bin/bash

3. Run the test gradle task

   ./gradlew test

4. Exit the container and inspect test results

   exit

   open build/reports/tests/test/index.html