{"id":15699010,"url":"https://github.com/pgilad/gulp-todo","last_synced_at":"2025-10-30T19:08:02.955Z","repository":{"id":14045254,"uuid":"16747899","full_name":"pgilad/gulp-todo","owner":"pgilad","description":"Generate a TODO.md from todos \u0026 fixmes in your code using Gulp stream","archived":false,"fork":false,"pushed_at":"2019-02-13T09:17:57.000Z","size":232,"stargazers_count":91,"open_issues_count":0,"forks_count":23,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-09-26T08:02:02.464Z","etag":null,"topics":["comments","fixme","gulp","gulp-stream","javascript","plugin","stream","todo"],"latest_commit_sha":null,"homepage":"","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/pgilad.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":"2014-02-11T22:27:51.000Z","updated_at":"2024-07-17T16:01:55.000Z","dependencies_parsed_at":"2022-08-31T20:00:49.704Z","dependency_job_id":null,"html_url":"https://github.com/pgilad/gulp-todo","commit_stats":null,"previous_names":[],"tags_count":56,"template":false,"template_full_name":null,"purl":"pkg:github/pgilad/gulp-todo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgilad%2Fgulp-todo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgilad%2Fgulp-todo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgilad%2Fgulp-todo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgilad%2Fgulp-todo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pgilad","download_url":"https://codeload.github.com/pgilad/gulp-todo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgilad%2Fgulp-todo/sbom","scorecard":{"id":730106,"data":{"date":"2025-08-11","repo":{"name":"github.com/pgilad/gulp-todo","commit":"3fd0dbcd8fd2275f6cd3f8b50405c9c05dfef443"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"name":"Code-Review","score":1,"reason":"Found 3/30 approved changesets -- score normalized to 1","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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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 3 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T14:09:57.188Z","repository_id":14045254,"created_at":"2025-08-22T14:09:57.188Z","updated_at":"2025-08-22T14:09:57.188Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281863234,"owners_count":26574798,"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","status":"online","status_checked_at":"2025-10-30T02:00:06.501Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["comments","fixme","gulp","gulp-stream","javascript","plugin","stream","todo"],"created_at":"2024-10-03T19:37:22.298Z","updated_at":"2025-10-30T19:08:02.927Z","avatar_url":"https://github.com/pgilad.png","language":"JavaScript","readme":"# [gulp](https://github.com/wearefractal/gulp)-todo\n\u003e Parse and output TODOs and FIXMEs from comments in your file in a stream\n\n[![NPM Version](http://img.shields.io/npm/v/gulp-todo.svg?style=flat)](https://npmjs.org/package/gulp-todo)\n[![NPM Downloads](http://img.shields.io/npm/dm/gulp-todo.svg?style=flat)](https://npmjs.org/package/gulp-todo)\n[![Build Status](http://img.shields.io/travis/pgilad/gulp-todo.svg?style=flat)](https://travis-ci.org/pgilad/gulp-todo)\n\nParse your files in a gulp-stream, extracting todos/fixmes from comments and reporting them\nin a reporter to your choosing using [leasot](https://github.com/pgilad/leasot).\n\nIssues with the output should be reported on the [leasot issue tracker](https://github.com/pgilad/leasot/issues)\n\n**Supports latest `leasot` version `7.0.0`.**\n\n**Please upgrade carefully to version `7.0.0`, there were breaking changes in the `gulp-todo` API**\n\n## Install\n\nInstall with [npm](https://npmjs.org/package/gulp-todo)\n\n```sh\n$ npm install --save-dev gulp-todo\n```\n\n## Usage\n\n```js\nconst gulp = require('gulp');\nconst todo = require('gulp-todo');\n\n// generate a todo.md from your javascript files\ngulp.task('todo', function() {\n    gulp.src('js/**/*.js')\n        .pipe(todo())\n        .pipe(gulp.dest('./'));\n        // -\u003e Will output a TODO.md with your todos\n});\n\n// generate todo from your jade files\ngulp.task('todo-jade', function() {\n    gulp.src('partials/**/*.jade')\n        .pipe(todo({ fileName: 'jade-todo.md' }))\n        .pipe(gulp.dest('./'));\n        // -\u003e Will output a jade-todo.md with your todos\n});\n\n// get filenames relative to project root (where your gulpfile is)\ngulp.task('todo-absolute', function() {\n    gulp.src('js/**/*.js')\n        .pipe(todo({\n            absolute: true\n        }))\n        .pipe(gulp.dest('./'));\n});\n\n// get relative path filenames\ngulp.task('todo-absolute', function() {\n    gulp.src('js/**/*.js', { base: '/' })\n        .pipe(todo())\n        .pipe(gulp.dest('./'));\n});\n\n// create a json output of the comments (useful for CI such as jenkins)\ngulp.task('todo-json', function () {\n    gulp.src('./**/*.js', {\n        base: './'\n    })\n        .pipe(todo({\n            fileName: 'todo.json',\n            reporter: 'json'\n        }))\n        .pipe(gulp.dest('./'));\n});\n\n// output once in markdown and then output a json file as well\ngulp.task('todo-reporters', function() {\n    gulp.src('js/**/*.js')\n        .pipe(todo())\n        .pipe(gulp.dest('./')) //output todo.md as markdown\n        .pipe(todo.reporter('json', {fileName: 'todo.json'}))\n        .pipe(gulp.dest('./')) //output todo.json as json\n});\n\n\n// Delete the todo.md file if no todos were found\nconst gulpIf = require('gulp-if');\nconst del = require('del');\nconst vinylPaths = require('vinyl-paths');\n\ngulp.task('todo-delete', function() {\n    gulp.src('js/**/*.js')\n        .pipe(todo())\n        .pipe(gulpIf(function (file) {\n            return file.todos \u0026\u0026 Boolean(file.todos.length);\n        }, gulp.dest('./'), vinylPaths(del)));\n});\n```\n\n#### Injecting the todo generated file into another template\n\nIf you want to inject the generated todo stream into another file (say a `readme.md.template`)\nyou can do the following:\n\n- Create `readme.md.template` file that contains the following marker, marking where you want to inject the generated todo file:\n\n```md\n### some previous content\n\u003c%= marker %\u003e\n```\n\n- Use the following code to inject into that markdown, creating a markdown file with the generated todo:\n\n```js\nconst fs = require('fs');\nconst path = require('path');\nconst gulp = require('gulp');\nconst todo = require('gulp-todo');\nconst template = require('lodash.template');\nconst through = require('through2');\n\ngulp.task('default', function () {\n    gulp.src('./js/**/*.js')\n        .pipe(todo())\n        .pipe(through.obj(function (file, enc, cb) {\n            //read and interpolate template\n            const tmpl = fs.readFileSync('./readme.md.template', 'utf8');\n            const compiledTpl = template(tmpl);\n            const newContents = compiledTpl({\n                'marker': file.contents.toString()\n            });\n            //change file name\n            file.path = path.join(file.base, 'readme-new.md');\n            //replace old contents\n            file.contents = Buffer.from(newContents);\n            //push new file\n            this.push(file);\n            cb();\n        }))\n       .pipe(gulp.dest('./'));\n});\n```\n\n## Supported Filetypes\n\nSee https://github.com/pgilad/leasot#supported-languages\n\n## API\n\n### todo(options)\n\n`options` is an optional configuration object, see https://github.com/pgilad/gulp-todo/blob/master/index.js#L22-L32\n\n### todo.reporter(reporter, options)\n\n`options` is an optional configuration object, see https://github.com/pgilad/gulp-todo/blob/master/lib/reporter.js#L10-L16\n\nUse another reporter in stream, will replace the contents of the output file.\nMust be used after `todo()`, since it uses the `file.todos` that are passed along.\n\nSee the example in the [usage](#usage)\n\n## License\n\nMIT © [Gilad Peleg](https://www.giladpeleg.com)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpgilad%2Fgulp-todo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpgilad%2Fgulp-todo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpgilad%2Fgulp-todo/lists"}