# @lightspeed/web-configs

> Common configurations for Lightspeed webapps

Latest version **0.1.0** (published 2019-01-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lightspeed/web-configs
pnpm add @lightspeed/web-configs
yarn add @lightspeed/web-configs
bun add @lightspeed/web-configs
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-01-09 |
| First published | 2019-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | kshahani, x.drdak, kurt.bergeron, tombertrand, lightspeedhq, ahmedelgabri, ls-guillaume-lambert, inooid, ls-frederic-bouchard |

## Links

- npm: https://www.npmjs.com/package/@lightspeed/web-configs
- npm.io page: https://npm.io/package/@lightspeed/web-configs

## Dependencies (5)

- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.1.0
- [babel-preset-next](https://npm.io/package/babel-preset-next.md) ^1.2.0
- [@zeit/next-typescript](https://npm.io/package/@zeit/next-typescript.md) ^1.1.1
- [@babel/preset-typescript](https://npm.io/package/@babel/preset-typescript.md) ^7.1.0
- [babel-plugin-module-resolver](https://npm.io/package/babel-plugin-module-resolver.md) ^3.1.1

## Recent versions

- 0.1.0 (latest) — 2019-01-09

## README

<p align="center">
  <img alt="Web Commons" width="400px" src="https://user-images.githubusercontent.com/24464151/50917483-98aa3c80-140b-11e9-8055-61f8398a8e88.png" />
</p>
<h2 align="center">Bridge commonalities between apps in the<br />Lightspeed ecosystem.</h2>

## Introduction

A central repository of base tooling configurations, used to establish best practises around these tools at Lightspeed. These configurations can be extended as required on a per-project basis.

## Getting started

1. Install the dependency in your webapp.

```sh
yarn add @lightspeed/web-config
```

## Consuming and extending configuration

### Babel

```js
// babel.config.js
module.exports = {
  presets: ['@lightspeed/web-config/babel'],
};
```

### Next.js

```js
// next.config.js
module.exports = require('@lightspeed/web-config/next');
```

### Prettier

```js
// prettier.config.js
module.exports = require('@lightspeed/web-configs/prettier');
```

### TypeScript

TypeScript does not support `tsconfig.js` files, so you'll need to use the `extends` field in the `tsconfig.json` file to point to a relative reference of this package's base `tsconfig.json`.

```json
{
  "extends": "./node_modules/@lightspeed/lightspeed-scripts/tsconfig"
}
```

Note: In an app within a monorepo, you'll need to either reference the top-level `node_modules` directory, or add `@lightspeed/web-config` to your `nohoist` configuration.

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