Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 2.85 KB

README.md

File metadata and controls

65 lines (49 loc) · 2.85 KB
Raw

React-Templates Plugin

React-Templates Light weight templates for React. see more here.
React-Templates plugin for WebStorm, PHPStorm and other Idea family IDE, provides integration with React-Templates and shows errors and warnings inside the editor.

  • Support displaying react-templates warnings as intellij inspections
  • Support for react-templates file types
  • Automatically generate the javascript files from react-templates files
  • Group rt file with generated js file
  • Create a new RT file with controller

Getting started

Prerequisites

  • NodeJS
  • IntelliJ 13.1.4 / WebStorm 8.0.4, or above.

Install react-templates npm package react-templates npm:

$ cd <project path>
$ npm install react-templates

Or, install react-templates globally:

$ npm install -g react-templates

Settings

To get started, you need to set the react-templates plugin settings:

  • Go to preferences, react-templates plugin page and check the Enable plugin.
  • Set the path to the nodejs interpreter bin file.
  • Set the path to the react-templates bin file. should point to <project path>node_modules/react-templates/bin/rt.js if you installed locally or /usr/local/bin/rt if you installed globally.
    • For Windows: install react-templates globally and point to the react-templates cmd file like, e.g. C:\Users\<username>\AppData\Roaming\npm\rt.cmd
  • Select output modules system (AMD/CommonJS/Globals)
  • Select whether to group controller file with rt and rt.js files

Configuration:
React-Templates config

New RT File:
React-Templates inline


![React-Templates inline](https://raw.githubusercontent.com/idok/react-templates-plugin/master/docs/newRTFile.png)

RT Attributes completion:
React-Templates inline

RT Attributes quick docs:
React-Templates inline

A Note to contributors

react-templates plugin uses the code from here as a module, to run the project you need to clone that project as well.

git clone [email protected]:idok/react-templates-plugin.git
git clone [email protected]:idok/intellij-common.git
  • Open intellij
  • Import project react-templates-plugin
  • Import module intellij-common
  • Add module intellij-common as dependency for react-templates-plugin