Skip to content

Commit 7e12176

Browse files
committed
Update the generator descriptions
1 parent 7080ec1 commit 7e12176

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

lib/generators/spotlight/assets/importmap_generator.rb

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,14 @@ class ImportmapGenerator < Rails::Generators::Base
1515
class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.3'), desc: "Set the generated app's bootstrap version"
1616

1717
desc <<-DESCRIPTION
18-
This generator sets up the app to use importmap to manage the javascript,
19-
and cssbundling-rails to manage the styles.
20-
21-
SCSS stylesheets are installed via yarn and built into a single CSS
22-
stylesheet.
23-
24-
JS sources from the Blacklight and Spotlight gems are delivered via
25-
importmap, and their dependencies are pinned to versions delivered via
26-
CDN.
18+
This generator configures the Spotlight app to use importmap for
19+
javascript and bundling for the styles:
20+
21+
- Adds the frontend style dependencies, including spotlight-frontend,
22+
via yarn
23+
- Configures cssbundling-rails to build the styles
24+
- Javascript from gems such as Blacklight and Spotlight are delivered
25+
via importmap/the asset pipeline without the need for bundling
2726
DESCRIPTION
2827

2928
def add_stylesheet_dependencies

lib/generators/spotlight/assets/propshaft_generator.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@ class PropshaftGenerator < Rails::Generators::Base
1515
class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.3'), desc: "Set the generated app's bootstrap version"
1616

1717
desc <<-DESCRIPTION
18-
The Spotlight frontend assets are installed from the npm package. In
19-
local development they automatically reference the versions from the
20-
outer directory (the Spotlight repository) via a yarn symlink.
18+
This generator configures the Spotlight app to use bundling for both
19+
javascript and styles:
20+
21+
- Adds frontend dependencies, including spotlight-frontend, via yarn
22+
- Configures jsbundling-rails (w/ esbuild) to bundle the JS
23+
- Configures cssbundling-rails to build the styles
2124
DESCRIPTION
2225

2326
def install_dependencies

0 commit comments

Comments
 (0)