README

@matterlabs/eslint-config-typescript

This package provides Matter Labs's .eslintrc as an extensible shared typescript config.

📖 Description

Leverage Matter Labs's standard eslint configuration for your TypeScript projects. This configuration is built on top of several reputable configurations and plugins, and it's been tailored to fit Matter Labs's style and preferences.

📦 Installation

To use the @matterlabs/eslint-config-typescript, first install the package:

npm i -D @matterlabs/eslint-config-typescript

or with yarn:

yarn add @matterlabs/eslint-config-typescript -D

🚀 Usage

Once installed, add it to your .eslintrc or eslint.config.js:

{
  "extends": ["@matterlabs/eslint-config-typescript"]
}

📜 Rules Overview

Here's a quick overview of some of the primary rules:

• Semicolons: Always required.
• Quotes: Double quotes are mandatory.
• No Console & No Debugger: Warnings in development, errors in production.
• TypeScript Consistent Type Imports: Prefer type-imports.
• Import Order: Specific ordering with groups and ascending alphabetization.

For a detailed list of all rules, please refer to the source configuration

⚙️ Peer Dependencies

• @typescript-eslint/eslint-plugin: ^6.5.0
• @typescript-eslint/parser: ^6.5.0
• eslint: ^8.48.0
• eslint-plugin-import: ^2.28.1
• eslint-plugin-prettier: ^5.0.0
• prettier: ^3.0.3

🤝 Contributing

We welcome contributions from the community! If you're interested in contributing to the Matter Labs Eslint Config, please take a look at our CONTRIBUTING.md for guidelines and details on the process.

📜 License

This project is licensed under MIT and APACHE 2.0.