open-index/open-npm huggingface dataset:
npm package: @joincivil/tslint-rules
Description: Shared Typescript linter rules for all Civil packages
Author: The Civil Media Company
Latest version: 2.7.2

# @joincivil/tslint-rules

Shared rules for Typescript linter

[![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](./LICENSE)

## Installation

Your tslint needs to be `>=5.9` for the yaml support

```bash
yarn add --dev @joincivil/tslint-rules
```

## Usage

Install tslint:

```bash
yarn add --dev tslint
```

In your `tslint.json` or `tslint.yaml` extend the rules:

```yaml
---
extends: "@joincivil/tslint-rules"
rules:
  # Your additional / overridinng rules here
  max-line-length:
    options: [7272]
```

Run linter with the `--project` option for all the rules to work:

```bash
tslint --project ./
```

## Contributing

Civil's ecosystem is free and open-source, we're all part of it and you're encouraged to be a part of it with us.
Best place to start hacking would be to use the [`@joincivil/core`](/packages/core) and build some application on top of the protocol.

If you're itching to dwelve deeper inside, [**help wanted**](https://github.com/joincivil/Civil/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
and [**good first issue**](https://github.com/joincivil/Civil/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) labels are good places to get started and learn the architecture.
npm package: @joincivil/typescript-typings
Description: Typescript type roots for external projects and internal modifications
Author: The Civil Media Company
Latest version: 1.3.2

# @joincivil/typescript-typings

This package is a Typescript typeRoot of all typings of external packages that otherwise have no types of their own.

[![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](./LICENSE)

## Reasoning

Some of the types are not in the main DefintelyTyped repository, while others are written by us.
We're using this package to increase velocity of updating types. Getting stuff into the main repo takes a week,
which is too slow for us at the current stage.

All of the types here are designed to not add any functionallity except the one existing in the packages themselves

## Usage

Install this package.

```bash
yarn add --dev @joincivil/typescript-typings
```

Update your `tsconfig.json` to include additional type root.

```
{
  {
  "compilerOptions": {
    "typeRoots": ["node_modules/@joincivil/typescript-typings/types", "node_modules/@types"]
  }
}
```

Proceed as normal, happier.