{"id":18774208,"url":"https://github.com/leny/gulp-supervisor","last_synced_at":"2025-07-11T00:39:09.188Z","repository":{"id":14574140,"uuid":"17290315","full_name":"leny/gulp-supervisor","owner":"leny","description":"Run supervisor as a gulp task for easy integration with the rest of your workflow","archived":false,"fork":false,"pushed_at":"2019-10-22T18:49:25.000Z","size":11,"stargazers_count":18,"open_issues_count":4,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-31T02:12:00.610Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leny.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-02-28T15:32:57.000Z","updated_at":"2019-10-22T18:49:27.000Z","dependencies_parsed_at":"2022-09-11T09:41:19.361Z","dependency_job_id":null,"html_url":"https://github.com/leny/gulp-supervisor","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/leny/gulp-supervisor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leny%2Fgulp-supervisor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leny%2Fgulp-supervisor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leny%2Fgulp-supervisor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leny%2Fgulp-supervisor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leny","download_url":"https://codeload.github.com/leny/gulp-supervisor/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leny%2Fgulp-supervisor/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262940593,"owners_count":23388113,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T19:37:44.235Z","updated_at":"2025-07-11T00:39:09.167Z","avatar_url":"https://github.com/leny.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gulp-supervisor\n\n![NPM version](http://img.shields.io/npm/v/gulp-supervisor.svg) ![Dependency Status](https://david-dm.org/leny/gulp-supervisor.svg) ![Downloads counter](http://img.shields.io/npm/dm/gulp-supervisor.svg) [![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)\n\n\u003e Run [supervisor](https://github.com/isaacs/node-supervisor) as a gulp task for easy configuration and integration with the rest of your workflow.\n\n* * *\n\n*This Gulp task is freely inspired from the [gulp-nodemon](https://github.com/JacksonGariety/gulp-nodemon) by [Jackson Gariety](https://github.com/JacksonGariety).*\n\n## Usage\n\n### **`supervisor( script[, options] )`**\n\nYou need to pass to supervisor the path of the **script** to monitor, and can pass an **object** with supervisor options, like this :\n\n```js\n{\n  args: [ \"dev\" ],\n  watch: [ \"bin\" ],\n  ignore: [ \"test\" ],\n  pollInterval: 500,\n  extensions: [ \"js,jade\" ],\n  exec: \"node\",\n  debug: true,\n  debugBrk: true,\n  harmony: true\n  noRestartOn: \"exit\",\n  forceWatch: true,\n  quiet: true\n}\n```\n\n#### Options\n\nThe following options corresponds to the available options from [supervisor](https://github.com/isaacs/node-supervisor). If you don't pass these options to the grunt tasks, the default values of supervisor will be used. \n\n##### args\nType: `Array` of `Strings`  \nList of arguments to be passed to your script.\n\n##### watch\nType: `Array` of `Strings`  \nList of folders or js files to watch for changes.  \n\n##### ignore\nType: `Array` of `Strings`  \nList of folders to ignore for changes.  \n\n##### pollInterval\nType: `Number` of **milliseconds**  \nHow often to poll watched files for changes.\n\n##### extensions\nType: `Array` of `Strings`  \nList of file extensions to watch for changes.\n\n##### exec\nType: `String`  \nThe executable that runs the specified script.\n\n##### debug\nType: `Boolean`  \nStarts node with `--debug` flag.\n\n##### debugBrk\nType: `Boolean`  \nStarts node with `--debug-brk` flag.\n\n##### harmony\nType: `Boolean`  \nStarts node with `--harmony` flag.\n\n##### noRestartOn\nType: `String`, `\"error\"` or `\"exit\"`  \nDon't automatically restart the supervised program if it ends.  \nSupervisor will wait for a change in the source files.  \nIf \"error\", an exit code of 0 will still restart.  \nIf \"exit\", no restart regardless of exit code.\n\n##### forceWatch\nType: `Boolean`  \nUse fs.watch instead of fs.watchFile.  \nThis may be useful if you see a high cpu load on a windows machine.\n\n##### quiet\nType: `Boolean`  \nSuppress DEBUG messages\n\n## Example\n\n```js\n// Gulpfile.js\nvar gulp = require( \"gulp\" ),\n    supervisor = require( \"gulp-supervisor\" );\n\ngulp.task( \"supervisor-simple\", function() {\n    supervisor( \"test/fixture/server.js\" );\n} );\n\ngulp.task( \"supervisor-all\", function() {\n    supervisor( \"test/fixture/server.js\", {\n        args: [],\n        watch: [ \"test\" ],\n        ignore: [ \"tasks\" ],\n        pollInterval: 500,\n        extensions: [ \"js\" ],\n        exec: \"node\",\n        debug: true,\n        debugBrk: false,\n        harmony: true,\n        noRestartOn: false,\n        forceWatch: true,\n        quiet: false\n    } );\n} );\n```\n\n## Release History\n\n* **0.1.0**: Initial release (*28/02/14*)\n\n## TODO\n\nWrite tests :)\n\n## License\nCopyright (c) 2014 Leny  \nLicensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleny%2Fgulp-supervisor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleny%2Fgulp-supervisor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleny%2Fgulp-supervisor/lists"}