Include examples on how to use configuration

This commit is contained in:
Martin Kačmar 2024-10-03 11:21:58 +02:00
Родитель 2e6989f7b4
Коммит 4be173cdc2
3 изменённых файлов: 17 добавлений и 7 удалений

Просмотреть файл

@ -21,13 +21,7 @@ yarn add microsoft/eslint-plugin-sdl
## Configs ## Configs
Including an ESLint configuration file in your project allows you to customize how ESLint applies rules to your project. You can include the plugin in your [configuration file](https://eslint.org/docs/latest/use/configure/configuration-files) by adding: Including an ESLint configuration file in your project allows you to customize how ESLint applies rules to your project. You can include the plugin in your [configuration file](https://eslint.org/docs/latest/use/configure/configuration-files) as described in examples for [`recommended`](contrib/eslint.config.recommended.js) and [`required`](contrib/eslint.config.required.js) configurations.
```js
const pluginMicrosoftSdl = require("@microsoft/eslint-plugin-sdl");
module.exports = [...pluginMicrosoftSdl.configs.recommended];
```
ESLint will then only enforce rules you specify in the rules section of your configuration file at the [severity level](https://eslint.org/docs/latest/use/configure/rules) you designate. For example: ESLint will then only enforce rules you specify in the rules section of your configuration file at the [severity level](https://eslint.org/docs/latest/use/configure/rules) you designate. For example:

Просмотреть файл

@ -0,0 +1,8 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
"use strict";
const pluginMicrosoftSdl = require("@microsoft/eslint-plugin-sdl");
module.exports = [...pluginMicrosoftSdl.configs.recommended];

Просмотреть файл

@ -0,0 +1,8 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
"use strict";
const pluginMicrosoftSdl = require("@microsoft/eslint-plugin-sdl");
module.exports = [...pluginMicrosoftSdl.configs.required];