# generator-compute-io > A Yeoman generator for Compute.io modules. Latest version **0.1.22** (published 2015-07-19) · MIT license · 0 weekly downloads ## Install ```sh npm install generator-compute-io pnpm add generator-compute-io yarn add generator-compute-io bun add generator-compute-io ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.22 | | Published | 2015-07-19 | | First published | 2014-09-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.10.0 | | Dependencies | 5 | | Known vulnerabilities | 0 (+2 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 4 | | Author | Athan Reines | | Maintainers | kgryte | | Keywords | yeoman-generator, compute.io, compute, computation | ## Links - npm: https://www.npmjs.com/package/generator-compute-io - Repository: https://github.com/compute-io/generator-compute-io - Homepage: https://github.com/compute-io/generator-compute-io#readme - Issues: https://github.com/compute-io/generator-compute-io/issues - npm.io page: https://npm.io/package/generator-compute-io ## Dependencies (5) - [chalk](https://npm.io/package/chalk.md) ^1.0.0 - [yosay](https://npm.io/package/yosay.md) ^1.0.0 - [shelljs](https://npm.io/package/shelljs.md) ^0.5.0 - [npm-name](https://npm.io/package/npm-name.md) ^1.0.1 - [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^0.18.9 ## Recent versions - 0.1.22 (latest) — 2015-07-19 - 0.1.21 — 2015-06-10 - 0.1.20 — 2015-06-10 - 0.1.19 — 2015-06-06 - 0.1.18 — 2015-05-24 - 0.1.17 — 2015-05-03 - 0.1.16 — 2015-04-21 - 0.1.15 — 2015-04-05 - 0.1.14 — 2015-04-05 - 0.1.13 — 2015-04-05 - 0.1.12 — 2015-03-03 - 0.1.11 — 2015-02-24 - 0.1.10 — 2015-02-24 - 0.1.9 — 2015-02-20 - 0.1.8 — 2014-11-29 - … 11 more at https://npm.io/package/generator-compute-io/versions ## README Yeoman Generator ================ [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependencies][dependencies-image]][dependencies-url] This module is a [Yeoman](http://yeoman.io) generator for [Compute.io](https://github.com/compute-io) modules. ## Getting Started To use the generator, ensure that you have installed Yeoman: ``` bash $ npm install -g yo ``` For a general overview of Yeoman generators, see the [Getting Started Guide](http://yeoman.io/learning/). ## Installation ``` bash $ npm install -g generator-compute-io ``` ## Usage Once installed, navigate to the directory in which you want to place generated files and run ``` bash $ yo compute-io ``` The generator will provide a series of prompts and will use your answers to tailor the module files, providing a scaffold upon which you can immediately build. ### Prompts The prompts are as follows... #### Module Name The module name requires the convention that the module be prefixed with `compute-`. This ensures consistency with the current naming of Compute.io modules. Valid names include: `compute-mean`, `compute-variance`, `compute-sum`, etc. Do __not__ include spaces or special characters in the name; e.g., `compute io correlation @ value`. Also note that using the generator requires internet access, as module name availability is confirmed on NPM via [npm-name](https://github.com/sindresorhus/npm-name). #### Git You have the option to initialize the module directory as a Git repository. The default option is `Y`. Typing `enter` or `y+enter` will confirm initialization and do the following: ``` bash $ git init $ git remote add origin https://github.com/compute-io/.git $ git add -A $ git commit -m "[INIT]" ``` The initialization process stops short of pushing the commit to the remote repository. Note: Git initialization assumes you have write access to the [Compute-io](https://github.com/compute-io) organization on Github. If you are not already a member and are interested in contributing, contact one of the [owners](https://github.com/kgryte). #### Repository If you elected to initialize a local Git repository, you must specify the corresponding remote repository name. The default is the unique module id (e.g., `compute-mean` --> `mean` ). #### Author Enter the primary author's name; i.e., in all likelihood that will be your name. #### Email If you have chosen to initialize the directory as a Git repository, the default will be the email associated with your Github account. This email should be a correspondence address for those individuals wanting to contact you directly with their questions and comments. If the Github email address is fine, just type `enter`. #### Description Enter the module description. ### Scaffold Once you have answered all prompts, you will have the following scaffold: ``` benchmark/ examples/ - index.js lib/ - index.js test/ - test.js .gitignore .gitattributes .npmignore .travis.yml .jshintrc .jshintignore .editorconfig LICENSE Makefile package.json README.md TODO.md ``` #### Dotfiles These are standard fare. If you notice that files are neither tracking in Git nor making their way onto NPM, consult `.gitignore` and `.npmignore`. The scaffold includes a `.travis.yml` file for continuous integration purposes. Visit [Travis-CI](https://travis-ci.org/) to setup running builds. #### Makefile The `Makefile` includes methods to run tests and generate notes. To see TODOs and FIXMEs, ``` bash $ make notes ``` #### License The default license is the [MIT license](http://opensource.org/licenses/MIT). #### Package.json The generator creates a scaffold `package.json`, using the module name to generate the Github repository urls. You need to manually add `keywords` and any additional `dependencies`. #### Documentation The generator includes a `TODO.md` file. Use this file for general TODOs which are not tied to any particular file line. The `README.md` is a scaffold. You should add to the usage and example code sections. #### Lib The main library file `lib/index.js` is stubbed. The file includes a dummy method (`foo`). #### Test The generator creates a skeleton test file. Aim for 100% test coverage. #### Benchmark The generator creates an empty directory for benchmarks. Should the module warrant benchmarks, include the benchmark files in this directory. #### Examples The `examples/index.js` file should be modified to showcase the module and should correspond to the example provided in the `README`. #### Node Modules The generator will automatically run `npm install` and install any node modules used by the scaffold. If you need any additional dependencies, ``` bash $ npm install --save ``` or development dependencies (either for testing or examples) ``` bash $ npm install --save-dev ``` ## Notes If you opted to initialize the module as a Git repository, you will need to manually push changes to Github. ``` bash $ git push origin master ``` By default, the generator generates a [Travis-CI](https://travis-ci.org/) `*.yml` file for continuous integration and uses [Coveralls](https://coveralls.io/) for tracking code coverage over time. ## Tests ### Unit Unit tests use the [Mocha](http://mochajs.org/) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory: ``` bash $ make test ``` All new feature development should have corresponding unit tests to validate correct functionality. ### Test Coverage This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory: ``` bash $ make test-cov ``` Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report, ``` bash $ make view-cov ``` --- ## License [MIT license](http://opensource.org/licenses/MIT). ## Copyright Copyright © 2014-2015. The [Compute.io](https://github.com/compute-io) Authors. [npm-image]: http://img.shields.io/npm/v/generator-compute-io.svg [npm-url]: https://npmjs.org/package/generator-compute-io [travis-image]: http://img.shields.io/travis/compute-io/generator-compute-io/master.svg [travis-url]: https://travis-ci.org/compute-io/generator-compute-io [coveralls-image]: https://img.shields.io/coveralls/compute-io/generator-compute-io/master.svg [coveralls-url]: https://coveralls.io/r/compute-io/generator-compute-io?branch=master [dependencies-image]: http://img.shields.io/david/compute-io/generator-compute-io.svg [dependencies-url]: https://david-dm.org/compute-io/generator-compute-io [dev-dependencies-image]: http://img.shields.io/david/dev/compute-io/generator-compute-io.svg [dev-dependencies-url]: https://david-dm.org/dev/compute-io/generator-compute-io [github-issues-image]: http://img.shields.io/github/issues/compute-io/generator-compute-io.svg [github-issues-url]: https://github.com/compute-io/generator-compute-io/issues --- _Source: https://npm.io/package/generator-compute-io · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._