Gynzy Conventions

This is the conventions repository, describing code conventions and provides ESLint configurations used in unicorn services.

Conventions Wiki

ESLint Installation

To install this package:

npm install --save-dev git+ssh://[email protected]:gynzy/gynzy-conventions.git

This might produce warnings about peers required by this package:

npm WARN [email protected] requires a peer of eslint@^4.13.1 but none is installed. You must install peer dependencies yourself.

Install each of these to resolve this, otherwise ESLint might not work properly:

npm install --save-dev eslint
npm install --save-dev prettier
npm install --save-dev eslint-plugin-ava
...

Integrating Configs

To integrate an ESLint configuration of this repository in a child repo, add a .eslintrc.js file containing:

module.exports = {
	'extends': './node_modules/gynzy-conventions/configs/.eslintrc.js',
};

Any additional ESLint options can be added to this.

Integrating Prettier configs is as easy as creating a .prettierrc.js file containing the following:

module.exports = require('gynzy-conventions/configs/.prettierrc');

You might want to overwrite ESLint behaviour in test files. You can do so by adding another .eslintrc.js file in the test directory. For instance:

root/
+-- test/
|   +-- .eslintrc.js	(extends .eslintrc.test.js)
+-- .eslintrc.js	(extends .eslintrc.js)
+-- .prettierrc.js	(requires .prettierrc)