Skip to content

Migration from SPFx ​

TL;DR: You can move an existing SPFx project to RSPFx and keep your src/, manifests, and package-solution.json. Run rspfx migrate and rebuild.

This guide is the short path. For the full checklist, see Migrating from gulp and Heft.

What you keep ​

ItemStatus
src/unchanged - classes, manifests, components, styles
config/package-solution.jsonread directly
config/serve.jsonread directly
config/config.jsonhonored - entrypoints rewritten from ./lib/ to ./src/
sharepoint/unchanged
@microsoft/sp-*externalized - keep only if you import that runtime

What you remove ​

  • gulpfile.js and Heft rig - gulp serve, heft.json, rig extends, tsconfig rig extends.
  • Toolchain dev deps - heft, spfx-heft-plugins, sp-build-web, gulp, webpack, loaders.
  • Heft configs - config/rig.json, config/typescript.json, config/sass.json, config/deploy-azure-storage.json.

Known gaps ​

  • No gulp task ecosystem - use plugin-api hooks compilerHooks and packageHooks for scripting.
  • Other frameworks need a preset - add a FrameworkPreset and BaseWebPart with definePlugin and registerPlugin. See Custom framework guide.
  • React is bundled per web part - check for skew on older tenant pages.

For flags and behavior, see ../../reference/commands.md.

Released under the MIT License.