Introducing open-source PnP SPFx Yeoman generator

SharePoint team

September 13th, 2018 0

SharePoint Framework Yeoman templates are the way to scaffold your own solutions to start creating your own functionalities for SharePoint platform. As out-of-the-box Yeoman templates only support scaffolding for a limited set of JavaScript frameworks, the community has been asking options to introduce additional capabilities using an open-source model. We are happy to announce the availability of the PnP SPFx Yeoman generator, which enables the community to work together with the SharePoint engineering and to add new supported JavaScript framework and other options to the templates.

PnP SPFx Yeoman generator extends the out-of-the-box SharePoint Framework Yeoman templates and does not replace them. It’s community driven initiative lead by the PnP Core team under surveillance of the SharePoint engineering team. In long term, we are also looking into open-sourcing the out-of-the-box templates, but as that will not happen in short term, we can use the PnP SPFx Yeoman project to extend and enhance the development experience for SharePoint Framework developers.

PnP Yeoman Template

With this first release, we have added support for HandbarJS and capabilities for adding optionally jQuery or PnPjs libraries to your solution automatically. We are looking into also adding VueJS soon on the project together with the community. Your ideas, feedback, and contributions will drive the next steps of the development.

How to get started?

You can get started by installing the generator by installing PnP SPFx Yeoman generator with the following command

npm install -g @pnp/generator-spfx

After installation, you can start a new project execute the following command:

yo @pnp/spfx

We are excited to hear your feedback, ideas and use cases to help us as Microsoft and as a community to improve this community generator in the future. See the following resources for additional details about this project.