Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Webpacker guide code typos #41259

Merged
merged 2 commits into from
Jan 28, 2021
Merged

Webpacker guide code typos #41259

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2f1c8f
[ci-skip] javascript_link_tag -> javascript_include_tag in Webpacker …
gmcgibbon Jan 27, 2021
ead4fb3
[ci-skip] bundle exec rails -> bin/rails in Webpacker guide
gmcgibbon Jan 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 20 additions & 20 deletions guides/source/webpacker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ You should choose webpacker over Sprockets on a new project if you want to use N

If you are familiar with Sprockets, the following guide might give you some idea of how to translate. Please note that each tool has a slightly different structure, and the concepts don't directly map onto each other.

|Task | Sprockets | Webpacker |
|------------------|-------------------|-------------------|
|Attach JavaScript |javascript_link_tag|javascript_pack_tag|
|Attach CSS |stylesheet_link_tag|stylesheet_pack_tag|
|Link to an image |image_url |image_pack_tag |
|Link to an asset |asset_url |asset_pack_tag |
|Require a script |//= require |import or require |
|Task | Sprockets | Webpacker |
|------------------|----------------------|-------------------|
|Attach JavaScript |javascript_include_tag|javascript_pack_tag|
|Attach CSS |stylesheet_link_tag |stylesheet_pack_tag|
|Link to an image |image_url |image_pack_tag |
|Link to an asset |asset_url |asset_pack_tag |
|Require a script |//= require |import or require |

Installing Webpacker
--------------------
Expand All @@ -51,7 +51,7 @@ To use Webpacker, you must install the Yarn package manager, version 1.x or up,

NOTE: Webpacker depends on NPM and Yarn. NPM, the Node package manager registry, is the primary repository for publishing and downloading open-source JavaScript projects, both for Node.js and browser runtimes. It is analogous to rubygems.org for Ruby gems. Yarn is a command-line utility that enables installation and management of JavaScript dependencies, much like Bundler does for Ruby.

Webpacker is installed by default in Rails 6.0 and up. In some older versions, you can install it with a new project by adding `--webpack` to the `rails new` command. In an existing project, webpacker can be added by running `bundle exec rails webpacker:install`. This installation command creates following local files:
Webpacker is installed by default in Rails 6.0 and up. In some older versions, you can install it with a new project by adding `--webpack` to the `rails new` command. In an existing project, webpacker can be added by running `bin/rails webpacker:install`. This installation command creates following local files:

|File |Location |Explanation |
|------------------------|------------------------|----------------------------------------------------------------------------------------------------|
Expand All @@ -72,17 +72,17 @@ These integrations typically install the set of NPM packages needed to get start

INFO. It's possible to install frameworks not included in this list. These are basic integrations of popular choices.

|Framework |Install command |Description |
|------------------|------------------------------------|--------------------------------------------------|
|Angular |`rails webpacker:install:angular` |Sets up Angular and Typescript |
|CoffeeScript |`rails webpacker:install:coffee` |Sets up CoffeeScript |
|Elm |`rails webpacker:install:elm` |Sets up Elm |
|ERB |`rails webpacker:install:erb` |Sets up ERB support on your Javascript files |
|React |`rails webpacker:install:react` |Sets up ReactJS |
|Stimulus |`rails webpacker:install:stimulus` |Sets up StimulusJS |
|Svelte |`rails webpacker:install:svelte` |Sets up Svelte JS |
|TypeScript |`rails webpacker:install:typescript`|Sets up Typescript for your project using Babel's TypeScript support|
|Vue |`rails webpacker:install:vue` |Sets up VueJS |
|Framework |Install command |Description |
|------------------|----------------------------------------|--------------------------------------------------|
|Angular |`bin/rails webpacker:install:angular` |Sets up Angular and Typescript |
|CoffeeScript |`bin/rails webpacker:install:coffee` |Sets up CoffeeScript |
|Elm |`bin/rails webpacker:install:elm` |Sets up Elm |
|ERB |`bin/rails webpacker:install:erb` |Sets up ERB support on your Javascript files |
|React |`bin/rails webpacker:install:react` |Sets up ReactJS |
|Stimulus |`bin/rails webpacker:install:stimulus` |Sets up StimulusJS |
|Svelte |`bin/rails webpacker:install:svelte` |Sets up Svelte JS |
|TypeScript |`bin/rails webpacker:install:typescript`|Sets up Typescript for your project using Babel's TypeScript support|
|Vue |`bin/rails webpacker:install:vue` |Sets up VueJS |

For more information about the existing integrations, see https://github.com/rails/webpacker#integrations

Expand Down Expand Up @@ -203,7 +203,7 @@ By default, Webpacker compiles automatically on demand in development when a Rai

If you want to use live code reloading, or you have enough JavaScript that on-demand compilation is too slow, you'll need to run `./bin/webpack-dev-server` or `ruby ./bin/webpack-dev-server`. This process will watch for changes in the `app/javascript/packs/*.js` files and automatically recompile and reload the browser to match.

Windows users will need to run these commands in a terminal separate from `bundle exec rails s`.
Windows users will need to run these commands in a terminal separate from `bundle exec rails server`.

Once you start this development server, Webpacker will automatically start proxying all webpack asset requests to this server. When you stop the server, it'll revert to on-demand compilation.

Expand Down