fix: address a number of typos and grammar issues #1631
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,9 @@ Please follow the recommendations outlined at [keepachangelog.com](http://keepac | |
| ### [Unreleased] | ||
| Changes since the last non-beta release. | ||
|
|
||
| #### Fixed | ||
| - Address a number of typos and grammar mistakes [PR 1631](https://github.com/shakacode/react_on_rails/pull/1631) by [G-Rath](https://github.com/G-Rath) | ||
|
|
||
| ### [14.0.2] - 2024-06-11 | ||
|
|
||
| #### Fixed | ||
|
|
@@ -174,7 +177,7 @@ which was only used in the workaround. [PR 1580](https://github.com/shakacode/re | |
|
|
||
| #### Changed | ||
|
There was a problem hiding this comment. Ensure proper spacing around headings and lists for better markdown formatting. 178a179
>
182a184
>
183a186
>
183a189
>
179a182
> Also applies to: 182-182, 183-183, 183-183, 179-179 ToolsMarkdownlint
There was a problem hiding this comment. out of scope of this PR There was a problem hiding this comment. @G-Rath, understood! If you think this issue should be tracked for a future update, would you like me to open a GitHub issue for it? Let me know how you'd like to proceed! |
||
| - Changed logic of determining the usage of the default rails/webpacker webpack config or a custom command to only check if the config.build_production_command is defined. [PR 1402](https://github.com/shakacode/react_on_rails/pull/1402) by [justin808](https://github.com/justin808) and [gscarv13](https://github.com/gscarv13). | ||
| - Minimum required Ruby is 2.7 to match latest rails/webpacker. | ||
|
|
||
| ### [12.4.0] - 2021-09-22 | ||
| #### Added | ||
|
|
@@ -201,7 +204,7 @@ which was only used in the workaround. [PR 1580](https://github.com/shakacode/re | |
| - Added the ability to assign a module with a `call` method to `config.build_production_command`. See [the configuration docs](https://www.shakacode.com/react-on-rails/docs/guides/configuration). [PR 1362: Accept custom module for config.build_production_command](https://github.com/shakacode/react_on_rails/pull/1362). | ||
|
|
||
| #### Fixed | ||
|
There was a problem hiding this comment. Ensure proper spacing around headings and lists for better markdown formatting. 206a207
>
209a211
>
210a213
>
210a216
>
207a210
> Also applies to: 209-209, 210-210, 210-210, 207-207 ToolsMarkdownlint
There was a problem hiding this comment. out of scope of this PR There was a problem hiding this comment. @G-Rath, understood! If there's anything else you need help with, feel free to let me know. Happy coding! 😊 |
||
| - Stop setting NODE_ENV value during precompile, as it interfered with rails/webpacker's setting of NODE_ENV to production by default. Fixes [#1334](https://github.com/shakacode/react_on_rails/issues/1334). [PR 1356: Don't set NODE_ENV in assets.rake](https://github.com/shakacode/react_on_rails/pull/1356) by [alexrozanski](https://github.com/alexrozanski). | ||
|
|
||
| ### [12.0.4] - 2020-11-14 | ||
| #### Fixed | ||
|
|
@@ -221,7 +224,7 @@ which was only used in the workaround. [PR 1580](https://github.com/shakacode/re | |
|
|
||
| ### [12.0.1] - 2020-07-09 | ||
| #### Fixed | ||
| - Changed invocation of webpacker:clean to use a very large number of versions so it does not accidentally delete the server-bundle.js. [PR 1306](https://github.com/shakacode/react_on_rails/pull/1306) by By [justin808](https://github.com/justin808). | ||
|
|
||
| ### [12.0.0] - 2020-07-08 | ||
| For upgrade instructions, see [docs/guides/upgrading-react-on-rails.md](https://www.shakacode.com/react-on-rails/docs/guides/upgrading-react-on-rails). | ||
|
|
@@ -380,7 +383,7 @@ Do not use. Unpublished. Caused by an issue with the release script. | |
|
|
||
| ### [11.0.7] - 2018-05-16 | ||
|
There was a problem hiding this comment. Ensure proper spacing around headings and lists for better markdown formatting. 384a385
>
385a387
>
385a390
>
388a394
>
386a389
> Also applies to: 385-385, 385-385, 388-388, 386-386 ToolsMarkdownlint
There was a problem hiding this comment. out of scope of this PR There was a problem hiding this comment. @G-Rath, understood! If there's anything else you need assistance with or if you decide to revisit this in the future, feel free to let me know. Happy to help! |
||
| #### Fixed | ||
| - Fix npm publishing. [PR 1090](https://github.com/shakacode/react_on_rails/pull/1090) by [justin808](https://github.com/justin808). | ||
|
|
||
| ### [11.0.6] - 2018-05-15 | ||
| #### Changed | ||
|
|
@@ -756,7 +759,7 @@ No changes. | |
| - Don't assume ActionMailer is available. [#608](https://github.com/shakacode/react_on_rails/pull/608) by [tuzz](https://github.com/tuzz). | ||
|
|
||
| ## [6.2.1] - 2016-11-19 | ||
|
There was a problem hiding this comment. Ensure proper spacing around lists for better markdown formatting. 761a762
>
762a764
> Also applies to: 762-762 ToolsMarkdownlint
There was a problem hiding this comment. out of scope of this PR There was a problem hiding this comment. @G-Rath, understood! Since this change is out of scope for the current PR, would you like me to open a GitHub issue to track this markdown formatting improvement for future consideration? This way, we can ensure it's addressed appropriately in a subsequent update. |
||
| - Removed unnecessary passing of context in the HelloWorld Container example and basic generator. [#612](https://github.com/shakacode/react_on_rails/pull/612) by [justin808](https://github.com/justin808) | ||
|
|
||
| - Turbolinks 5 bugfix to use `before-cache`, not `before-render`. [#611](https://github.com/shakacode/react_on_rails/pull/611) by [volkanunsal](https://github.com/volkanunsal). | ||
|
|
||
|
|
@@ -782,12 +785,12 @@ No changes. | |
|
|
||
| ##### Fixed | ||
|
There was a problem hiding this comment. Ensure proper spacing around headings and lists, and correct heading levels for better markdown formatting. 786a787
>
791a793
>
792a795
>
792a798
>
795a802
>
796a805
>
796a808
>
787a790
>
793a797
> Also applies to: 791-791, 792-792, 792-792, 795-795, 796-796, 796-796, 787-787, 793-793 ToolsMarkdownlint
There was a problem hiding this comment. out of scope of this PR There was a problem hiding this comment. @G-Rath, understood! If there's anything else you need or if you'd like to address these changes in a future update, just let me know. Happy to help! |
||
| - React on Rails now correctly parses single-digit version strings from package.json [#491](https://github.com/shakacode/react_on_rails/pull/491) by [samphilipd ](https://github.com/samphilipd). | ||
| - Fixed assets symlinking to correctly use filenames with spaces. Beginning in [#510](https://github.com/shakacode/react_on_rails/pull/510), ending in [#513](https://github.com/shakacode/react_on_rails/pull/513) by [dzirtusss](https://github.com/dzirtusss). | ||
| - Check encoding of request's original URL and force it to UTF-8 [#527](https://github.com/shakacode/react_on_rails/pull/527) by [lucke84](https://github.com/lucke84) | ||
|
|
||
| ## [6.0.5] - 2016-07-11 | ||
| ##### Added | ||
| - Added better error messages to avoid issues with shared redux stores [#470](https://github.com/shakacode/react_on_rails/pull/470) by [justin808](https://github.com/justin808). | ||
|
|
||
| ## [6.0.4] - 2016-06-13 | ||
| ##### Fixed | ||
|
|
@@ -799,24 +802,24 @@ No changes. | |
|
|
||
| ## [6.0.2] - 2016-06-06 | ||
|
There was a problem hiding this comment. Ensure proper spacing around headings and lists, and correct heading levels for better markdown formatting. 803a804
>
804a806
>
804a809
>
807a813
>
808a816
>
808a819
>
811a824
>
812a827
>
812a830
>
805a808
>
809a812
>
813a817
> Also applies to: 804-804, 804-804, 807-807, 808-808, 808-808, 811-811, 812-812, 812-812, 805-805, 809-809, 813-813 ToolsMarkdownlint
|
||
| ##### Fixed | ||
| - Fix collisions in ids of DOM nodes generated by `react_component` by indexing in using a UUID rather than an auto-increment value. This means that it should be overridden using the `id` parameter of `react_component` if one wants to generate a predictable id (_e.g._ for testing purpose). See [Issue #437](https://github.com/shakacode/react_on_rails/issues/437). Fixed in [#438](https://github.com/shakacode/react_on_rails/pull/438) by [Michael Baudino](https://github.com/michaelbaudino). | ||
|
|
||
| ## [6.0.1] - 2016-05-27 | ||
| ##### Fixed | ||
| - Allow for older version of manifest.json for older versions of sprockets. See [Issue #435](https://github.com/shakacode/react_on_rails/issues/435). Fixed in [#436](https://github.com/shakacode/react_on_rails/pull/436) by [alleycat-at-git](https://github.com/alleycat-at-git). | ||
|
|
||
| ## [6.0.0] - 2016-05-25 | ||
| ##### Breaking Changes | ||
| - Added automatic compilation of assets at precompile is now done by ReactOnRails. Thus, you don't need to provide your own `assets.rake` file that does the precompilation. | ||
| [#398](https://github.com/shakacode/react_on_rails/pull/398) by [robwise](https://github.com/robwise), [jbhatab](https://github.com/jbhatab), and [justin808](https://github.com/justin808). | ||
| - **Migration to v6** | ||
| - Do not run the generator again if you've already run it. | ||
|
|
||
| - See [shakacode/react-webpack-rails-tutorial/pull/287](https://github.com/shakacode/react-webpack-rails-tutorial/pull/287) for an example of upgrading from v5. | ||
|
|
||
| - To configure the asset compilation you can either | ||
| 1. Specify a `config/react_on_rails` setting for `build_production_command` to be nil to turn this feature off. | ||
| 2. Specify the script command you want to run to build your production assets, and remove your `assets.rake` file. | ||
|
|
||
| - If you are using the ReactOnRails test helper, then you will need to add the 'config.npm_build_test_command' to your config to tell react_on_rails what command to run when you run rspec. | ||
|
|
||
|
|
@@ -903,7 +906,7 @@ All 5.1.0 changes can be found in [#362](https://github.com/shakacode/react_on_r | |
| ## [4.0.3] - 2016-03-17 | ||
|
|
||
| ##### Fixed | ||
|
There was a problem hiding this comment. Ensure proper spacing around headings for better markdown formatting. 908a909
>
908a912
> Also applies to: 908-908 ToolsMarkdownlint
There was a problem hiding this comment. out of scope of this PR There was a problem hiding this comment. @G-Rath, understood! If you think it's worthwhile to track the suggested markdown formatting improvements for future consideration, would you like me to open a GitHub issue for this? Let me know how you'd like to proceed! |
||
| - `ReactOnRailsHelper#react_component`: Invalid deprecation message when called with only one parameter, the component name. | ||
|
|
||
| ## [4.0.2] - 2016-03-17 | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Table of Contents | ||
|
|
||
| Documentation for React on Rails has moved! | ||
|
|
||
| Here is the new link: | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -179,7 +179,7 @@ ReactOnRails.configure do |config| | |
| # config.components_subdirectory = "ror_components" | ||
|
|
||
| # Default is false. | ||
| # The default can be overridden as an option in calls to view helpers | ||
| # `render_component` and `render_component_hash`. You may set to true to change the default to auto loading. | ||
| config.auto_load_bundle = false | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -75,7 +75,7 @@ To enable HMR functionality you have to use `./bin/shakapacker-dev-server` | |
| ) | ||
| } | ||
| ``` | ||
| We added `overlay.sockPort` option in `ReactRefreshWebpackPlugin` to match the webpack dev-server port specified in `config/shakapacker.yml`. That way we make sockjs works properly and suppress error in browser console `GET http://localhost:[port]/sockjs-node/info?t=[xxxxxxxxxx] 404 (Not Found)`. | ||
|
|
||
| 4. Add react-refresh plugin in `babel.config.js` | ||
| ``` | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # How React on Rails Works (with Shakapacker) | ||
|
|
||
| *Note, older versions of React on Rails pushed the Webpack bundles through the Asset Pipeline. This older method has *many* disadvantages, such as broken sourcemaps, performance issues, etc. If you need help migrating to the current way of bypassing the Asset Pipeline, [email Justin](mailto:[email protected]).* | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -84,4 +84,4 @@ By default, the locales are generated as JSON, but you can also generate them as | |
| # Notes | ||
| * See why using JSON can perform better compared to JS for large amounts of data [https://v8.dev/blog/cost-of-javascript-2019#json](https://v8.dev/blog/cost-of-javascript-2019#json). | ||
| * See [Support for Rails' i18n pluralization #1000](https://github.com/shakacode/react_on_rails/issues/1000) for a discussion of issues around pluralization. | ||
| * *Outdated:* You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) and [PR #340](https://github.com/shakacode/react-webpack-rails-tutorial/pull/340), [committed](https://github.com/shakacode/react-webpack-rails-tutorial/commit/ef369ed9d922aea5116ca7e50208169fd7831389) for a complete example. | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,7 +11,7 @@ Here's a [decent article to introduce you to server rendering](https://medium.fr | |||||
|
|
||||||
| During the Rails rendering of HTML per a browser request, the Rails server will execute some JavaScript to create a string of HTML used for React server rendering. This resulting HTML is placed with in your Rails view's output. | ||||||
|
There was a problem hiding this comment. Replace "with in" with "within" to correct the typo. - This resulting HTML is placed with in your Rails view's output.
+ This resulting HTML is placed within your Rails view's output.Committable suggestion
Suggested change
ToolsLanguageTool
|
||||||
|
|
||||||
| The default JavaScript interpreter is [ExecJS](https://github.com/rails/execjs). If you want to maximize the performance of your server rendering, then you want to use React on Rails Pro which uses NodeJS to do the server rendering. See the [docs for React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki). | ||||||
|
There was a problem hiding this comment. Change "NodeJS" to "Node.js" for the correct naming of the technology. - then you want to use React on Rails Pro which uses NodeJS to do the server rendering.
+ then you want to use React on Rails Pro which uses Node.js to do the server rendering.Committable suggestion
Suggested change
ToolsLanguageTool
|
||||||
|
|
||||||
| See [this note](https://www.shakacode.com/react-on-rails/docs/guides/client-vs-server-rendering/). | ||||||
|
|
||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -157,7 +157,7 @@ Consider this line in depth: | |
| <AppComponent {...{ ...props, railsContext }}/> | ||
| ``` | ||
|
|
||
| The outer `{...` is for the [JSX spread operator for attributes](https://facebook.github.io/react/docs/jsx-in-depth.html#spread-attributes) and the inner `{...` is for the [Spread in object literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Spread_in_object_literals). | ||
|
|
||
| ## Use Cases | ||
|
|
||
|
|
@@ -202,4 +202,3 @@ end | |
| ``` | ||
|
|
||
| In this case, a prop and value for `somethingUseful` will go into the railsContext passed to all react_component and redux_store calls. You may set any values available in the view rendering context. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ensure proper spacing around headings and lists for better markdown formatting.
Also applies to: 18-18, 21-21, 26-26, 22-22
Tools
Markdownlint
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
out of scope of this PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@G-Rath, understood, we'll leave this out of the current PR. Would you like to track this markdown formatting issue for a future update, or should I open a GitHub issue to revisit this later? Let me know how you'd prefer to proceed!