Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
react-on-rails
Advanced tools
react-on-rails - npm Package Compare versions
Comparing version 5.1.1 to 5.2.0
@@ -7,5 +7,16 @@ # Change Log | ||
| ## [5.2.0] - 2016-04-08 | ||
| ##### Added | ||
| - Support for React 15.0 to react_on_rails. See [#379](https://github.com/shakacode/react_on_rails/pull/379) by [brucek](https://github.com/brucek). | ||
| ##### Removed | ||
| - Generator removals to simplify installer. See [#363](https://github.com/shakacode/react_on_rails/pull/363) by [jbhatab](https://github.com/jbhatab). | ||
| - Removed options for heroku, boostrap, and the linters from generator. | ||
| - Removed install for the Webpack Dev Server, as we can now do hot reloading with Rails, so the complexity of this feature is not justified. Nevertheless, the setup of React on Rails still supports this setup, just not with the generator. | ||
| - Documentation added for removed installer options. | ||
| ## [5.1.1] - 2016-04-04 | ||
| ##### Fixed | ||
| - [Security] Address failure to sanitize console messages when server rendering and displaying in the browser console. See [#366](https://github.com/shakacode/react_on_rails/pull/366) and [#370](https://github.com/shakacode/react_on_rails/pull/370) by [justin808](https://github.com/justin808) | ||
| ##### Added | ||
@@ -272,4 +283,5 @@ - railsContext includes the port number and a boolean if the code is being run on the server or client. | ||
| - Fix several generator related issues. | ||
| [Unreleased]: https://github.com/shakacode/react_on_rails/compare/5.1.1...master | ||
| [5.1.1]: https://github.com/shakacode/react_on_rails/compare/5.0.0...5.1.1 | ||
| [Unreleased]: https://github.com/shakacode/react_on_rails/compare/5.2.0...master | ||
| [5.2.0]: https://github.com/shakacode/react_on_rails/compare/5.1.1...5.2.0 | ||
| [5.1.1]: https://github.com/shakacode/react_on_rails/compare/5.1.0...5.1.1 | ||
| [5.1.0]: https://github.com/shakacode/react_on_rails/compare/5.0.0...5.1.0 | ||
@@ -276,0 +288,0 @@ [5.0.0]: https://github.com/shakacode/react_on_rails/compare/4.0.3...5.0.0 |
| { | ||
| "name": "react-on-rails", | ||
| "version": "5.1.1", | ||
| "version": "5.2.0", | ||
| "description": "react-on-rails JavaScript for react_on_rails Ruby gem", | ||
@@ -27,4 +27,4 @@ "main": "node_package/lib/ReactOnRails.js", | ||
| "jsdom": "^8.2.0", | ||
| "react": "^0.14.8", | ||
| "react-dom": "^0.14.8", | ||
| "react": "^15.0.0", | ||
| "react-dom": "^15.0.0", | ||
| "react-transform-hmr": "^1.0.4", | ||
@@ -31,0 +31,0 @@ "redux": "^3.3.1", |
| [](https://travis-ci.org/shakacode/react_on_rails) [](https://gemnasium.com/shakacode/react_on_rails) [](https://badge.fury.io/rb/react_on_rails) [](https://badge.fury.io/js/react-on-rails) [](https://codeclimate.com/github/shakacode/react_on_rails) [](https://coveralls.io/github/shakacode/react_on_rails?branch=master) | ||
| # NEWS | ||
| * 5.1.1 has shipped! Please see the [CHANGELOG.md](./CHANGELOG.md) for details on the latest release and any breaking changes. | ||
| * 2016-04-08: 5.2.0 Released! Support for React 15.0 and upates to the Generator. See the [CHANGELOG.md](./CHANGELOG.md) for details. | ||
| * [New slides on React on Rails](http://www.slideshare.net/justingordon/react-on-rails-v4032). | ||
@@ -77,3 +77,2 @@ * 2016-02-28: We added a [Projects page](./PROJECTS.md) and a [Kudos page](./KUDOS.md). Please edit the page your project or [email us](mailto:contact@shakacode.com) and we'll add you. We also love stars as it helps us attract new users and contributors. | ||
| - [ReactOnRails JavaScript API](#reactonrails-javascript-api) | ||
| - [Hot Reloading View Helpers](#hot-reloading-view-helpers) | ||
| - [React-Router](#react-router) | ||
@@ -84,13 +83,2 @@ + [Generator](#generator) | ||
| - [Multiple React Components on a Page with One Store](#multiple-react-components-on-a-page-with-one-store) | ||
| - [Using Images and Fonts](#using-images-and-fonts) | ||
| - [Bootstrap Integration](#bootstrap-integration) | ||
| + [Bootstrap via Rails Server](#bootstrap-via-rails-server) | ||
| + [Bootstrap via Webpack HMR Dev Server](#bootstrap-via-webpack-hmr-dev-server) | ||
| + [Keeping Custom Bootstrap Configurations Synced](#keeping-custom-bootstrap-configurations-synced) | ||
| + [Skip Bootstrap Integration](#skip-bootstrap-integration) | ||
| - [Linters](#linters) | ||
| + [JavaScript Linters](#javascript-linters) | ||
| + [Ruby Linters](#ruby-linters) | ||
| + [Running the Linters](#running-the-linters) | ||
| + [Developing with the Webpack Dev Server](#developing-with-the-webpack-dev-server) | ||
| + [Adding Additional Routes for the Dev Server](#adding-additional-routes-for-the-dev-server) | ||
@@ -110,3 +98,2 @@ + [Migrate From react-rails](#migrate-from-react-rails) | ||
| + [Redux](https://github.com/reactjs/redux) | ||
| + [Webpack dev server](https://webpack.github.io/docs/webpack-dev-server.html) with [hot module replacement](https://webpack.github.io/docs/hot-module-replacement-with-webpack.html) | ||
| + [Webpack optimization functionality](https://github.com/webpack/docs/wiki/optimization) | ||
@@ -119,7 +106,4 @@ + [React Router](https://github.com/reactjs/react-router) | ||
| Webpack is used for 2 purposes: | ||
| Webpack is used to generate several JavaScript "bundles" for inclusion in `application.js` or directly in your layout. | ||
| 1. Generate several JavaScript "bundles" for inclusion in `application.js`. | ||
| 2. Providing the Webpack Dev Server for quick prototyping of components without needing to refresh your browser to see updates. | ||
| This usage of webpack fits neatly and simply into the existing Rails sprockets system and you can include React components on a Rails view with a simple helper. | ||
@@ -475,6 +459,2 @@ | ||
| -S, [--server-rendering], [--no-server-rendering] # Add necessary files and configurations for server-side rendering | ||
| -j, [--skip-js-linters], [--no-skip-js-linters] # Skip installing JavaScript linting files | ||
| -L, [--ruby-linters], [--no-ruby-linters] # Install ruby linting files, tasks, and configs | ||
| -H, [--heroku-deployment], [--no-heroku-deployment] # Install files necessary for deploying to Heroku | ||
| -b, [--skip-bootstrap], [--no-skip-bootstrap] # Skip installing files for bootstrap support | ||
@@ -514,56 +494,2 @@ Runtime options: | ||
| ### Bootstrap Integration | ||
| React on Rails ships with Twitter Bootstrap already integrated into the build. Note that the generator removes `require_tree` in both the application.js and application.css.scss files. This is to ensure the correct load order for the bootstrap integration, and is usually a good idea in general. You will therefore need to explicitly require your files. | ||
| How the Bootstrap library is loaded depends upon whether one is using the Rails server or the HMR development server. | ||
| #### Bootstrap via Rails Server | ||
| In the former case, the Rails server loads `bootstrap-sprockets`, provided by the `bootstrap-sass` ruby gem (added automatically to your Gemfile by the generator) via the `app/assets/stylesheets/_bootstrap-custom.scss` partial. | ||
| This allows for using Bootstrap in your regular Rails stylesheets. If you wish to customize any of the Bootstrap variables, you can do so via the `client/assets/stylesheets/_pre-bootstrap.scss` partial. | ||
| #### Bootstrap via Webpack HMR Dev Server | ||
| When using the webpack dev server, which does not go through Rails, bootstrap is loaded via the [bootstrap-sass-loader](https://github.com/shakacode/bootstrap-sass-loader) which uses the `client/bootstrap-sass-config.js` file. | ||
| #### Keeping Custom Bootstrap Configurations Synced | ||
| Because the webpack dev server and Rails each load Bootstrap via a different file (explained in the two sections immediately above), any changes to the way components are loaded in one file must also be made to the other file in order to keep styling consistent between the two. For example, if an import is excluded in `_bootstrap-custom.scss`, the same import should be excluded in `bootstrap-sass-config.js` so that styling in the Rails server and the webpack dev server will be the same. | ||
| #### Skip Bootstrap Integration | ||
| Bootstrap integration is enabled by default, but can be disabled by passing the `--skip-bootstrap` flag (alias `-b`). When you don't need Bootstrap in your existing project, just skip it as needed. | ||
| ### Linters | ||
| The React on Rails generator can add linters and their recommended accompanying configurations to your project. There are two classes of linters: ruby linters and JavaScript linters. | ||
| ##### JavaScript Linters | ||
| JavaScript linters are **enabled by default**, but can be disabled by passing the `--skip-js-linters` flag (alias `j`) , and those that run in Node have been added to `client/package.json` under `devDependencies`. | ||
| ##### Ruby Linters | ||
| Ruby linters are **disabled by default**, but can be enabled by passing the `--ruby-linters` flag when generating. These linters have been added to your Gemfile in addition to the appropriate Rake tasks. | ||
| We really love using all the linters! Give them a try. | ||
| #### Running the Linters | ||
| To run the linters (runs all linters you have installed, even if you installed both Ruby and Node): | ||
| ```bash | ||
| rake lint | ||
| ``` | ||
| Run this command to see all the linters available | ||
| ```bash | ||
| rake -T lint | ||
| ``` | ||
| **Here's the list:** | ||
| ```bash | ||
| rake lint # Runs all linters | ||
| rake lint:eslint # eslint | ||
| rake lint:js # JS Linting | ||
| rake lint:jscs # jscs | ||
| rake lint:rubocop[fix] # Run Rubocop lint in shell | ||
| rake lint:ruby # Run ruby-lint as shell | ||
| rake lint:scss # See docs for task 'scss_lint' | ||
| ``` | ||
| ## Multiple React Components on a Page with One Store | ||
@@ -570,0 +496,0 @@ You may wish to have 2 React components share the same the Redux store. For example, if your navbar is a React component, you may want it to use the same store as your component in the main area of the page. You may even want multiple React components in the main area, which allows for greater modularity. In addition, you may want this to work with Turbolinks to minimize reloading the JavaScript. A good example of this would be something like an a notifications counter in a header. As each notifications is read in the body of the page, you would like to update the header. If both the header and body share the same Redux store, then this is trivial. Otherwise, we have to rely on other solutions, such as the header polling the server to see how many unread notifications exist. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-4.06%
93393
- Number of lines in readme file
- decreased by-10.31%
644
No dependency changes