# @hollowverse/common

> Common configurations, helper functions and code quality scripts for Hollowverse repos

Latest version **3.2.7** (published 2018-03-15) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install @hollowverse/common
pnpm add @hollowverse/common
yarn add @hollowverse/common
bun add @hollowverse/common
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.2.7 |
| Published | 2018-03-15 |
| First published | 2018-03-03 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.10 |
| Dependencies | 6 |
| Unpacked size | 199.4 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | npmhollowverse, wholesomedev |

## Links

- npm: https://www.npmjs.com/package/@hollowverse/common
- Repository: https://github.com/hollowverse/common
- Homepage: https://github.com/hollowverse/common#readme
- Issues: https://github.com/hollowverse/common/issues
- npm.io page: https://npm.io/package/@hollowverse/common

## Dependencies (6)

- [glob](https://npm.io/package/glob.md) ^7.1.2
- [jszip](https://npm.io/package/jszip.md) ^3.1.4
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [shelljs](https://npm.io/package/shelljs.md) ^0.7.8
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.4
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.0.0-beta.40

## Recent versions

- 3.2.7 (latest) — 2018-03-15
- 3.2.6 — 2018-03-13
- 3.2.5 — 2018-03-04
- 3.2.4 — 2018-03-03

## README

`@hollowverse/common`
=================================================================

This repository contains shared configuration files, utility functions and code quality scripts used across multiple [Hollowverse](https://github.com/hollowverse) repositories.

## Configuration Files
`common` currently includes configuration files for:

* TypeScript ([`tsconfig.json`](./tsconfig.json))
* TSLint ([`tslint.json`](./tslint.json))
* ESLint ([`.eslintrc.json`](./.eslintrc.json))
* Stylelint ([`.stylelintrc`](./.stylelintrc))

### How to use the shared configuration

1. Install this package as dependency of your project:
     
     ```bash
     yarn add @hollowverse/common --dev
     # or
     npm install @hollowverse/common --save-dev
     ```
2. Install the [peer dependencies](./package.json#L64) 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`:
    
    ```json
    {
      "extends": "./node_modules/@hollowverse/common/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.

## 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`](./helpers) directory.

Refer to the [`deploy.js`](https://github.com/hollowverse/hollowverse/tree/master/deploy.js) script of [hollowverse/hollowverse](https://github.com/hollowverse/hollowverse) for examples on how to use these functions.

---
_Source: https://npm.io/package/@hollowverse/common · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._