{"id":20551451,"url":"https://github.com/generate/generate-engine","last_synced_at":"2025-07-18T13:35:05.866Z","repository":{"id":57246077,"uuid":"64607887","full_name":"generate/generate-engine","owner":"generate","description":"Generate a new consolidate-style engine project, with starter code and unit tests.","archived":false,"fork":false,"pushed_at":"2016-08-01T01:18:34.000Z","size":810,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-09T23:01:21.416Z","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-31T18:05:38.000Z","updated_at":"2018-02-04T14:19:32.000Z","dependencies_parsed_at":"2022-08-24T16:31:36.875Z","dependency_job_id":null,"html_url":"https://github.com/generate/generate-engine","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-engine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-engine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-engine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-engine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/generate","download_url":"https://codeload.github.com/generate/generate-engine/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248869177,"owners_count":21174831,"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-16T02:31:02.366Z","updated_at":"2025-04-14T11:22:40.897Z","avatar_url":"https://github.com/generate.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\n\u003ca href=\"https://github.com/generate/generate\"\u003e\n\u003cimg height=\"150\" width=\"150\" src=\"https://raw.githubusercontent.com/generate/generate/master/docs/logo.png\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\nGenerate a new consolidate-style engine project, with starter code and unit tests.\n\n# generate-engine\n\n[![NPM version](https://img.shields.io/npm/v/generate-engine.svg?style=flat)](https://www.npmjs.com/package/generate-engine) [![NPM downloads](https://img.shields.io/npm/dm/generate-engine.svg?style=flat)](https://npmjs.org/package/generate-engine) [![Build Status](https://img.shields.io/travis/generate/generate-engine.svg?style=flat)](https://travis-ci.org/generate/generate-engine)\n\n![generate-engine demo](https://raw.githubusercontent.com/generate/generate-engine/master/docs/demo.gif)\n\n## Table of Contents\n\n- [What is \"Generate\"?](#what-is-generate)\n- [Getting started](#getting-started)\n  * [Install](#install)\n  * [Usage](#usage)\n  * [Help](#help)\n- [Tasks](#tasks)\n  * [default](#default)\n  * [minimal](#minimal)\n  * [index](#index)\n  * [test](#test)\n- [Generated files](#generated-files)\n  * [default](#default-1)\n  * [index](#index-1)\n  * [minimal](#minimal-1)\n  * [test](#test-1)\n- [Source files](#source-files)\n  * [default](#default-2)\n  * [index](#index-2)\n  * [minimal](#minimal-2)\n  * [test](#test-2)\n- [Next steps](#next-steps)\n  * [Running unit tests](#running-unit-tests)\n  * [Publishing your project](#publishing-your-project)\n- [About](#about)\n  * [Community](#community)\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).\n\nAnswers 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\n**For more information**:\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## Getting started\n\n### Install\n\n**Installing the CLI**\n\nTo run the `engine` 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-engine**\n\nInstall this module with the following command:\n\n```sh\n$ npm install --global generate-engine\n```\n\n### Usage\n\nRun this generator's `default` [task](https://github.com/generate/generate/blob/master/docs/tasks.md#default) with the following command:\n\n```sh\n$ gen engine\n```\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## Tasks\n\nAll available tasks.\n\n### [default](generator.js#L54)\n\nScaffold out the [necessary files](#default-1) for a [consolidate](https://github.com/visionmedia/consolidate.js)-style engine project.\n\n**Example**\n\n```sh\n$ gen engine\n```\n\n### [minimal](generator.js#L69)\n\nScaffold out a [minimal](#minimal-1) engine project.\n\n**Example**\n\n```sh\n$ gen engine:min\n# or\n$ gen engine:minimal\n```\n\n### [index](generator.js#L83)\n\nWrite only the `index.js` file with starter code for creating a [consolidate](https://github.com/visionmedia/consolidate.js)-style engine to the current working directory.\n\n**Example**\n\n```sh\n$ gen engine:index\n```\n\n### [test](generator.js#L95)\n\nWrite only [test files](#test-1) with [mocha](https://github.com/mochajs/mocha)-style unit tests for your engine.\n\n**Example**\n\n```sh\n$ gen engine:test\n```\n\nVisit Generate's [documentation for tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).\n\n## Generated files\n\nFiles generated by each task. See the Generate [customization docs ](https://github.com/generate/generate/blob/master/docs/customization.md) to learn how to override individual templates.\n\n_(diffs are base on the files generated by the `default` task)_\n\n### default\n\nFiles generated by the [default task](#default):\n\n```diff\n .\n ├─┬ test\n │ ├─┬ fixtures\n │ │ ├── content.tmpl\n │ │ ├── default.tmpl\n │ │ └── nothing.tmpl\n │ └── test.js\n ├── .editorconfig\n ├── .eslintrc.json\n ├── .gitattributes\n ├── .gitignore\n ├── .travis.yml\n ├── index.js\n ├── contributing.md\n ├── LICENSE\n ├── package.json\n └── README.md\n```\n\n### index\n\nFiles generated by the [index task](#index):\n\n```diff\n .\n-├─┬ test\n-│ ├─┬ fixtures\n-│ │ ├── content.tmpl\n-│ │ ├── default.tmpl\n-│ │ └── nothing.tmpl\n-│ └── test.js\n-├── .editorconfig\n-├── .eslintrc.json\n-├── .gitattributes\n-├── .gitignore\n-├── .travis.yml\n └── index.js\n-├── contributing.md\n-├── LICENSE\n-├── package.json\n-└── README.md\n```\n\n### minimal\n\nFiles generated by the [minimal task](#minimal):\n\n```diff\n .\n-├─┬ test\n-│ ├─┬ fixtures\n-│ │ ├── content.tmpl\n-│ │ ├── default.tmpl\n-│ │ └── nothing.tmpl\n-│ └── test.js\n-├── .editorconfig\n-├── .eslintrc.json\n-├── .gitattributes\n ├── .gitignore\n-├── .travis.yml\n ├── index.js\n-├── contributing.md\n ├── LICENSE\n ├── package.json\n └── README.md\n```\n\n### test\n\nFiles generated by the [test task](#test):\n\n```diff\n .\n └─┬ test\n   ├─┬ fixtures\n   │ ├── content.tmpl\n   │ ├── default.tmpl\n   │ └── nothing.tmpl\n   └── test.js\n-├── .editorconfig\n-├── .eslintrc.json\n-├── .gitattributes\n-├── .gitignore\n-├── .travis.yml\n-├── index.js\n-├── contributing.md\n-├── LICENSE\n-├── package.json\n-└── README.md\n```\n\n## Source files\n\nThe following trees represent the source files or templates that are used by each task. This shows how \"micro-generators\" are used as dependencies for generating a single file.\n\n### default\n\nSource files used by the [default task](#default):\n\n```diff\n .\n ├─┬ templates\n │ ├─┬ fixtures\n │ │ ├── content.tmpl\n │ │ ├── default.tmpl\n │ │ └── nothing.tmpl\n │ ├── test.js\n │ └── index.js\n └─┬ node_modules\n   ├─┬ generate-editorconfig\n   │ └─┬ templates\n   │   └── .editorconfig\n   ├─┬ generate-eslint\n   │ └─┬ templates\n   │   └── .eslintrc.json\n   ├─┬ generate-gitattributes\n   │ └─┬ templates\n   │   └── .gitattributes\n   ├─┬ generate-gitignore\n   │ └─┬ templates\n   │   └── .gitignore\n   ├─┬ generate-travis\n   │ └─┬ templates\n   │   └── .travis.yml\n   ├─┬ generate-contributing\n   │ └─┬ templates\n   │   └── contributing.md\n   ├─┬ generate-license\n   │ └─┬ templates\n   │   └── mit.tmpl\n   ├─┬ generate-package\n   │ └─┬ templates\n   │   └── package.json\n   └─┬ generate-readme\n     └─┬ templates\n       └── node.md\n```\n\n### index\n\nSource files used by the [index task](#index):\n\n```diff\n .\n └─┬ templates\n   └── index.js\n```\n\n### minimal\n\nSource files used by the [minimal task](#minimal):\n\n```diff\n .\n ├─┬ node_modules\n │ ├─┬ generate-gitignore\n │ │ └─┬ templates\n │ │   └── .gitignore\n │ ├─┬ generate-license\n │ │ └─┬ templates\n │ │   └── mit.tmpl\n │ ├─┬ generate-package\n │ │ └─┬ templates\n │ │   └── package.json\n │ └─┬ generate-readme\n │   └─┬ templates\n │     └── node.md\n └─┬ templates\n   └── index.js\n```\n\n### test\n\nSource files used by the [test task](#test):\n\n```diff\n .\n └─┬ templates\n   ├─┬ fixtures\n   │ ├── content.tmpl\n   │ ├── default.tmpl\n   │ └── nothing.tmpl\n   └── test.js\n```\n\n## Next steps\n\n### Running unit tests\n\nIt's never too early to begin running unit tests. When you're ready to get started, the following command will ensure the project's dependencies are installed then run all of the unit tests:\n\n```sh\n$ npm install \u0026\u0026 test\n```\n\n### Publishing your project\n\nIf you're tests are passing and you're ready to publish your project to [npm](https://www.npmjs.com), you can do that now with the following command:\n\n**Are you sure you're ready?!**\n\n```sh\n$ npm publish\n```\n\n## About\n\n### Community\n\nAre you using [Generate](https://github.com/generate/generate) in your project? Have you published a [generator](https://github.com/generate/generate/blob/master/docs/generators.md) and want to share your project with the world?\n\nHere are some suggestions!\n\n* If you get like Generate and want to tweet about it, please feel free to mention `@generatejs` or use the `#generatejs` hashtag\n* Show your love by starring [Generate](https://github.com/generate/generate) and `generate-engine`\n* Get implementation help on [StackOverflow](http://stackoverflow.com/questions/tagged/generate) (please use the `generatejs` tag in questions)\n* **Gitter** Discuss Generate with us on [Gitter](https://gitter.im/generate/generate)\n* If you publish an generator, thank you! To make your project as discoverable as possible, please add the keyword `generategenerator` to package.json.\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-engine/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 31, 2016._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-engine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenerate%2Fgenerate-engine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-engine/lists"}