{"id":20551491,"url":"https://github.com/generate/generate-scaffold","last_synced_at":"2025-08-08T04:34:52.434Z","repository":{"id":42413635,"uuid":"62091844","full_name":"generate/generate-scaffold","owner":"generate","description":"Generate a project, component or file from a declarative scaffold configuration. Use as a plugin in other generators.","archived":false,"fork":false,"pushed_at":"2016-07-29T21:55:31.000Z","size":31,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-19T08:51:11.303Z","etag":null,"topics":[],"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/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-06-27T22:11:19.000Z","updated_at":"2022-09-14T03:59:25.000Z","dependencies_parsed_at":"2022-09-27T10:50:38.128Z","dependency_job_id":null,"html_url":"https://github.com/generate/generate-scaffold","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/generate/generate-scaffold","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-scaffold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-scaffold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-scaffold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-scaffold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/generate","download_url":"https://codeload.github.com/generate/generate-scaffold/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-scaffold/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269365567,"owners_count":24405229,"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-08-08T02:00:09.200Z","response_time":72,"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:26.891Z","updated_at":"2025-08-08T04:34:52.412Z","avatar_url":"https://github.com/generate.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generate-scaffold [![NPM version](https://img.shields.io/npm/v/generate-scaffold.svg?style=flat)](https://www.npmjs.com/package/generate-scaffold) [![NPM downloads](https://img.shields.io/npm/dm/generate-scaffold.svg?style=flat)](https://npmjs.org/package/generate-scaffold) [![Build Status](https://img.shields.io/travis/generate/generate-scaffold.svg?style=flat)](https://travis-ci.org/generate/generate-scaffold)\n\nGenerate a scaffold from a declarative configuration.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save generate-scaffold\n```\n\n## Usage\n\n```js\nvar scaffolds = require('generate-scaffold');\n```\n\n## Example\n\n```js\nvar scaffolds = require('generate-scaffold');\nvar generate = require('generate');\nvar Scaffold = require('scaffold');\nvar scaffold = new Scaffold();\nvar app = generate();\napp.use(scaffolds);\n\n/**\n * Add a basic \"target\" to our scaffold. Scaffolds are like\n * grunt \"tasks\" and can have any number of targets\n */\n\nscaffold.addTarget('abc', {\n  options: {\n    pipeline: generate.renderFile,\n    data: {\n      site: { title: 'My Blog' }\n    }\n  },\n  src: 'templates/*.hbs',\n  dest: 'site',\n});\n\n/**\n * Template engine for rendering handlebars templates\n */\n\napp.engine('hbs', require('engine-handlebars'));\n\n/**\n * Generate the scaffold!\n */\n\napp.scaffold('site', scaffold)\n  .generate()\n  .on('error', console.log)\n  .on('data', console.log)\n  .on('end', function() {\n    console.log('done!');\n  });\n```\n\nSee the [scaffold](https://github.com/jonschlinkert/scaffold) library for additional information.\n\n## API\n\n### [.scaffoldSeries](index.js#L100)\n\nAsynchronously generate files from a declarative [scaffold](https://github.com/jonschlinkert/scaffold) configuration.\n\n**Params**\n\n* `scaffold` **{Object}**: Scaffold configuration object.\n* `cb` **{Function}**: Optional callback function. If not passed, `.scaffoldStream` will be called and a stream will be returned.\n\n**Example**\n\n```js\nvar Scaffold = require('scaffold');\nvar scaffold = new Scaffold({\n  options: {cwd: 'source'},\n  posts: {\n    src: ['content/*.md']\n  },\n  pages: {\n    src: ['templates/*.hbs']\n  }\n});\n\napp.scaffoldSeries(scaffold, function(err) {\n  if (err) console.log(err);\n});\n```\n\n### [.scaffoldStream](index.js#L157)\n\nGenerate files from a declarative [scaffold](https://github.com/jonschlinkert/scaffold) configuration.\n\n**Params**\n\n* `config` **{Object}**: [scaffold](https://github.com/jonschlinkert/scaffold) configuration object.\n* `returns` **{Stream}**: returns a stream with all processed files.\n\n**Example**\n\n```js\nvar Scaffold = require('scaffold');\nvar scaffold = new Scaffold({\n  options: {cwd: 'source'},\n  posts: {\n    src: ['content/*.md']\n  },\n  pages: {\n    src: ['templates/*.hbs']\n  }\n});\n\napp.scaffoldStream(scaffold)\n  .on('error', console.error)\n  .on('end', function() {\n    console.log('done!');\n  });\n```\n\n## History\n\n### v0.3.0 (2016-07-11)\n\n**Breaking changes**\n\n* Changes signature of the main export to follow [Generate](https://github.com/generate/generate) generator conventions. Instead of doing `app.use(scaffold())`, you should now do `app.use(scaffold)`.\n\n### v0.2.1 (2016-07-11)\n\n**Fixed**\n\n* Ensure that tasks and generators are created correctly by listener\n\n### v0.2.0 (2016-06-27)\n\n**Added**\n\n* Adds support for automatically creating generators and tasks from declarative scaffolds. Collaborative work from @doowb and @jonschlinkert\n\n## About\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_\n\nTo generate the readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install -g verb verb-generate-readme \u0026\u0026 verb\n```\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-scaffold/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.28, on July 29, 2016._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-scaffold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenerate%2Fgenerate-scaffold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-scaffold/lists"}