A Yeoman generator for producing base project structure and configuration files.

Usage no npm install needed!

<script type="module">
  import generatorGeniemouseBase from '';


Base project generator

Yeoman generator that produces base project structure.

  1. Out-of-the-box
  2. Installation
  3. Configuration
    1. Sub-generators
  4. Related links


Accepting the default options (ESLint, Prettier, Jest), geniemouse-base adds the following packages (and rulesets):

  • ESLint for linting JavaScript files
  • Jest for unit-testing JavaScript
  • Prettier for formatting code

Generated files

├── __tests__/ *
├── .editorconfig
├── .eslintignore *
├── .eslintrc *
├── .gitattributes
├── .gitignore
├── .prettierrc.js *
├── .prettierignore *
├── package.json

* Installed only if related package is.


Install Yeoman (yo) & generator-geniemouse-base globally.

# Using npm:
npm install --global yo generator-geniemouse-base

# Using yarn:
yarn global add yo generator-geniemouse-base


  1. Make a project directory and cd into it
mkdir YOUR_PROJECT_NAME && cd $_
  1. Call on yo to create the scaffold from geniemouse-base generator
yo geniemouse-base

(Calling yo on its own lists all the installed generators, which can be selected and run from there.)

  1. Yeoman will run through a series of questions; customize the choices, as you see fit.


Each of the project features is available as a sub-generator, which can be called individually:

# ESLint install
yo geniemouse-base:eslint

# Jest install
yo geniemouse-base:jest

# Prettier install
yo geniemouse-base:prettier

Related links