{"id":16218677,"url":"https://github.com/loginov-rocks/gulpdoc","last_synced_at":"2026-04-26T23:31:18.705Z","repository":{"id":55370770,"uuid":"117437258","full_name":"loginov-rocks/gulpdoc","owner":"loginov-rocks","description":"Documentation generator for Gulp tasks","archived":false,"fork":false,"pushed_at":"2021-03-13T12:17:22.000Z","size":103,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-20T14:57:02.636Z","etag":null,"topics":["doc","documentation","generator","gulp","tasks"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/gulpdoc","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/loginov-rocks.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":"2018-01-14T14:27:34.000Z","updated_at":"2021-03-13T12:17:24.000Z","dependencies_parsed_at":"2022-08-14T22:41:56.347Z","dependency_job_id":null,"html_url":"https://github.com/loginov-rocks/gulpdoc","commit_stats":null,"previous_names":["1oginov/gulpdoc"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/loginov-rocks/gulpdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loginov-rocks%2Fgulpdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loginov-rocks%2Fgulpdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loginov-rocks%2Fgulpdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loginov-rocks%2Fgulpdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loginov-rocks","download_url":"https://codeload.github.com/loginov-rocks/gulpdoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loginov-rocks%2Fgulpdoc/sbom","scorecard":{"id":112506,"data":{"date":"2025-08-04","repo":{"name":"github.com/loginov-rocks/gulpdoc","commit":"17dc829530a999fe3ef46d574ddccb455441f049"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":2.8,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cd.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/loginov-rocks/gulpdoc/cd.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cd.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/loginov-rocks/gulpdoc/cd.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/loginov-rocks/gulpdoc/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/loginov-rocks/gulpdoc/ci.yml/main?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   2 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"Code-Review","score":0,"reason":"Found 0/4 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/cd.yml:1","Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":1,"reason":"9 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-15T12:54:21.827Z","repository_id":55370770,"created_at":"2025-08-15T12:54:21.827Z","updated_at":"2025-08-15T12:54:21.827Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32317162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"ssl_error","status_checked_at":"2026-04-26T23:26:25.802Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["doc","documentation","generator","gulp","tasks"],"created_at":"2024-10-10T11:50:16.131Z","updated_at":"2026-04-26T23:31:18.686Z","avatar_url":"https://github.com/loginov-rocks.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gulpdoc\n\n[![npm](https://img.shields.io/npm/v/gulpdoc)](https://www.npmjs.com/package/gulpdoc)\n[![CI](https://github.com/loginov-rocks/gulpdoc/actions/workflows/ci.yml/badge.svg)](https://github.com/loginov-rocks/gulpdoc/actions/workflows/ci.yml)\n[![CD](https://github.com/loginov-rocks/gulpdoc/actions/workflows/cd.yml/badge.svg)](https://github.com/loginov-rocks/gulpdoc/actions/workflows/cd.yml)\n\nDocumentation generator for Gulp tasks.\n\n## Quick Start\n\n### Install\n\nLocally to use in code:\n\n```sh\nnpm install gulpdoc\n```\n\nOr globally to use in shell:\n\n```sh\nnpm install -g gulpdoc\n```\n\n### Use\n\nFor example your javascript files containing Gulp tasks are located in the `./gulp/` directory relative to the current.\n\nAnnotate Gulp tasks with `@gulptask` (case insensitive) and place descriptions like this:\n\n```js\n/**\n * Gulp task described in block comment before the annotation.\n * @gulptask example:block\n */\ngulp.task('example:block', function() {\n  // Insanely useful actions.\n});\n```\n\n```js\n// @gulptask example:line Gulp task described in line comment on the annotation line.\ngulp.task('example:line', function() {\n  // Insanely useful actions.\n});\n```\n\n#### Сode\n\n```js\nconst gulpdoc = require('gulpdoc');\nconst tasks = gulpdoc.getTasks('./gulp/*.js');\n\nconsole.log(tasks);\n// Output:\n// [ Task { name: 'example:block', description: 'Gulp task described in block comment before the annotation.' },\n//   Task { name: 'example:line', description: 'Gulp task described in line comment on the annotation line.' } ]\n```\n\n#### Shell\n\n```sh\ngulpdoc ./gulp/*.js\n```\n\nor\n\n```sh\ngulpdoc -s ./gulp/*.js -d ./gulpdoc.md -a gulptask\n```\n\nWhere `-s` is source, `-d` is destination and `-a` is annotation. \n\nIt'll make following `gulpdoc.md`:\n\n\u003e * `gulp example:block` - Gulp task described in block comment before the annotation.\n\u003e * `gulp example:line` - Gulp task described in line comment on the annotation line.\n\n## API\n\n### `Gulpdoc`\n\nGulpdoc class.\n\n**Kind**: global class\n\n* [Gulpdoc](#gulpdoc-1)\n  * [getTasks(pattern, [annotation], [options]) ⇒ Array.\u0026lt;Task\u0026gt;](#gettaskspattern-annotation-options--arraytask)\n\n---\n\n#### `getTasks(pattern, [annotation], [options])` ⇒ `Array.\u003cTask\u003e`\n\nGet tasks.\n\n**Kind**: static method of `Gulpdoc`\n\n**Returns**: `Array.\u003cTask\u003e`, where `Task` object contains `name` and `description` properties\n\n| Parameter    | Type     | Default      | Description  |\n| ------------ | -------- | ------------ | ------------ |\n| pattern      | `string` |              | Glob pattern |\n| [annotation] | `string` | `'gulptask'` | Annotation   |\n| [options]    | `Object` | `{}`         | Glob options |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floginov-rocks%2Fgulpdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floginov-rocks%2Fgulpdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floginov-rocks%2Fgulpdoc/lists"}