Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[eslint-plugin] stop linting JS/TS code blocks in Markdown files #33194

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[eslint-plugin] stop linting JS/TS code blocks in Markdown files #33194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions common/tools/eslint-plugin-azure-sdk/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@
"@typescript-eslint/eslint-plugin": "~8.24.1",
"@typescript-eslint/parser": "~8.24.1",
"eslint": "^9.9.0",
"eslint-plugin-markdown": "^5.0.0",
"eslint-plugin-n": "^17.15.0",
"eslint-plugin-no-only-tests": "^3.3.0",
"eslint-plugin-promise": "^7.2.1",
Expand Down Expand Up @@ -118,7 +117,6 @@
"@vitest/browser": "^3.0.3",
"@vitest/coverage-istanbul": "^3.0.3",
"eslint": "^9.9.0",
"eslint-plugin-markdown": "^5.0.0",
"playwright": "^1.49.1",
"prettier": "^3.3.3",
"rimraf": "^5.0.5",
Expand Down
4 changes: 0 additions & 4 deletions common/tools/eslint-plugin-azure-sdk/src/configs/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ import eslint from "@eslint/js";
import typescriptEslint from "typescript-eslint";
import type { FlatConfig } from "@typescript-eslint/utils/ts-eslint";
import eslintConfigPrettier from "eslint-config-prettier";
import markdown from "eslint-plugin-markdown";
import promise from "eslint-plugin-promise";

import eslintCustomized from "./eslint-customized.js";
import markdownCustomized from "./markdown-customized.js";
import azureSdkCustomized from "./azure-sdk-customized.js";

function recommended(plugin: FlatConfig.Plugin, options: { typeChecked: boolean }) {
Expand All @@ -26,7 +24,6 @@ function recommended(plugin: FlatConfig.Plugin, options: { typeChecked: boolean
{
plugins: {
"@azure/azure-sdk": plugin,
markdown,
promise,
},
},
Expand All @@ -35,7 +32,6 @@ function recommended(plugin: FlatConfig.Plugin, options: { typeChecked: boolean

// azure sdk customized
eslintCustomized,
...markdownCustomized,
...azureSdkCustomized(typescriptEslint.parser),
);
}
Expand Down
60 changes: 0 additions & 60 deletions common/tools/eslint-plugin-azure-sdk/src/configs/markdown-customized.ts
View file
Open in desktop

This file was deleted.

30 changes: 1 addition & 29 deletions common/tools/eslint-plugin-azure-sdk/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,38 +19,10 @@ const plugin: Omit<FlatConfig.Plugin, "configs"> = {
// assign configs here so we can reference `plugin`
const configs = azsdkConfigs(plugin);

// helper to ensure azure sdk markdown rules are not overridden by custom rules
function config(customConfigs?: FlatConfig.ConfigArray) {
const updated = customConfigs?.length
? customConfigs.map((rule) => {
if (!rule.files) {
return rule;
}

const containsMarkdownFiles = (patterns: (string | string[])[]) => {
if (Array.isArray(patterns) && patterns.some((p) => p.includes("/*.md/"))) {
return true;
} else if (patterns.includes("/*.md/")) {
return true;
}

return false;
};
// is the rule for *.md?
if (containsMarkdownFiles(rule.files)) {
return rule;
}

return {
...rule,
ignores: [...(rule.ignores ?? []), "**/*.md/*.ts", "**/*.md/*.js", "**/*.md/*.json"],
};
})
: [];

return [
...configs.recommended,
...updated,
...(customConfigs ?? []),
{
ignores: ["**/test/snippets.spec.ts", "**/test/stress"],
},
Expand Down
Loading