npm install @edx/eslint-config

ESLint configuration for edX JavaScript code.

About @edx/eslint-config

The "@edx/eslint-config" is an essential npm package for developers working with edX JavaScript code, ensuring that the codebase remains clean, consistent, and error-free. This ESLint configuration encapsulates a set of predefined rules specifically tailored for edX's coding standards, promoting best practices and modern JavaScript functionalities. By leveraging this package, developers can automatically detect common coding errors and potential issues early in the development cycle, significantly reducing the risk of bugs. Additionally, it helps maintain the uniformity of code style across multiple projects and teams, facilitating easier code reviews and collaborations.

To integrate this powerful tool into your project, simply use the command 'npm install @edx/eslint-config'. This installation process is straightforward and integrates seamlessly into your existing JavaScript project, setting up in minutes. Once installed, it configures ESLint to enforce edX’s specific coding conventions, saving developers from the tedious task of manually defining each rule. This not only speeds up the setup process but also ensures that all team members adhere to the same set of standards, thus enhancing code quality and maintainability.

The benefits of using "@edx/eslint-config" extend beyond just maintaining coding standards. It also plays a crucial role in optimizing the development workflow by automating the process of code review. With this configuration, teams can catch and fix issues at a much earlier stage, which not only improves the overall quality of the application but also accelerates the development time by avoiding lengthy debugging sessions in later stages. Moreover, for educational technology platforms like edX, having a robust, error-free, and easily maintainable codebase is critical to delivering a seamless learning experience, making "@edx/eslint-config" an invaluable asset.

More from openedx

openedx npm packages

Find the best node modules for your project.

Search npm

@edx/eslint-config

ESLint configuration for edX JavaScript code...

Read more

Dependencies

Core dependencies of this npm package and its dev dependencies.

@typescript-eslint/eslint-plugin, @typescript-eslint/parser, eslint, eslint-config-airbnb, eslint-config-airbnb-typescript, eslint-plugin-import, eslint-plugin-jsx-a11y, eslint-plugin-react, eslint-plugin-react-hooks

Documentation

A README file for the @edx/eslint-config code repository. View Code

Build Status NPM Version npm_downloads license semantic release

@edx/eslint-config

Installation

If you're using @edx/frontend-build, then you'll get this package for free. Otherwise, you can install it via:

npx install-peerdeps --dev @edx/eslint-config

This will install the package and all of its peer dependencies.

Then, once it's installed, create an .eslintrc.js file in the top-level directory of your project with the following contents:

module.exports = {
  extends: "@edx/eslint-config",
}

Using TypeScript

If @edx/eslint-config detects a tsconfig.json file in the root folder of your project, it will optionally configure ESLint to add support for TypeScript. If a tsconfig.json file exists, the ESLint config will:

airbnb-typescript may only be extended if a tsconfig.json file exists in your project.

If your tsconfig.json file is defined somewhere other than the root folder of your project, you may override the default ESLint configuration by extending airbnb-typescript and including the path to your tsconfig.json file in the parserOptions.project ESLint configuration.