# samwatch

> Monitor file changes while working with AWS SAM and Lambda functions.

Latest version **0.0.25-development** (published 2020-06-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install samwatch
pnpm add samwatch
yarn add samwatch
bun add samwatch
```

Provides the command `samwatch`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.25-development |
| Published | 2020-06-27 |
| First published | 2020-06-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.10.0 |
| Dependencies | 2 |
| Unpacked size | 5.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | MXITGO |
| Maintainers | emartinezmxitgo |
| Keywords | monitor, development, restart, autoload, reload, terminal, AWS, SAM, Serverless, Lambda |

## Links

- npm: https://www.npmjs.com/package/samwatch
- Repository: https://github.com/mxitgo/samwatch
- Homepage: https://mxitgo.com/
- Issues: https://github.com/mxitgo/samwatch/issues
- npm.io page: https://npm.io/package/samwatch

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [nodemon](https://npm.io/package/nodemon.md) ^2.0.4

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.0.25-development (latest) — 2020-06-27
- 0.0.23-development — 2020-06-27
- 0.0.22-development — 2020-06-27
- 0.0.21-development — 2020-06-27
- 0.0.20-development — 2020-06-27
- 0.0.19-development — 2020-06-27
- 0.0.18-development — 2020-06-27
- 0.0.17-development — 2020-06-27
- 0.0.16-development — 2020-06-27
- 0.0.15-development — 2020-06-27
- 0.0.14-development — 2020-06-27
- 0.0.13-development — 2020-06-27
- 0.0.12-development — 2020-06-27
- 0.0.11-development — 2020-06-27
- 0.0.10-development — 2020-06-27
- … 10 more at https://npm.io/package/samwatch/versions

## README

# samwatch

samwatch is a tool based in nodemon that helps you monitor and transport your changes from your source tree structure to the .sam-build tree structure while developing with AWS SAM. 

samwatch detects changes in your source files, and if the current changed file already exists inside the .sam-build tree structure, it makes a copy of it in the corresponding .sam-build location, keeping your source and .sam-build folders in sync. 

If no corresponding file is available in the .sam-build tree structure, samwatch will issue a "sam build" command. 

This behavior can reduce the use of "sam build" from every time you make a change to only once whenever you need to add new files or folders to the .sam-build folder structure.

# Installation

Either through cloning with git or by using [npm](http://npmjs.org) (the recommended way):

```bash
npm install samwatch -g
```

# Usage

Go to the root of your development and run:

```bash
samwatch
```

This will start samwatch. 

Next, you can start working with your files, and samwatch will copy the saved changes to .sam-build folder.

# Command line options

```bash
samwatch n
```
If you wish samwatch just to notify about the missing file and not run sam build after the error, use n or notify argument

# Demo

Running samwatch, saving the modified file, sam-build folder gets updated.

![](https://github.com/mxitgo/samwatch/blob/master/media/screen.gif?raw=true)

# License

MIT [http://rem.mit-license.org](http://rem.mit-license.org)

---
_Source: https://npm.io/package/samwatch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._