serverless-offline-watcher

Run arbitrary commands when files are changed while running serverless-offline

Install

npm install --save-dev serverless-offline-watcher

Usage

Serverless configuration

Add it to your list of plugins, and custom config for what you want to do on files being changed.

The path property may be a string, or array of strings. They be file paths, directory paths or glob patterns. Under the hood this library uses chokidar for file watching and picomatch for glob patterns, so you can see there documentation for more details about supported patterns.

The event type and the changed file path are available in environment variables WATCHER_EVENT_TYPE and WATCHER_EVENT_PATH respectively. The event type comes from chokidar and is one of "add" | "addDir" | "change" | "unlink" | "unlinkDir".

serverless.yaml:

1plugins:
2  - serverless-offline
3  - serverless-offline-watcher
4
5custom:
6  serverless-offline-watcher:
7    - path: src/index.ts
8      command: echo "index.ts was modified!"
9    - path:
10        - src/api
11        - src/cow/*.js
12      command:
13        - echo "api folder or js file in cow folder was modified!"
14        - echo "the command-option can also be an array of commands"
15    - path:
16        - src/**/**
17      # this prints for example "received change event for src/path/to/file.ts"
18      command: "echo received $WATCHER_EVENT_TYPE event for $WATCHER_EVENT_PATH"

serverless.js / serverless.ts:

1export default {
2  plugins: [
3    "serverless-offline",
4    "serverless-offline-watcher",
5  ],
6  custom: {
7    'serverless-offline-watcher': [
8      {
9        path: "src/index.ts",
10        command: `echo "index.ts was modified!"`,
11      },
12      {
13        path: ["src/api", "src/cow/*.js"],
14        command: `echo "api folder or js file in cow folder was modified!"`,
15      },
16    ],
17  },
18}

In addition to running arbitrary shell commands, the plugin can also invoke a hook in some other serverless plugin, with the hook option. The following will ask serverless-offline to clear its Worker cache when a file in the src directory is changed:

1    - path:
2        - src/**/*
3      hook:
4        - offline:functionsUpdated

Running serverless-offline

Use serverless offline start instead of serverless offline, if you aren't already. This is necessary for serverless-offline to fire off init and end lifecycle hooks so that we can start and stop the watch server correctly.