@zanix/eslint-config

Zanix Framework ESLint Config

Table of Contents

• Introduction
• Installation
• Usage
• Support and Contributions
• License
• Credits
• Acknowledgements

Introduction

Zanix Framework ESLint Config is a shareable ESLint configuration package designed for Zanix Framework projects. It provides a set of ESLint rules and configurations to ensure consistent code style and quality across Zanix Framework applications.

This package includes the following features:

• Pre-configured ESLint rules optimized for Zanix Framework projects
• Consistent code style guidelines for JavaScript and TypeScript
• Support for popular plugins and extensions commonly used in Zanix Framework projects

Installation

To install the Zanix Framework ESLint Config package, use npm or yarn:

npm install --save-dev @zanix/eslint-config

or

yarn add --dev @zanix/eslint-config

Usage

To use the Zanix Framework ESLint Config in your project, create an eslint.config.(js|cjs|mjs) file in the root directory of your project and extend the Zanix Framework ESLint Config:

{
  "extends": "@zanix/eslint-config"
}

You can customize the configuration by extending the base configuration and adding or overriding rules specific to your project.

For TypeScript projects, you can extend the TypeScript configuration:

{
  "extends": "@zanix"
}

• prettier.js: Create a .prettierrc file in the root of your project with the following content to use the opinionated code formatting rules defined by Zanix Framework.

  "@zanix/eslint-config/prettier"
  

Support and Contributions

For more information on how to use the templates and get started with ZANIX configuration, please refer to the documentation or to the changelog.

Contributions are welcome! If you have suggestions, bug reports, or feature requests, please open an issue on the GitHub repository. Pull requests are also appreciated.

License

Zanix Framework ESLint Config is licensed under the MIT License.

Credits

Zanix Framework ESLint Config is maintained and sponsored by Zanix Framework.

• GitHub: https://github.com/zanix-io

Acknowledgements ✨

We would like to express our gratitude to the developers of ESLint and all the contributors who have made their plugins and configurations available. Their work has been instrumental in the development of this ESLint configuration.