From faf6ef0414bdbf670b0e50c0d9ed7da2c3907ba3 Mon Sep 17 00:00:00 2001 From: Alex Eagle Date: Thu, 12 Oct 2023 13:14:32 -0700 Subject: [PATCH 1/2] chore: include a demo --- CONTRIBUTING.md | 13 +++++++++++++ README.md | 6 ++++-- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c28daded..989e19c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,3 +41,16 @@ This means that any usage of `@rules_eslint` on your system will point to this f 1. Determine the next release version, following semver (could automate in the future from changelog) 1. Tag the repo and push it (or create a tag in GH UI) 1. Watch the automation run on GitHub actions + +## Recording a demo +Install from https://asciinema.org/ +Then cd example and start recording, pasting these commands: + +figlet "Linting with Bazel can be nice!" +figlet "The BUILD file is clean" +cat src/BUILD.bazel +figlet "We can run lint.sh on the targets" +./lint.sh src:all +figlet "it linted proto, python, and JS!" +figlet "' lint ' command with an Aspect CLI plugin ->" +bazel lint src:all diff --git a/README.md b/README.md index 0e884097..f1165bdb 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,11 @@ Features: How developers use it: -1. (preferred) This ruleset provides an Aspect CLI plugin, +1. Run with vanilla Bazel, by placing a couple commands in a shell script, Makefile, or similar wrapper. +2. (preferred) This ruleset provides an Aspect CLI plugin, so it can register the missing 'lint' command and users just type `bazel lint //path/to:targets`. -2. Run with vanilla Bazel, by placing a couple commands in a shell script, Makefile, or similar wrapper. + +[![asciicast](https://asciinema.org/a/prVnsvrEN3Vpvm5Wf7QVq7Ytt.svg)](https://asciinema.org/a/prVnsvrEN3Vpvm5Wf7QVq7Ytt?t=41) This project is inspired by the design for [Tricorder]. This is how Googlers get their static analysis results in code review (Critique). From b35c8cdfad46597d38d273e95087df8c23312fed Mon Sep 17 00:00:00 2001 From: Alex Eagle Date: Thu, 12 Oct 2023 14:21:50 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f1165bdb..6deb92c8 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,11 @@ Features: How developers use it: -1. Run with vanilla Bazel, by placing a couple commands in a shell script, Makefile, or similar wrapper. -2. (preferred) This ruleset provides an Aspect CLI plugin, +1. (preferred) This ruleset provides an Aspect CLI plugin, so it can register the missing 'lint' command and users just type `bazel lint //path/to:targets`. +2. Run with vanilla Bazel, by placing a couple commands in a shell script, Makefile, or similar wrapper. + +See it in action: [![asciicast](https://asciinema.org/a/prVnsvrEN3Vpvm5Wf7QVq7Ytt.svg)](https://asciinema.org/a/prVnsvrEN3Vpvm5Wf7QVq7Ytt?t=41)