README.md

@smartcar/zamboni

Combines Configuration files for ESlint, Prettier, and Husky into one convenient package.

Makes it easier to enable linting on projects by providing configuration files with sane defaults as well as centrally tracking versions of the various dependencies.

This package is intended for internal use and may not strictly follow Semver guidelines

Installation

1. Authenticate with GitHub package registry by following these steps.

2. npm install --save-dev @smartcar/zamboni

3. Create the following configuration files in root of your project:

   • .eslintrc.js - follow instructions here
     note: no need to install @smartcar/eslint-config, this package includes it as a dependency

   • .huskyrc.js

     'use strict';
     
     module.exports = require('@smartcar/zamboni').config.husky;

   • .lintstagedrc.js

     'use strict';
     
     module.exports = require('@smartcar/zamboni').config.lintstaged;

   • .prettierrc.js
     note: no need to install @smartcar/prettier-config, this package includes it as a dependency

     'use strict';
     
     module.exports = require('@smartcar/prettier-config');

4. Go about your business and let the zamboni do it's thing.

   

Related

• @smartcar/eslint-config - ESLint shareable config for Smartcar
• @smartcar/prettier-config - Prettier shareable config for Smartcar

License

MIT © Smartcar, Inc.