https://github.com/typeform/eslint-config-typeform
ESLint configuration for Typeform front-end projects
https://github.com/typeform/eslint-config-typeform
product-devex type-library use-nonproduction
Last synced: about 2 months ago
JSON representation
ESLint configuration for Typeform front-end projects
- Host: GitHub
- URL: https://github.com/typeform/eslint-config-typeform
- Owner: Typeform
- License: lgpl-3.0
- Created: 2020-03-23T14:08:22.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2026-04-01T14:44:21.000Z (3 months ago)
- Last Synced: 2026-04-02T10:39:49.005Z (3 months ago)
- Topics: product-devex, type-library, use-nonproduction
- Language: TypeScript
- Homepage:
- Size: 1.17 MB
- Stars: 0
- Watchers: 36
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# eslint-config-typeform
ESLint configuration for [Typeform](https://github.com/Typeform/) front-end projects
## Install
```sh
yarn add eslint @typeform/eslint-config --dev
```
## Usage
This package uses ESLint's flat config format. Create an `eslint.config.js` file with the following content:
```js
import typeformConfig from '@typeform/eslint-config'
export default typeformConfig
```
Or extend it with your own rules:
```js
import typeformConfig from '@typeform/eslint-config'
export default [
...typeformConfig,
{
rules: {
// Your custom rules
},
},
]
```
And run with:
```sh
yarn eslint . --fix
```
## Development
This package is written in TypeScript and requires building before use:
```sh
# Install dependencies
yarn install
# Build TypeScript
yarn build
# Run tests
yarn test
# Lint
yarn lint
```
The `prepare` script automatically builds the package after `yarn install`.