Yeoman

Last modified: 05 September 2023

Required plugin:

Yeoman -  Install the plugin on the Settings | Plugins page, tab Marketplace.

You can create framework-specific PhpStorm projects using Yeoman.

Before you start

  1. Download and install Node.js.

  2. Install and enable the Yeoman plugin on the Settings | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains Marketplace.

To install and configure Yeoman in PhpStorm

  1. In the embedded Terminal () , type:

    npm install -g yo

  2. In the Settings dialog (), go to Languages & Frameworks | JavaScript | Yeoman. On the Yeoman page that opens, specify the location of the globally installed yo package and the local Node.js interpreter to use.

To configure a list of project stub generators

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

  3. The right-hand pane shows all the previously installed Yeoman generators. Click Install Generator.

  4. From the dialog that opens showing all the available generator packages, select the required package in the left-hand pane and click the Install Generator button that appears in the right-hand pane. You can install several packages one after another without leaving the dialog.

    When the installation is over, click Close to return to the list of generators which is already expanded with the newly added package.

To create a project by a generator

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

  3. The right-hand pane shows all the previously installed Yeoman generators. To expand the list, click Install Generator, refer to To install and configure Yeoman in PhpStorm above.

    Select the required generator from the list and click Next.

  4. Specify the required settings in the New Project wizard that starts. The number of pages and their contents depend on the chosen generator.

  5. On the last page of the wizard, select or clear the Run npm install&bower install checkbox to specify whether you want to run Node Package Manager and Bower to install the packages that are required for developing the new project.

  6. Click Next and choose to open the new project in the current window or in the new one.

See also

Procedures