{"id":20551449,"url":"https://github.com/generate/generate-updatefile","last_synced_at":"2025-10-09T20:42:16.097Z","repository":{"id":57246221,"uuid":"63406551","full_name":"generate/generate-updatefile","owner":"generate","description":"Generate an updatefile.js in the current working directory or specified `--dest`.","archived":false,"fork":false,"pushed_at":"2016-07-15T09:03:08.000Z","size":132,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-24T04:43:23.875Z","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/generate.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":"2016-07-15T08:47:36.000Z","updated_at":"2017-09-25T14:23:25.000Z","dependencies_parsed_at":"2022-08-24T16:31:39.085Z","dependency_job_id":null,"html_url":"https://github.com/generate/generate-updatefile","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/generate/generate-updatefile","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-updatefile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-updatefile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-updatefile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-updatefile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/generate","download_url":"https://codeload.github.com/generate/generate-updatefile/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-updatefile/sbom","scorecard":{"id":422311,"data":{"date":"2025-08-11","repo":{"name":"github.com/generate/generate-updatefile","commit":"b73d28e3f936c479bda8f7a84136226a98215906"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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":"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":"Code-Review","score":0,"reason":"Found 0/3 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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"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":"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":"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":"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":"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":"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":"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":"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"}}]},"last_synced_at":"2025-08-19T01:31:41.917Z","repository_id":57246221,"created_at":"2025-08-19T01:31:41.917Z","updated_at":"2025-08-19T01:31:41.917Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001981,"owners_count":26083259,"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-09T02:00:07.460Z","response_time":59,"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":[],"created_at":"2024-11-16T02:31:02.299Z","updated_at":"2025-10-09T20:42:16.055Z","avatar_url":"https://github.com/generate.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generate-updatefile [![NPM version](https://img.shields.io/npm/v/generate-updatefile.svg?style=flat)](https://www.npmjs.com/package/generate-updatefile) [![NPM downloads](https://img.shields.io/npm/dm/generate-updatefile.svg?style=flat)](https://npmjs.org/package/generate-updatefile) [![Build Status](https://img.shields.io/travis/generate/generate-updatefile.svg?style=flat)](https://travis-ci.org/generate/generate-updatefile)\n\n\u003e Generate an updatefile.js for [update](https://github.com/update/update) in the current working directory or specified `--dest`.\n\n\u003cbr\u003e\n![generate-updatefile demo](https://raw.githubusercontent.com/generate/generate-updatefile/master/demo.gif)\n\n## Table of Contents\n\n- [What is \"Generate\"?](#what-is-generate)\n- [Command line usage](#command-line-usage)\n  * [Install](#install)\n  * [Run](#run)\n  * [Help](#help)\n- [CLI Usage](#cli-usage)\n  * [Running tasks](#running-tasks)\n  * [Available tasks](#available-tasks)\n- [API usage](#api-usage)\n  * [Install locally](#install-locally)\n  * [Use as a plugin](#use-as-a-plugin)\n  * [Register as a generator](#register-as-a-generator)\n- [Running multiple generators](#running-multiple-generators)\n  * [generate-install](#generate-install)\n  * [generate-dest](#generate-dest)\n- [Customization](#customization)\n  * [Destination directory](#destination-directory)\n  * [Overriding templates](#overriding-templates)\n- [Next steps](#next-steps)\n- [About](#about)\n  * [Related projects](#related-projects)\n  * [Contributing](#contributing)\n  * [Running tests](#running-tests)\n  * [Author](#author)\n  * [License](#license)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## What is \"Generate\"?\n\nGenerate is a command line tool and developer framework for scaffolding out new GitHub projects using [generators](https://github.com/generate/generate/blob/master/docs/generators.md) and [tasks](https://github.com/generate/generate/blob/master/docs/tasks.md). Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for [gulp](http://gulpjs.com), [base](https://github.com/node-base/base) and [assemble](https://github.com/assemble/assemble) plugins, and much more.\n\nFor more information about Generate:\n\n* Visit the [generate project](https://github.com/generate/generate)\n* Visit the [generate documentation](https://github.com/generate/generate/blob/master/docs/)\n* Find [generators on npm](https://www.npmjs.com/browse/keyword/generate-generator) (help us [author generators](https://github.com/generate/generate/blob/master/docs/micro-generators.md))\n\n## Command line usage\n\n### Install\n\n**Installing the CLI**\n\nTo run the `updatefile` generator from the command line, you'll need to install [generate](https://github.com/generate/generate) globally first. You can do that now with the following command:\n\n```sh\n$ npm install --global generate\n```\n\nThis adds the `gen` command to your system path, allowing it to be run from any directory.\n\n**Install generate-updatefile**\n\nYou may now install this module with the following command:\n\n```sh\n$ npm install --global generate-updatefile\n```\n\n### Run\n\nYou should now be able to run `generate-updatefile` with the following command:\n\n```sh\n$ gen updatefile\n```\n\n**What will happen?**\n\nRunning `$ gen updatefile` will run the generator's [default task](#default), which will:\n\n1. prompt you for any information that's missing\n2. render the necessary template(s) using your answers\n3. write [the resulting files](#available-tasks) to the current working directory\n\n**What you should see in the terminal**\n\nIf completed successfully, you should see both `starting` and `finished` events in the terminal, like the following:\n\n```sh\n[00:44:21] starting ...\n...\n[00:44:22] finished ✔\n```\n\nIf you do not see one or both of those events, please [let us know about it](../../issues).\n\n### Help\n\nTo see a general help menu and available commands for Generate's CLI, run:\n\n```sh\n$ gen help\n```\n\n## CLI Usage\n\n### Running tasks\n\nTasks on `generate-updatefile` are run by passing the name of the task to run after the generator name, delimited by a comma:\n\n```sh\n$ gen updatefile:foo\n       ^       ^\ngenerator     task\n```\n\n**Example**\n\nThe following will run generator `foo`, task `bar`:\n\n```sh\n$ gen foo:bar\n```\n\n**Default task**\n\nWhen a task name is not explicitly passed on the command line, Generate's CLI will run the [default](#default) task.\n\n### Available tasks\n\n#### [updatefile](generator.js#L19)\n\nGenerate an `updatefile.js` file to the current working directory.\n\n**Example**\n\n```sh\n$ gen updatefile\n$ gen updatefile --dest ./docs\n```\n\nVisit Generate's [documentation for tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).\n\n## API usage\n\nUse `generate-updatefile` as a [plugin](https://github.com/generate/generate/blob/master/docs/plugins.md) in your own [generator](https://github.com/generate/generate/blob/master/docs/generators.md).\n\n### Install locally\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save generate-updatefile\n```\n\n### Use as a plugin\n\nWhen used as a plugin, tasks from `generate-updatefile` are added to your generator's instance.\n\n```js\nmodule.exports = function(app) {\n  app.use(require('generate-updatefile'));\n  // do generator stuff\n};\n```\n\n**Running tasks**\n\nYou can now run any tasks from `generate-updatefile` as if they were part of your own generator.\n\n```js\nmodule.exports = function(app) {\n  app.use(require('generate-updatefile'));\n\n  app.task('foo', function(cb) {\n    // do task stuff\n    cb();\n  });\n\n  // run the `mit` task from `generate-updatefile`\n  app.task('default', ['foo', 'mit']);\n};\n```\n\n### Register as a generator\n\nWhen registered as a generator, tasks from `generate-updatefile` are added to the \"namespace\" you give to the generator.\n\n```js\nmodule.exports = function(app) {\n  app.register('foo', require('generate-updatefile'));\n  // generate\n};\n```\n\n**Running tasks**\n\nPass the names of one or more tasks to run to the `.generate` method, prefixed with the namespace of the sub-generator (`foo`, in our example):\n\n**Examples**\n\nRun the `bar` task from generator `foo`:\n\n```js\nmodule.exports = function(app) {\n  app.register('foo', require('generate-updatefile'));\n\n  app.generate('foo:bar', function(err) {\n    if (err) console.log(err);\n  });\n};\n```\n\nWrap the call to `.generate` in a task, so it can be called on demand:\n\n```js\nmodule.exports = function(app) {\n  app.register('foo', require('generate-updatefile'));\n\n  app.task('bar', function(cb) {\n    app.generate('foo:bar', cb);\n  });\n};\n```\n\n**More information**\n\nVisit the [generator docs](https://github.com/generate/generate/blob/master/docs/generators.md) to learn more about creating, installing, using and publishing generators.\n\n## Running multiple generators\n\nGenerate supports running multiple generators at once. Here are some examples of other generators that work well with `generate-updatefile`.\n\n### generate-install\n\nRun [generate-install](https://github.com/generate/generate-install) **after** this generator to prompt to install any `dependencies` or `devDependencies` necessary for the generated files.\n\n**Example**\n\n![generate-updatefile generate-install example](https://raw.githubusercontent.com/generate/generate-updatefile/master/docs/demo-install.gif)\n\n### generate-dest\n\nRun [generate-dest](https://github.com/generate/generate-dest) **before** this generator to prompt for the destination directory to use for generated files.\n\n**Example**\n\n![generate-updatefile generate-dest example](https://raw.githubusercontent.com/generate/generate-updatefile/master/docs/demo-dest.gif)\n\n## Customization\n\nThe following instructions can be used to override settings in `generate-updatefile`. Visit the [Generate documentation](https://github.com/generate/generate/blob/master/docs/overriding-defaults.md) to learn about other ways to override defaults.\n\n### Destination directory\n\nTo customize the destination directory, install [generate-dest](https://github.com/generate/generate-dest) globally, then in the command line prefix `dest` before any other generator names.\n\nFor example, the following will prompt you for the destination path to use, then pass the result to `generate-updatefile`:\n\n```sh\n$ gen dest updatefile\n```\n\n### Overriding templates\n\nYou can override a template by adding a template of the same name to the `templates` directory in user home.\n\nFor example, to override the `foo.tmp` template, add a template at the following path `~/generate/generate-updatefile/templates/foo.tmpl`, where `~/` is the user-home directory that `os.homedir()` resolves to on your system.\n\n## Next steps\n\n* [docs.md](docs.md): additional documentation for this generator\n* [Generate documentation](https://github.com/generate/generate/blob/master/docs/): visit the Generate docs\n* [Generate repo](https://github.com/generate/generate): visit the Generate repository\n\n## About\n\n### Related projects\n\n* [assemble](https://www.npmjs.com/package/assemble): Get the rocks out of your socks! Assemble makes you fast at creating web projects… [more](https://github.com/assemble/assemble) | [homepage](https://github.com/assemble/assemble \"Get the rocks out of your socks! Assemble makes you fast at creating web projects. Assemble is used by thousands of projects for rapid prototyping, creating themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websit\")\n* [generate](https://www.npmjs.com/package/generate): Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… [more](https://github.com/generate/generate) | [homepage](https://github.com/generate/generate \"Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the robustness and configurability of Yeoman, the expressiveness and simplicity of Slush, and more powerful flow control and composability than either.\")\n* [update](https://www.npmjs.com/package/update): Be scalable! Update is a new, open source developer framework and CLI for automating updates… [more](https://github.com/update/update) | [homepage](https://github.com/update/update \"Be scalable! Update is a new, open source developer framework and CLI for automating updates of any kind in code projects.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d \u0026\u0026 npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/generate/generate-updatefile/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on July 15, 2016._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-updatefile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenerate%2Fgenerate-updatefile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-updatefile/lists"}