From 205dce792efb8dfb381224b457d358a25f408810 Mon Sep 17 00:00:00 2001 From: Richard Macklin Date: Fri, 22 Apr 2022 23:30:26 -0700 Subject: [PATCH 1/6] Update README to only suggest installing via bundler Let's drop the `gem install` instructions because this gem isn't really useful on its own; it becomes useful inside a rails application, where we expect that dependencies will be managed using bundler. --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 543e9de..d2a4950 100644 --- a/README.md +++ b/README.md @@ -39,10 +39,6 @@ And then execute: $ bundle -Or install it yourself as: - - $ gem install external_asset_pipeline - ## Usage In `config/application.rb`, after `Bundler.require(*Rails.groups)`, add: From d54036a4c1aa909adc4dd57c58024fea6949ed26 Mon Sep 17 00:00:00 2001 From: Richard Macklin Date: Fri, 22 Apr 2022 23:30:46 -0700 Subject: [PATCH 2/6] Reword section of README that implied (only) rails 5 and 6 are supported Now that we support rails 7, we should generalize this wording. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d2a4950..eeeec4c 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ don't hesitate to check out some demo apps: - [examples/demo_app](./examples/demo_app) uses [`webpack`] to process javascript assets while `sprockets` handles other assets - [examples/demo_app-rails5](./examples/demo_app-rails5) is the same app but - using rails 5 instead of rails 6 (`external_asset_pipeline` supports both) + using rails 5 (`external_asset_pipeline` supports rails >= 5) - [examples/demo_app-brunch](./examples/demo_app-brunch) uses [`brunch`] to manage all assets without `sprockets` - [examples/demo_app-gulp](./examples/demo_app-gulp) uses [`gulp`] in addition From 10645b6db1d7c1cf04a6a6cb1d80848ed2eb9bf7 Mon Sep 17 00:00:00 2001 From: Richard Macklin Date: Fri, 22 Apr 2022 23:31:15 -0700 Subject: [PATCH 3/6] Update generated "Development" documentation in README This documentation came straight from the generated bundler gem skeleton, but now we've customized it for our gem's setup. --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eeeec4c..817085c 100644 --- a/README.md +++ b/README.md @@ -171,9 +171,13 @@ container. ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run -`rake test` to run the tests. You can also run `bin/console` for an interactive -prompt that will allow you to experiment. +After checking out the repo, run `script/bootstrap` to install dependencies. +Then, run `bundle exec rake test:integration:prepare` to set up the integration +test environment and run `script/test` to run the tests. By default, that will +exercise the `demo_app` example application. To exercise a different example +application, set the `EXAMPLE_APP` environment variable to the corresponding +directory name (e.g. `EXAMPLE_APP=demo_app-rollup`). You can also run +`bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run From bbc44312342469cdcccac3f1e206c62208ced1bd Mon Sep 17 00:00:00 2001 From: Richard Macklin Date: Fri, 22 Apr 2022 23:32:55 -0700 Subject: [PATCH 4/6] Remove `bin/setup` script This script was generated by the bundler gem skeleton. It's similar to `script/bootstrap` but it doesn't use `bundle check` to short-circuit before attempting a full `bundle install`. Let's consolidate to just the smarter `script/bootstrap`. --- bin/setup | 8 -------- 1 file changed, 8 deletions(-) delete mode 100755 bin/setup diff --git a/bin/setup b/bin/setup deleted file mode 100755 index dce67d8..0000000 --- a/bin/setup +++ /dev/null @@ -1,8 +0,0 @@ -#!/usr/bin/env bash -set -euo pipefail -IFS=$'\n\t' -set -vx - -bundle install - -# Do any other automated setup that you need to do here From 0e6476f7c91346f4b77ee01128def9214c630ef8 Mon Sep 17 00:00:00 2001 From: Richard Macklin Date: Fri, 22 Apr 2022 23:33:55 -0700 Subject: [PATCH 5/6] Move console script from `bin/` to `script/` Let's consolidate down to a single directory for our scripts. --- README.md | 2 +- {bin => script}/console | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename {bin => script}/console (100%) diff --git a/README.md b/README.md index 817085c..f131b27 100644 --- a/README.md +++ b/README.md @@ -177,7 +177,7 @@ test environment and run `script/test` to run the tests. By default, that will exercise the `demo_app` example application. To exercise a different example application, set the `EXAMPLE_APP` environment variable to the corresponding directory name (e.g. `EXAMPLE_APP=demo_app-rollup`). You can also run -`bin/console` for an interactive prompt that will allow you to experiment. +`script/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run diff --git a/bin/console b/script/console similarity index 100% rename from bin/console rename to script/console From 3af6faf4b9cab9d98574fb143de8bd571ebe889e Mon Sep 17 00:00:00 2001 From: Richard Macklin Date: Fri, 22 Apr 2022 23:34:16 -0700 Subject: [PATCH 6/6] Update "Development" section of README to mention linting --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f131b27..e9c4b2a 100644 --- a/README.md +++ b/README.md @@ -176,8 +176,9 @@ Then, run `bundle exec rake test:integration:prepare` to set up the integration test environment and run `script/test` to run the tests. By default, that will exercise the `demo_app` example application. To exercise a different example application, set the `EXAMPLE_APP` environment variable to the corresponding -directory name (e.g. `EXAMPLE_APP=demo_app-rollup`). You can also run -`script/console` for an interactive prompt that will allow you to experiment. +directory name (e.g. `EXAMPLE_APP=demo_app-rollup`). To lint the code, run +`script/lint`. You can also run `script/console` for an interactive prompt that +will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run