mods-toolkit-plugin-spfx

Project

This repo is a sample MODS plugin of SFPx

Requirements

• node = 10.x.x

Suggest a node version managerment softwate if you want to switch different node versions in your machine: https://github.com/coreybutler/nvm-windows

Loopup current version:

nvm list 

Select one version:

nvm use 10.23.0 

How to use this plugin

1. open command palette: "MODS: create a new project"
2. select "tab"
3. select "SharepointFramework, version: 0.1.0"
4. input webpart name
5. input description
6. select "none" as frontend framework
7. select the root folder from where your project will be created in
8. after scafolding, go to terminal and execute: "npm install" to install the depedended plugin
9. open command palette: "MODS: Deploy(all)"
10. then the plugin will start some commands in terminal to bundle the projectd
11. TODO

How to publish/unpublish your own plugin

Currently, we publish our plugins into the private registry:

npm config set registry http://10.172.22.60:4873/

go to your plugin project folder and publish the plugin by:

npm publish

You can also unpublish a plugin by:

npm unpublish $your_plugin_name@$version

How to debug your plugin

Go to your home folder:

cd $HOME/.mods/

Install your plugin in this folder:

npm install /path/to/your/plugin --save-dev 

Then, you need to launch the MODS-toolkit-extension project: (https://github.com/OfficeDev/MODS-toolkit-extension branch:release-0.1.0)

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.