eslint-config-twilio-base

2.0.0 verified Sat Apr 25 auth: no javascript

Twilio's base ESLint configuration for JavaScript, providing a consistent style guide for Twilio projects. Current stable version is 2.0.0, which requires ESLint 8 and drops support for ESLint 5, 6, and 7. This config is intended to be extended by other Twilio-specific style packages, not used standalone. It is part of the Twilio Style ecosystem, with regular updates aligned with ESLint releases.

Common errors

error Cannot find module 'eslint-config-twilio-base' ↓

cause The package is not installed or not a peer dependency.

fix

Run npm install eslint eslint-config-twilio-base --save-dev

error ESLint configuration in .eslintrc is invalid: Unexpected top-level property "extends" ↓

cause Using an array with extends in an older ESLint format.

fix

Ensure your .eslintrc file is valid JSON. If using .eslintrc.yaml, use proper YAML syntax.

Warnings

breaking Version 2.0.0 drops support for ESLint 5, 6, and 7. Only ESLint 8 is supported. ↓

fix Upgrade to ESLint 8.

gotcha This package is a base config and should not be used directly if you want full Twilio style. Instead, use eslint-config-twilio which extends this package with React rules. ↓

fix Use eslint-config-twilio for a complete setup including React specific rules.

gotcha The package name is eslint-config-twilio-base, but in the extends field you should use 'twilio-base' (without the eslint-config- prefix). ↓

fix Use 'twilio-base' in the extends array.

Install

npm install eslint-config-twilio-base

yarn add eslint-config-twilio-base

pnpm add eslint-config-twilio-base

Imports

TwilioBaseConfig

wrong

const config = require('eslint-config-twilio-base');

correct

module.exports = {
  extends: 'twilio-base'
};

This config is used via ESLint's extends mechanism, not directly imported.

Default import

wrong

import { twilioBase } from 'eslint-config-twilio-base';

correct

module.exports = {
  extends: ['twilio-base']
};

ESLint configs are not JavaScript modules; use extends string.

Initialize in .eslintrc
wrong
```
{
  "extends": "eslint-config-twilio-base"
}
```
correct
```
{
  "extends": "twilio-base"
}
```
Require the package name without the prefix, as ESLint resolves it automatically.

Quickstart

Shows how to use twilio-base config in an ESLint configuration file.

// .eslintrc.json
{
  "extends": "twilio-base"
}

// Then run:
// npm install eslint eslint-config-twilio-base --save-dev
// eslint .