Newlyweds Proposing Marriage

    generate-mocha

    1.0.0 • Public • Published

    Generate mocha test files.

    generate-mocha

    NPM version NPM downloads Build Status

    generate-mocha demo

    Table of Contents

    (TOC generated by verb using markdown-toc)

    Quickstart

    Install

    Install generate and generate-mocha:

    $ npm install --global generate generate-mocha

    Generate a test.js file

    Initiate a prompt to generate a test.js file in the current working directory:

    $ gen mocha
    $ gen mocha --dest ./foo

    Files trees

    The following files trees are automatically generated by a task in verbfile.js.

    • generated files: trees representing the actual generated "dest" files for each task
    • source files: trees representing the source files and templates used by each task

    (See Generate's customization docs to learn how to override individual templates.)

    Generated files

    Files generated by each task (e.g. dest files). See the Generate customization docs to learn how to override individual templates.

    Note that diffs are base on comparisons against the files generated by the default task. Additionally, some tasks generate the same files, but with different contents (for example, the contents of index.js differs based on the task).

    default

    Files generated by the default task:

     .
     └── test.js

    base

    Files generated by the base task:

     .
     └── test.js

    generator

    Files generated by the generator task:

     .
    +└─┬ test
       ├── test.js
    +  └── plugin.js

    updater

    Files generated by the updater task:

     .
    +└─┬ test
       ├── test.js
    +  └── plugin.js

    Source files

    The following trees represent the source files or templates that are used by each task. You'll see that most of the tasks use at least one "micro-generator" to generate a specific file.

    default

    Source files and/or libraries used by the default task:

     .
     └─┬ templates
       ├── base.js
       └── test.js

    base

    Source files and/or libraries used by the base task:

     .
     └─┬ templates
       └── base.js

    generator

    Source files and/or libraries used by the generator task:

     .
     └─┬ scaffolds
       └─┬ generator
         └─┬ templates
           ├── plugin.js
           └── test.js

    updater

    Source files and/or libraries used by the updater task:

     .
     └─┬ scaffolds
       └─┬ updater
         └─┬ templates
           ├── plugin.js
           └── test.js

    What is "Generate"?

    Generate is a command line tool and developer framework for scaffolding out new GitHub projects using generators and tasks.

    Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for gulp, base and assemble plugins, and much more.

    For more information:

    Getting started

    Install

    Installing the CLI

    To run the mocha generator from the command line, you'll need to install Generate globally first. You can do that now with the following command:

    $ npm install --global generate

    This adds the gen command to your system path, allowing it to be run from any directory.

    Install generate-mocha

    Install this module with the following command:

    $ npm install --global generate-mocha

    Usage

    Run this generator's default task with the following command:

    $ gen mocha

    What you should see in the terminal

    If completed successfully, you should see both starting and finished events in the terminal, like the following:

    [00:44:21] starting ...
    ...
    [00:44:22] finished ✔

    If you do not see one or both of those events, please let us know about it.

    Help

    To see a general help menu and available commands for Generate's CLI, run:

    $ gen help

    Tasks

    All available tasks.

    default

    Alias for the test task. Allows the generator to be run with the following command:

    Example

    $ gen mocha

    base

    Generate a test.js file with unit tests for a base project.

    Example

    $ gen mocha:base

    gulp

    Generate a test.js file with unit tests for a gulp plugin project.

    Example

    $ gen mocha:gulp

    generator

    Generate unit tests for a generate generator. Creates:

    • test.js
    • plugin.js

    Example

    $ gen mocha:gen
    # aliased as 
    $ gen mocha:generator

    updater

    Generate unit tests for an update "updater". Creates:

    • test.js
    • plugin.js

    Example

    $ gen mocha:updater

    Visit Generate's documentation for tasks.

    About

    Related projects

    Community

    Are you using Generate in your project? Have you published a generator and want to share your project with the world?

    Here are some suggestions!

    • If you get like Generate and want to tweet about it, please feel free to mention @generatejs or use the #generatejs hashtag
    • Show your love by starring Generate and generate-mocha
    • Get implementation help on StackOverflow (please use the generatejs tag in questions)
    • Gitter Discuss Generate with us on Gitter
    • If you publish an generator, thank you! To make your project as discoverable as possible, please add the keyword generategenerator to package.json.

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Running tests

    Install dev dependencies:

    $ npm install -d && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2016, Jon Schlinkert. Released under the MIT license.


    This file was generated by verb-generate-readme, v0.1.30, on August 17, 2016.

    Install

    npm i generate-mocha

    DownloadsWeekly Downloads

    74

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert