@hollowverse/common
v3.2.7
Published
Common configurations, helper functions and code quality scripts for Hollowverse repos
Downloads
7
Readme
@hollowverse/common
This repository contains shared configuration files, utility functions and code quality scripts used across multiple Hollowverse repositories.
Configuration Files
common
currently includes configuration files for:
- TypeScript (
tsconfig.json
) - TSLint (
tslint.json
) - ESLint (
.eslintrc.json
) - Stylelint (
.stylelintrc
)
How to use the shared configuration
Install this package as dependency of your project:
yarn add @hollowverse/common --dev # or npm install @hollowverse/common --save-dev
Install the peer dependencies for each of the tools used in the new project.
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/common/tsconfig.json" }
Refer to each tool's documentation for more information on how to extend the configuration.
Add properties to the configuration file to override the shared configuration as needed.
Helper Functions
In addition to shared configuration files, common
also provides a set of utility functions used in multiple repositories in the Hollowverse organization for deployment and other tasks, the functions are exported from the ./helpers
directory.
Refer to the deploy.js
script of hollowverse/hollowverse for examples on how to use these functions.