eslint-config-msgraph

This repository contains a shareable ESLint and Prettier configuration used by the Microsoft Graph Developer Experience team. Suggestions for changes are greatly welcomed, please raise an issue to discuss your suggestion.

Installation

To install the configuration, run the following command:

npm install --save-dev @microsoft/eslint-config-msgraph

You will also need to install the peer dependencies:

npm install --save-dev eslint @eslint/js @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-config-prettier eslint-plugin-prefer-arrow globals prettier

eslint configuration

This package uses ESLint flat config format.

non-React projects

If your project does not contain react components, use this configuration.

In your project's eslint.config.js file:

const msgraphConfig = require('@microsoft/eslint-config-msgraph/core');

module.exports = [
  ...msgraphConfig,
  // add any overrides here
];

React projects

If your project contains react components, also install eslint-plugin-react:

npm install --save-dev eslint-plugin-react

In your project's eslint.config.js file:

const msgraphConfig = require('@microsoft/eslint-config-msgraph');

module.exports = [
  ...msgraphConfig,
  // add any overrides here
];

Prettier configuration

To use the shared Prettier config, add a prettier.config.cjs file with the following contents:

module.exports = {
  ...require('@microsoft/eslint-config-msgraph/prettier.config'),
  // add any overrides here
};

Feedback and Requests

Please use GitHub Issues for bug reports and feature requests. We highly recommend you browse existing issues before opening new issues.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

License

All files in this GitHub repository are subject to the MIT license. This project also references fonts and icons from a CDN, which are subject to a separate asset license.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.