https://github.com/steinathan/sails-hook-watch
Sails JS hook to watch and reload controllers and models when changed
https://github.com/steinathan/sails-hook-watch
Last synced: 11 months ago
JSON representation
Sails JS hook to watch and reload controllers and models when changed
- Host: GitHub
- URL: https://github.com/steinathan/sails-hook-watch
- Owner: steinathan
- Created: 2019-01-09T22:41:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-07T01:27:31.000Z (over 7 years ago)
- Last Synced: 2025-04-12T02:39:03.268Z (about 1 year ago)
- Language: JavaScript
- Size: 85.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Thanks for using [Sails](https://github.com/balderdashy/sails)!
[](https://travis-ci.com/navicstein/sails-hook-watch)
# sails-hook-watch
[Sails JS](http://sailsjs.org) hook to watch and reload 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!_
It also serves as a life saver if you're working with sails + nuxt sitting in the same enviroment where builds take a while to complete
##### _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:-
- it's faster,
- it won't run your bootstrap every time (see #1), and
- it won't drop your sessions / socket connections if you're using in-memory adapters during development.
### Installation
only in developing enviroment
```sh
npm i --save-dev sails-hook-watch
```
### Usage
The first thing to do (sails ^v1) is to make sure that `sails.config.models.archiveModelIdentity'` is `false`
for example in your `models.config` file
```js
module.exports.models = {
archiveModelIdentity: false
// ... other configs
};
```
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-watch` 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.watch`. The configuration key (`watch`) can be changed by setting `sails.config.hooks['sails-hook-watch'].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/watch.js
module.exports.watch = {
active: true,
usePolling: false,
dirs: ["api/models", "api/controllers", "api/services", "config/locales"],
ignored: [
// Ignore all files with .ts extension
"**.ts",
"node_modules"
]
};
```
That’s it!
Navicstein Rotciv