README.md

@hollowverse/config

This repository contains shared configuration files used across multiple Hollowverse repositories.

Configuration Files

@hollowverse/config currently includes configuration files for:

• TypeScript (tsconfig.json)
• TSLint (tslint.json)
• ESLint (.eslintrc.json, other language-specific configurations in ./eslint)
• Stylelint (.stylelintrc)
• Prettier (prettier.config.js)
• Babel (lambda/.babelrc for AWS Lambda)

How to use the shared configuration

1. Install this package as dependency of your project:

   yarn add @hollowverse/config --dev
   # or
   npm install @hollowverse/config --save-dev

2. Install the peer dependencies for each of the tools used in the new project.
3. Extend your project configuration files with the corresponding files from this package. For example, here is how to extend tsconfig.json:

   {
     "extends": "./node_modules/@hollowverse/config/tsconfig.json"
   }

   Refer to each tool's documentation for more information on how to extend the configuration.
4. Add properties to the configuration file to override the shared configuration as needed.

---

If you'd like to tell us something, or need help with anything...