# sails-hook-autoreload

> Sails JS hook to autoreload controllers and models when changed.

Latest version **1.1.0** (published 2017-10-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install sails-hook-autoreload
pnpm add sails-hook-autoreload
yarn add sails-hook-autoreload
bun add sails-hook-autoreload
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2017-10-25 |
| First published | 2014-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 228 |
| Author | Balderdash |
| Maintainers | sgress454 |

## Links

- npm: https://www.npmjs.com/package/sails-hook-autoreload
- Repository: https://github.com/sgress454/sails-hook-autoreload
- Issues: https://github.com/sgress454/sails-hook-autoreload/issues
- npm.io page: https://npm.io/package/sails-hook-autoreload

## Dependencies (2)

- [chokidar](https://npm.io/package/chokidar.md) ^1.0.0
- [@sailshq/lodash](https://npm.io/package/@sailshq/lodash.md) ^3.10.2

## Recent versions

- 1.1.0 (latest) — 2017-10-25
- 0.14.3 (for-sails-0.12) — 2017-10-02
- 0.14.1 — 2017-03-21
- 1.0.0 — 2017-03-14
- 0.14.0 — 2017-03-14
- 0.13.2 — 2016-06-28
- 0.13.1 — 2016-02-11
- 0.13.0 — 2016-01-21
- 0.12.0 — 2015-08-06
- 0.11.5 — 2015-03-19
- 0.11.4 — 2015-02-18
- 0.11.2 — 2014-12-15
- 0.11.0 — 2014-12-03

## README

# :family: :family: :family: Community maintened package :family: :family: :family: 

The **sails-hook-autoreload** package is no longer maintained as an official Sails hook.  Use at your own risk.  If you are interested in continuing development on this hook, please contact [@sgress454](@sgress454).  
It is now maintained by sails lovers instead of the official sails team. 

*We are still actively maintaining [Sails](https://github.com/balderdashy/sails), and using it in all sorts of production-level apps.  We’re just ending support for this hook.*

Thanks for using [Sails](https://github.com/balderdashy/sails)!

# sails-hook-autoreload

[Sails JS](http://sailsjs.org) hook to autoreload controllers, models, services and locales when changed.

This hook is to help with situations where you are rapidly prototyping/tinkering with app code and don't want to have to keep quitting/restarting Sails to see your changes.  It is not intended to be used in a production environment.  _It also may not work properly in conjunction with other Sails plugins, especially ones that operate on models or watch for file changes!_

##### Incompatible plugins

If your app uses a plugin that adds or modifies models, services, controllers or locales, `sails-hook-autoreload` is unlikely to work properly.  Here's an incomplete list of such plugins:

`sails-auto-admin`,` sails-auth`,` sails-auth-bugfix-zb`,` sails-auth-no-test`,` sails-hook-admin`,` sails-hook-confirmations`,` sails-magik-swagger`,` sails-passport-hook`,` sails-permissions`,` sails-permissions-sequelize`,` sails-swagger`,` sails-swagger-bk`,` sails-swagger-spec`,` sails-webpack`,` cision-sails-auth`,` cision-sails-permissions`,` nx-sails-swagger`,` vanuan-sails-swagger`, and any package that depends on `marlinspike`.

> Note: this is not a statement on the quality of the above packages.  They’re simply incompatible with `sails-hook-autoreload`.

##### _Can't I just use [`forever`](https://github.com/foreverjs/forever) or [`nodemon`](https://github.com/remy/nodemon) or [insert daemon here] to do this_?

Yes, yes, you absolutely can, and if stability during development is your #1 concern, you absolutely should.  Nothing beats a cold reboot to get that oh-so-pristine app state.  The advantages of this hook are (1) it's faster, (2) it won't run your bootstrap every time (see #1), and (3) it won't drop your sessions / socket connections if you're using in-memory adapters during development.

### Installation

FOR SAILS v0.12.x:
`npm install sails-hook-autoreload@for-sails-0.12`

FOR SAILS 1.0:
`npm install sails-hook-autoreload`

### Usage
*requires at least sails >= 0.11*

Just lift your app as normal, and when you add / change / remove a model, controller or service file, *all* controllers, models, and services will be reloaded without having to lower / relift the app. This includes all blueprint routes.

> `sails-hook-autoreload` will, by default, use the `migrate: alter` strategy when reloading model files unless you explicitly set the `overrideMigrateSetting` config to `false`.  This allows you to change models without losing your development data when you have `migrate: drop` set.

### Configuration

By default, configuration lives in `sails.config.autoreload`.  The configuration key (`autoreload`) can be changed by setting `sails.config.hooks['sails-hook-autoreload'].configKey`.

Parameter      | Type                | Details
-------------- | ------------------- |:---------------------------------
active        | ((boolean)) | Whether or not the hook should watch for controller / model / service changes.  Defaults to `true`.
overrideMigrateSetting | ((boolean)) | Whether or not the hook should reload the app using the `alter` migrate setting, regardless of what is set in `sails.config.models.migrate`.  Defaults to `true`.  Note that this will have no effect on models with `migrate` settings of their own that override the global setting.
usePolling    | ((boolean)) | Whether or not to use the polling feature. Slower but necessary for certain environments. Defaults to `false`.
dirs          | ((array)) | Array of strings indicating which folders should be watched.  Defaults to the `api/models`, `api/controllers`, and `api/services` folders. Note that this won't change the set of files being reloaded, but the set of files being watched for changes. As for now, it's not possible to add new directories to be reloaded.
ignored       | ((array\|string\|regexp\|function)) |  Files and/or directories to be ignored. Pass a string to be directly matched, string with glob patterns, regular expression test, function that takes the testString as an argument and returns a truthy value if it should be matched, or an array of any number and mix of these types. For more examples look up [anymatch docs](https://github.com/es128/anymatch).

#### Example

```javascript
// [your-sails-app]/config/autoreload.js
module.exports.autoreload = {
  active: true,
  usePolling: false,
  dirs: [
    "api/models",
    "api/controllers",
    "api/services",
    "config/locales"
  ],
  ignored: [
    // Ignore all files with .ts extension
    "**.ts"
  ]
};

```

That’s it!

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