{"id":18434734,"url":"https://github.com/assemble/assemble-scaffold","last_synced_at":"2025-04-14T08:23:59.922Z","repository":{"id":66211892,"uuid":"42412279","full_name":"assemble/assemble-scaffold","owner":"assemble","description":"Assemble plugin for generating project scaffolds.","archived":false,"fork":false,"pushed_at":"2015-09-13T21:02:32.000Z","size":132,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-16T10:15:05.341Z","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/assemble.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":"2015-09-13T20:45:48.000Z","updated_at":"2015-12-29T18:02:58.000Z","dependencies_parsed_at":"2023-02-20T00:15:47.185Z","dependency_job_id":null,"html_url":"https://github.com/assemble/assemble-scaffold","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fassemble-scaffold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fassemble-scaffold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fassemble-scaffold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fassemble-scaffold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/assemble","download_url":"https://codeload.github.com/assemble/assemble-scaffold/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248844296,"owners_count":21170547,"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":[],"created_at":"2024-11-06T06:05:09.404Z","updated_at":"2025-04-14T08:23:59.892Z","avatar_url":"https://github.com/assemble.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# assemble-scaffold [![NPM version](https://badge.fury.io/js/assemble-scaffold.svg)](http://badge.fury.io/js/assemble-scaffold)\n\n\u003e Generate project scaffolds with assemble and Scaffold.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i assemble-scaffold --save\n```\n\n## Usage\n\n```js\nvar assemble = require('assemble');\nvar scaffold = require('assemble-scaffold');\n\n// register the plugin, add options if needed\nvar app = assemble()\n  .use(scaffold({cwd: 'scaffolds/'}))\n```\n\n**Register scaffolds**\n\nUses [scaffold](https://github.com/jonschlinkert/scaffold) to create normalize configuration objects:\n\n```js\napp.scaffold('ejs', {\n  src: ['templates/ejs/*.ejs'],\n  dest: 'src/templates'\n});\n```\n\nThe created configuration object looks something like:\n\n```js\n[ { src: [ 'templates/ejs/foo.ejs', 'templates/ejs/bar.ejs' ],\n    dest: 'src/templates',\n    options: { cwd: 'scaffolds' },\n    name: 'ejs' } ]\n```\n\n**Generate scaffold**\n\nWhich can easily be generated by calling the scaffold's generate method:\n\n```js\nscaffold('ejs')\n  // destination base is optional\n  .generate('dest/', function(err) {\n    if (err) console.error(err);\n  });\n```\n\n**Plugins**\n\nPlugins may also be used by passing them to the `.use()` method on the scaffold instance. It's also chainable.\n\n```js\nscaffold('ejs')\n  // plugins\n  .use(function(config) {\n    config.files.forEach(function(file) {\n      // do something to `file`\n    });\n  })\n  .use(function(config) {\n    config.dest = 'foo/' + config.dest;\n  })\n  .generate(function(err) {\n    if (err) console.error(err);\n  });\n```\n\n## Related projects\n\n* [assemble](https://www.npmjs.com/package/assemble): Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… [more](https://www.npmjs.com/package/assemble) | [homepage](http://assemble.io)\n* [expand-config](https://www.npmjs.com/package/expand-config): Expand tasks, targets and files in a declarative configuration. | [homepage](https://github.com/jonschlinkert/expand-config)\n* [expand-files](https://www.npmjs.com/package/expand-files): Expand glob patterns in a declarative configuration into src-dest mappings. | [homepage](https://github.com/jonschlinkert/expand-files)\n* [scaffold](https://www.npmjs.com/package/scaffold): Conventions and API for creating scaffolds that can by used by any build system or… [more](https://www.npmjs.com/package/scaffold) | [homepage](https://github.com/jonschlinkert/scaffold)\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d \u0026\u0026 npm test\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/assemble-scaffold/issues/new).\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 © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 13, 2015._\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemble%2Fassemble-scaffold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fassemble%2Fassemble-scaffold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemble%2Fassemble-scaffold/lists"}