Vite

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.

      Alternatively, for npm version 5.1 and earlier, install the create-vite package yourself by running npm install --g create-vite in the Terminal Alt+F12. When creating an application, select the folder where the create-vite package is stored.

   4. From the Template list, select the community maintained Vite template that targets the framework you are going to use in your application.

   5. Optionally:

      To use TypeScript instead of JavaScript, select the Use TypeScript template checkbox. PyCharm will generate .ts files for your application and a tsconfig.json configuration file.

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

Create an empty PyCharm project

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.

Install Vite in an empty project

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

2. In the embedded Terminal (Alt+F12) , type:

   npm install --save-dev vite

Choose how to detect Vite configuration

1. Open the Settings dialog (Ctrl+Alt+S) and go to Languages & Frameworks | JavaScript | Vite.

2. In the Detect Vite configuration files for module resolution area, select one of the following options:

   • Automatically: In this mode, for a JavaScript or TypeScript file, PyCharm will first look for a Vite configuration file in the folder where this JavaScript or TypeScript file is located, then in its parent folder, and so on.

     As a result, if your project consists of multiple modules with different Vite configurations, each module will use the module resolution rules from its own Vite configuration file (if such config is found).

     PyCharm recognizes JavaScript or TypeScript Vite configuration files with the following names and in the following order:

     • vite.config.js/vite.config.ts

     • vite.config.mjs

     • vite.config.cjs

   • Manually: In the Configuration file field, specify the location of the Vite config to use.

     In this mode, the resolution rules from the specified configuration file will be applied to all modules in your project.

     Select this option if the name of your Vite configuration file is not recognized by PyCharm, refer to the list of recognized Vite config names above.

     

Create an npm run/debug configuration

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 dev 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.

   

Run an application

1. Select the npm dev 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.

Run and debug a Vite application with a single npm run/debug configuration

1. Set the breakpoints in your code.

2. Create an npm configuration as described above.

   If you generated your application with create-vite, PyCharm has already created an npm configuration with the default name npm dev. 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 dev 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.

Start debugging with a JavaScript Debug run/debug configuration

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 Ctrl+Shift and click this URL link. PyCharm starts a debugging session with an automatically generated configuration of the type JavaScript Debug.

   

   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.