- Clone the repository locally and open in VS Code
- Run "Extensions: Show Recommended Extensions" from the command palette and install all extensions listed under "Workspace Recommendations"
- Run
npm install
- Run
npm run build
- Run
npm link
- Create or open a local function app to test with
- In the local function app:
- Run
npm link @azure/functions
. This will point your app to the local repository for the@azure/functions
package - Add the following settings to your "local.settings.json" file or configure them directly as environment variables
languageWorkers__node__arguments
:--inspect
💡 Tip: Set
logging__logLevel__Worker
todebug
if you want to view worker-specific logs in the output offunc start
- Start the app (i.e. run
func start
or press F5)
- Run
- Back in the framework repository, press F5 and select the process for your running function app
- Before you submit a PR, run
npm test
and fix any issues. If you want to debug the tests, switch your launch profile in VS Code to "Launch Unit Tests" and press F5.
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.
The type definitions are located in the types
folder. Please make sure to update the tests in ./test/types/index.test.ts
as well.