These packages provide functionality which can be used to perform tasks related to Office Add-ins. The packages export functions which can be imported and used in Node scripts. Many of the packages also provide a command-line interface (CLI), allowing them to be used directly from a Command Prompt / Terminal window.
The Yo Office templates provide a starting point for developing an Office Add-in. These scripts are used in the templates to provide for basic developer tasks such as debugging.
Developers may have other workflows with different requirements and tooling. Our goal is for the these packages to serve as building blocks which can be adapted as needed. We encourage feedback and contributions from the community.
The Excel Custom Functions project provides an example of how these packages may be used.
-
This package allows metadata for custom functions to be generated automatically from JSDoc tags and the function parameter types.
-
custom-functions-metadata-plugin
A WebPack plugin which generates the metadata for custom functions.
-
This package provides the orchestration of components related to debugging Office Add-ins. When debugging is started, it will ensure that the dev-server is running, that dev settings are configured for debugging, and will register and sideload the Office Add-in. When debugging is stopped, it will unregister and shutdown components.
-
This package can be used to manage certificates for development server using https://localhost.
-
This package can be used to configure developer settings for an Office Add-in.
-
This package provides the ability to parse, display, and modify the manifest file for Office Add-ins.
-
This package allows a Node instance to serve as a proxy for debugging a JavaScript runtime hosted by an Office application.
In a command prompt, run:
npm install
This should also be done when after pulling additional changes or switching branches.
To build all packages, at the root directory, run:
npm run build
To build a single package, in the directory for the package, run:
npm run build
To run tests for all packages, at the root directory, run:
npm run test
To run tests for a single package, in the directory for the package, run:
npm run test
Use VS Code
to edit, build, test, and debug by opening the package folder in VS Code.
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.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., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
-
Ask a question on Stack Overflow.
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [email protected]. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
Code licensed under the MIT License.