@mapleinside/generator-ui-project-environment

Generator UI Project Environment

A generator to create environment files for projects like .eslintrc, .gitignore, and .idea configuration files.

What is Generator UI Project Environment?

On each project, you always need to configure your environment with your favorite IDE and tools. It's often the same boilerplate scripts that you need to use like code linters, .gitignore, .npmignore, and stuff. This generator try to facilitate this process every time you need to do this kind of boring job.

How It Works?

Installation

Before using this generator, you need to have Yeoman already installed. As usual for a generator, you need to install it as global Node dependency:

npm install -g @mapleinside/generator-ui-project-environment

You'll notice that the package is scoped with @mapleinside.

Usage

Next, you need to use it on the root of your project as this:

yo @mapleinside/ui-project-environment

This will generate for you a .eslintrc file, that you can use as ESLint configuration for your project. This file is based on Maple Inside's UI JavaScript conventions.

Required dependencies

ESLint

The ESLint configuration requires the following dependencies in your project: ESLint (indeed), Babel ESLint, ESLint React plugin, and Estraverse FB.

npm install eslint babel-eslint eslint-plugin-react estraverse-fb --save-dev

Validate a project codebase with ESLint

To perform this task, you can add an ESLint check on your npm test command (in conjunction with your test framework for example). Add this line in your package.json:

"scripts": {
  "test": "./node_modules/.bin/eslint ./src"
}

You can now test if your codebase is valid on conventions with npm test. And your Continuous Integration tool as well.

License

(The MIT License)

Copyright (c) 2016 Maple Inside

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.