sp-dev-fx-webparts/samples/js-extend-gulp
Hugo Bernier 8e6bd1404b Added web part to every sample 2024-04-18 01:51:29 -04:00
..
.devcontainer remote container for js-extend-gulp 2022-03-11 16:04:58 -05:00
assets Added web part to every sample 2024-04-18 01:51:29 -04:00
config Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
images Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
src Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
typings Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
.editorconfig Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
.gitattributes Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
.gitignore Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
.npmignore Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
.yo-rc.json Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
README.md Updated contributors for readmes 2023-03-15 00:11:27 -04:00
gulpfile.js Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
package.json Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
tsconfig.json Sample showing how to integrated gulp tasks with spfx toolchain. (#105) 2017-01-26 09:33:15 +02:00
tslint.json Add tslint at the root of each SPFx project (#394) 2018-01-08 15:58:48 +02:00

README.md

page_type products languages extensions
sample
office-sp
javascript
typescript
contentType technologies createdDate
tools
SharePoint Framework
1/1/2016 12:00:00 AM

Integrating custom gulp tasks to SharePoint Framework toolchain

Summary

SharePoint client-side development tools use gulp as the build process task runner to:

  • Bundle and minify JavaScript and CSS files.
  • Run tools to call the bundling and minification tasks before each build.
  • Compile LESS or SASS files to CSS.
  • Compile TypeScript files to JavaScript.

One common task you would want add to the SharePoint Framework toolchain is to integrate your custom gulp tasks and execute them.

This sample shows how to integrate custom gulp tasks using the gulp-image-resize task that resizes images.

Read the following documentation for detailed information on integrating gulp tasks in SharePoint Framework:

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

SPFx 0.7.0 Node.js v6 Compatible with SharePoint Online Compatible SharePoint 2019 Compatible with SharePoint 2016 (Feature Pack 2) Local Workbench Compatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Pre-requisites

GraphicsMagick or ImageMagick

Make sure GraphicsMagick or ImageMagick is installed on your system and properly set up in your PATH.

Ubuntu:

apt-get install imagemagick
apt-get install graphicsmagick

Mac OS X (using Homebrew):

brew install imagemagick
brew install graphicsmagick

Windows & others:

http://www.imagemagick.org/script/binary-releases.php

Confirm that ImageMagick is properly set up by executing convert -help in a terminal.

Contributors

Version history

Version Date Comments
1.0 January 25th, 2017 Initial release

Minimal Path to Awesome

  • Clone this repository
  • in the command line run:
    • npm install
    • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.