React support

1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

2. In the left-hand pane, choose Vite.

3. In the right-hand pane:

   1. Specify the path to the folder where the project-related files will be stored.

   2. In the Node Interpreter field, specify the Node.js interpreter to use. Select a configured interpreter from the list or choose Add to configure a new one.

   3. From the Vite list, select npx create-vite.

   4. From the Template list, select react.

   5. Optional:

      To use TSX instead of JSX, select the Create TypeScript project checkbox. PyCharm will generate .tsx files for your application and a tsconfig.json configuration file.

4. When you click Create, PyCharm generates a React-specific project with all the required configuration files and downloads the required dependencies. PyCharm also creates an npm start and JavaScript Debug configurations with default settings for running or debugging your application.

tip

Alternatively, open the built-in Terminal, type npm create vite@latest to create an application, and then answer the questions of the wizard, learn more from the Vite official website.

1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

2. In the left-hand pane, choose Empty Project. In the right-hand pane, specify the application folder and click Create.

1. Open the empty project where you will use React.

2. In the embedded Terminal (AltF12) , type:

   npm install --save react react-dom

1. In the built-in Terminal (View | Tool Windows | Terminal), type:

   npm install --save-dev eslint
   npm install --save-dev eslint-plugin-react

2. Add an ESLint configuration file to your project.

3. In the Settings dialog (CtrlAlt0S) , go to Languages & Frameworks | JavaScript | Code Quality Tools | ESLint, and select Automatic ESLint configuration. PyCharm will automatically locate ESLint in your project node_modules folder, and then use the default configuration from .eslintrc.* file or from eslintConfig property in a package.json.

   Alternatively, select Manual ESLint configuration to use a custom ESLint package and configuration.

   See Activating and configuring ESLint in PyCharm for details.

1. In the ecmaFeatures object, add "jsx" = true. Here you can also specify additional language features you’d like to use, for example, ES6 classes, modules, and so on.

2. In the plugins object, add react.

3. In the rules object, you can list ESLint built-in rules that you would like to enable, as well as rules available via the react plugin.

   {
     "parser": "babel-eslint",
     "env": {
       "browser": true,
       "es6": true,
       "jest": true
     },
   
     "rules": {
       "arrow-parens": ["error", "as-needed", {
         "requireForBlockBody": true
       }],
       "react/jsx-props-no-spreading": "off",
       "react/jsx-sort-props": ["error", {
         "reservedFirst": ["key"]
       }],
       "react/require-default-props": "off",
       "react/sort-prop-types": "error",
       "react/state-in-constructor": ["error", "never"],
       "semi-spacing": "warn"
     },
     "overrides": [
       {
         "files": [
           "sample/**",
           "test/**"
         ],
         "rules": {
           "import/no-unresolved": "off"
         }
       }
     ]
   }

Learn more about ESLint and react plugin configuration from the ESLint official website.

1. Place the caret within the component name and press ShiftF6 or select Rename from the context menu.

2. Specify the new component name in compliance with React naming conventions.

1. Place the caret within the name of the state value and press ShiftF6 or select Refactor | Rename from the main menu of from the context menu.

2. Specify the new value name and press Enter. The focus moves to the setter where the new name of the value is suggested. Press Enter to accept the suggestion.

1. Select the code you want to extract and choose Refactor | Extract Component from the context menu.

   Alternatively, go to Refactor | Extract/Introduce | Extract Component in the main menu or press CtrlAltShift0T and select Extract Component from the popup.

2. In the dialog that opens, specify the name of the new component and its type. By default, a functional component is created. If you want to define the new component as a class, select Class.

3. Click OK. The new component will be defined next to the existing one and used in it.

4. Optionally: use the Move Symbol refactoring to move the new component and all the required imports to a separate file.

5. Optionally: modify the code templates that PyCharm uses for new components. In the Settings dialog (CtrlAlt0S) , go to Editor | File and Code Templates, open the Code tab, and update the templates as necessary using the Apache Velocity template language.

• Place the caret anywhere inside the function to convert and select Refactor | Convert to Class Component from the main menu or from the context menu.

• Alternatively, press CtrlAltShift0T and select Convert to Class Component from the popup.

• Place the caret anywhere inside the class to convert and select Refactor | Convert to Functional Component from the main menu or from the context menu.

• Alternatively, press CtrlAltShift0T and select Convert to Functional Component from the popup.

1. Go to Run | Edit Configurations. Alternatively, select Edit Configurations from the Run widget on the toolbar.

   

   In the Edit Configurations dialog that opens, click the Add button () on the toolbar and select npm from the list.

2. In the Configuration tab of the Run/Debug Configurations: npm dialog that opens, specify the location of the package.json, the Node.js interpreter, and the package manager to use.

   In the Command field, select run from the list and then select the script to run from the Scripts list. Most likely it will be the default start script but you can configure another one in your package.json, for example, to run the application on a custom port.

   

3. Optionally:

   To open the application in the browser, update the configuration as follows: in the Browser / Live Edit tab, select the After launch checkbox, select the browser to open the application in, and specify the URL address at which the application wil run.

   If you are going to debug the application, select Google Chrome or another Chromium-based browser.

   

1. Select the npm start run configuration from the list on the toolbar and click next to it.

   

2. Wait till the application is compiled and the development server is ready.

   The Run tool window or the Terminal shows the URL at which your application is running. Click this link to view the application.

   

   Alternatively, enable PyCharm to open the application on start as described above.

   note

   When the development server is running, your application is automatically reloaded as soon as you change any of the source files and save the updates.

1. Set the breakpoints in your code.

2. Create an npm configuration as described above.

   If you generated your application with create-react-app, PyCharm has already created an npm configuration with the default name npm start. The configuration is available from the Run widget and in the Run/Debug Configurations dialog.

   

3. In the Configuration tab of the Run/Debug Configurations: npm dialog that opens, specify the location of the package.json, the Node.js interpreter, and the package manager to use.

   In the Command field, select run from the list and then select the script to run from the Scripts list. Most likely it will be the default start script but you can configure another one in your package.json, for example, to run the application on a custom port.

   

4. In the Browser / Live Edit tab, select the After launch checkbox, select Google Chrome or another Chromium-based browser from the list, select the with JavaScript debugger checkbox, and then specify the URL at which your application will run.

   

5. Click Run.

   To re-run the configuration, select it from the list in the Run widget and click next to it.

   PyCharm runs the application in the development mode and at the same time launches a debugging session.

   

6. When the first breakpoint is hit, switch to the Debug tool window and proceed as usual: step through the program, stop and resume program execution, examine it when suspended, explore the call stack and variables, set watches, evaluate variables, view actual HTML DOM, and so on.

1. Set the breakpoints in your code.

2. Start the application in the development mode as described above and wait till the application is compiled and the development server is ready.

   The Run tool window or the Terminal shows the URL at which your application is running. Copy this URL to specify it later in the JavaScript Debug configuration.

   

3. Create a JavaScript Debug configuration. To do that, go to Run | Edit Configurations in the main menu, click , and select Javascript Debug from the list.

4. In the Run/Debug Configurations: JavaScript Debug dialog that opens, specify the name of the configuration and the URL address at which the application is running in the development mode. You can copy this URL in the Run tool window or in the Terminal, as described above.

   

5. Click Debug.

   To re-run the configuration, select it from the list in the Run widget and click next to it.

   

6. When the first breakpoint is hit, switch to the Debug tool window and proceed as usual: step through the program, stop and resume program execution, examine it when suspended, explore the call stack and variables, set watches, evaluate variables, view actual HTML DOM, and so on.

1. Set the breakpoints in your code.

2. Start the application in the development mode as described above and wait till the application is compiled and the development server is ready.

3. The Run tool window or the Terminal shows the URL at which your application is running. Hold CtrlShift and click this URL link. PyCharm starts a debugging session with an automatically generated configuration of the type JavaScript Debug.

   

   Gif

   If you launched your application in the development mode from the New Terminal, you can just click the Start debugging in browser button next to the link.

   

   note

   The button is not available from the New Terminal in the WSL.