@pnp/generator-spfx

    1.16.1 • Public • Published

    PnP SPFx generator - community driven and open source

    CircleCI Gitter chat

    This Yeoman generator provides improved governance for SharePoint Framework projects. It extends the out of the box Yeoman generator from Microsoft (@microsoft/generator-sharepoint) with recommended patterns and additional capabilities.

    For an optimized development workflow, it extends the capabilities for ReactJS, and Knockout projects and support for additional frameworks, such as HandlebarsJS, Aurelia, VueJS and Angular Elements. It also includes includes advanced code analysis and testing tools, which you can take advantage in you development work.

    All projects generated by this generator are 100% compliant with the out-of-the-box Yeoman generator from Microsoft. After the creation of a new solution, you can use either this generator or @microsoft/generator-sharepoint to add additional assets to your solution.

    PnP SPFx Generator

    This is an open-source extension for native out of the box SPFx generator to introduce additional scaffolding support for Angular Elements, Aurelia, VueJS, Handlebars and many more in future. This generator has a dependency on native SPFx generator from Microsoft.

    Documentation

    More details can be found in the documentation at https://aka.ms/pnpgenerator

    Installation

    via NPM

    npm install -g @pnp/generator-spfx

    via YARN

    yarn global add @pnp/generator-spfx

    via PNPM

    pnpm install -g @pnp/generator-spfx

    For Evaluation and Testing

    This generator can be also tested via npx and the following command:

    npx -p yo -p @pnp/generator-spfx yo @pnp/spfx

    It will create a new project without installation of the generator. To add other assets the same command line can be executed again on the project folder.

    Usage

    To run the generator:

    yo @pnp/spfx
    

    We will guide you through the your project creation.

    Follow the  on screen

    For Development

    git clone https://github.com/pnp/generator-spfx.git
    

    More details can also be found in the documentation on how to extend this generator.

    More details on our documentation

    SharePoint Patterns and Practices

    Sharing is caring!

    Install

    npm i @pnp/generator-spfx

    DownloadsWeekly Downloads

    55

    Version

    1.16.1

    License

    MIT

    Unpacked Size

    237 kB

    Total Files

    128

    Last publish

    Collaborators

    • patrick-rodgers
    • waldekm
    • vesajuvonen
    • jansenbe
    • officedevpnp
    • stfbauer
    • garry.trinder
    • appieschot
    • rabiawilliams
    • plamber
    • arjunumenon
    • eliostruyf