{"id":15207344,"url":"https://github.com/shellscape/gulp-assist","last_synced_at":"2025-10-03T01:30:45.415Z","repository":{"id":57256833,"uuid":"78173452","full_name":"shellscape/gulp-assist","owner":"shellscape","description":"Display helpful information for your Gulp tasks","archived":true,"fork":false,"pushed_at":"2018-01-24T10:25:31.000Z","size":119,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-17T10:36:13.654Z","etag":null,"topics":["assistant","cli","console","gulp","gulp-plugin","gulp-tasks","gulpjs","help","module","npm","taskname","terminal"],"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/shellscape.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-06T04:23:20.000Z","updated_at":"2023-01-28T21:12:04.000Z","dependencies_parsed_at":"2022-08-25T02:40:45.685Z","dependency_job_id":null,"html_url":"https://github.com/shellscape/gulp-assist","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellscape%2Fgulp-assist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellscape%2Fgulp-assist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellscape%2Fgulp-assist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellscape%2Fgulp-assist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shellscape","download_url":"https://codeload.github.com/shellscape/gulp-assist/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235059234,"owners_count":18929279,"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":["assistant","cli","console","gulp","gulp-plugin","gulp-tasks","gulpjs","help","module","npm","taskname","terminal"],"created_at":"2024-09-28T06:41:50.011Z","updated_at":"2025-10-03T01:30:45.114Z","avatar_url":"https://github.com/shellscape.png","language":"JavaScript","readme":"# gulp-assist\n\nDisplay helpful information for your Gulp tasks\n\n## \u0026nbsp;\n\u003cp align=\"center\"\u003e\n  \u003cb\u003e:rocket: \u0026nbsp; Are you ready to tackle ES6 and hone your JavaScript Skills?\u003c/b\u003e \u0026nbsp; :rocket:\u003cbr/\u003e\n  Check out these outstanding \u003ca href=\"https://es6.io/friend/POWELL\"\u003eES6 courses\u003c/a\u003e by \u003ca href=\"https://github.com/wesbos\"\u003e@wesbos\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\ngulp-assist presents basic info registered tasks in a stylish format by extending\n`gulp` with an additional method to describe tasks and their flags. gulp-assist\ndoes not modify existing `gulp` methods or API.\n\n\u003cimg src=\"https://github.com/shellscape/gulp-assist/blob/master/gulp-assist.png?raw=true\" width=\"569\"\u003e\n\nAnd info for each individual task including flags and their descriptions.\n\n\u003cimg src=\"https://github.com/shellscape/gulp-assist/blob/master/gulp-assist-task.png?raw=true\" width=\"570\"\u003e\n\n## Install\n\n```\n$ npm install gulp-assist --save-dev\n```\n\n## Usage\n\n```js\nconst gulp = require('gulp');\n\n// initialize the module\nrequire('gulp-assist')();\n\ngulp.task('lint', () =\u003e\n\t// ...\n);\n\ngulp.assist('lint', {\n  desc: 'Analyzes code for errors and convention violations.',\n  flags: {\n    src: 'Specifies a directory / module to inspect, within the `src` directory.'\n  }\n});\n```\n\n## API\n\n### default([options])\n\n#### options\n\nExample Usage of all options:\n\n```js\nconst gulp = require('gulp');\nlet taskName = 'default';\n\nrequire('gulp-assist')({ gulp, taskName })\n```\n\n##### gulp\n\nType: `Object`  \nDefault: `null`\n\nThe module has the ability to use a `gulp` instance already required. If this\noption is not specified, the module will require `gulp` internally. In most cases\nthis will use the shared instance.\n\n##### taskName\n\nType: `String`  \nDefault: `'help'`\n\nThe name of the task that gulp-assist should use as the entry point.\n\n### gulp.assist(taskName, options)\n\nRegisters a task with gulp-assist.\n\n#### options\n\n##### desc\n\nType: `String`  \nDefault: `null`\n\nA description of the task being registered.\n\n##### flags\n\nType: `Object`  \nDefault: `null`\n\nAn object whose keys represent a flag name. gulp-assist automagically prepends a\ndouble hypen to each flag name when displaying task details. The value for each\nkey should represent the description of the flag.\n\n\n## License\n\nMIT © [Andrew Powell](http://shellscape.org)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellscape%2Fgulp-assist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshellscape%2Fgulp-assist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellscape%2Fgulp-assist/lists"}