[engsys] upgrade dev dependency eslint-plugin-markdown to ^5.0.0 (Azure#29697)

The breaking change that impacts us is that now `typescript` and `javascript` code blocks in markdown files are maped to virtual files with `.ts` or `.js`, instead of `.typescript` or `.javascript` as previously in v4.

This PR reacts to the change:

- Add an overrides entry for `**/*.md/*.ts` because they now match the files pattern of our first overrides entry. Previously they are not linted because of their old `.typescript` extension. Their `project` is set to `null` as they don't belong to any project. They still are benefited from rules that don't require type checking.

Author: jeremymeng

common/config/rush/pnpm-lock.yaml

@@ -12,7 +12,7 @@
     "eslint-plugin-no-only-tests": "^3.0.0",
     "eslint-plugin-promise": "^6.0.0",
     "eslint-plugin-tsdoc": "^0.2.10",
-    "eslint-plugin-markdown": "^4.0.0"
+    "eslint-plugin-markdown": "^5.0.0"
   },
   "dependencies": {
     "@typescript-eslint/utils": "~7.8.0",

common/tools/eslint-plugin-azure-sdk-helper/package.json

@@ -80,7 +80,7 @@
     "@vitest/coverage-istanbul": "^1.4.0",
     "cross-env": "^7.0.3",
     "eslint": "^8.50.0",
-    "eslint-plugin-markdown": "^4.0.0",
+    "eslint-plugin-markdown": "^5.0.0",
     "prettier": "^3.2.5",
     "rimraf": "^5.0.5",
     "source-map-support": "^0.5.9",

common/tools/eslint-plugin-azure-sdk/package.json

@@ -15,21 +15,29 @@ export default {
     "import",
     "markdown",
   ],
-  extends: ["eslint:recommended", "plugin:promise/recommended", "prettier"],
   env: {
     mocha: true,
+    es2017: true,
   },
   ignorePatterns: ["**/generated/**"],
   overrides: [
     {
       files: ["*.ts", "*.cts", "*.mts", "*.tsx", "*.json"],
+      excludedFiles: [
+        "**/*.md/*.ts",
+        "**/*.md/*.json",
+        "**/src/**/*.json",
+        "**/test/**/*.json",
+      ],
       parserOptions: {
         project: [
           "./tsconfig.json",
           "../../../common/tools/eslint-plugin-azure-sdk/tsconfig.lintjson.json",
         ],
       },
       extends: [
+        "eslint:recommended",
+        "plugin:promise/recommended",
         "plugin:@typescript-eslint/recommended",
         "plugin:@typescript-eslint/eslint-recommended",
         "prettier",
@@ -140,9 +148,11 @@ export default {
       processor: "markdown/markdown",
     },
     {
-      files: ["**/*.md/*.{js,javascript}"],
+      files: ["*.md/*.js"],
       extends: ["plugin:markdown/recommended-legacy"],
       rules: {
+        "no-unused-vars": "off",
+        "no-undef": "off",
         "no-restricted-imports": [
           "error",
           {
@@ -156,5 +166,15 @@ export default {
         ],
       },
     },
+    {
+      files: ["*md/*.ts"],
+      parserOptions: {
+        project: null,
+      },
+      extends: ["plugin:@typescript-eslint/recommended", "plugin:@typescript-eslint/eslint-recommended"],
+      rules: {
+        "@typescript-eslint/no-unused-vars": "off",
+      },
+    },
   ],
 };

common/tools/eslint-plugin-azure-sdk/src/configs/azure-sdk-base.ts

@@ -92,7 +92,7 @@ import { RecipientVerificationClient } from "@azure-tools/communication-recipien
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new RecipientVerificationClient(connectionString);
 
-async main function() {
+async function main() {
   // body of the request
   const VerificationRequest = {
     identity: "+11234567890",
@@ -114,7 +114,7 @@ import { RecipientVerificationClient } from "@azure-tools/communication-recipien
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new RecipientVerificationClient(connectionString);
 
-async main function() {
+async function main() {
   // id that is used to reference users phone number
   const verificationId = "7e5dd7e1-5203-41ab-960e-65c1eb804fc6";
 
@@ -138,7 +138,7 @@ import { RecipientVerificationClient } from "@azure-tools/communication-recipien
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new RecipientVerificationClient(connectionString);
 
-async main function() {
+async function main() {
   // id that is used to reference users phone number
   const verificationId = "4d313ff0-3aeb-477e-8c15-7c9a893e8999";
 
@@ -156,7 +156,7 @@ import { RecipientVerificationClient } from "@azure-tools/communication-recipien
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new RecipientVerificationClient(connectionString);
 
-async main function() {
+async function main() {
   // get all verifications for a resource
   var verifications = await client.getVerifications();
 

sdk/communication/communication-recipient-verification/README.md

@@ -104,7 +104,7 @@ import { ShortCodesClient } from "@azure-tools/communication-short-codes";
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new ShortCodesClient(connectionString);
 
-async main function() {
+async function main() {
   const programBriefId = "00000000-0000-0000-0000-000000000000";
   const programBriefRequest: ShortCodesCreateUSProgramBriefParams = {
     body: {
@@ -194,7 +194,7 @@ import { ShortCodesClient } from "@azure-tools/communication-short-codes";
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new ShortCodesClient(connectionString);
 
-async main function() {
+async function main() {
   // get all program briefs for a resource
   var programBriefs = await client.listUSProgramBriefs();
 
@@ -230,7 +230,7 @@ import { ShortCodesClient } from "@azure-tools/communication-short-codes";
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new ShortCodesClient(connectionString);
 
-async main function() {
+async function main() {
   // get a program briefs for a resource
   const programBriefId = process.env.PROGRAM_BRIEF_TO_GET || "<program brief Id>";
   var programBrief = await client.getUSProgramBrief(programBriefId);
@@ -267,7 +267,7 @@ import { ShortCodesClient } from "@azure-tools/communication-short-codes";
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new ShortCodesClient(connectionString);
 
-async main function() {
+async function main() {
   // get all short codes for a resource
   var shortCodes = await client.listShortCodes();
 
@@ -289,7 +289,7 @@ import { ShortCodesClient } from "@azure-tools/communication-short-codes";
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new ShortCodesClient(connectionString);
 
-async main function() {
+async function main() {
   // get all eligible short code costs for a resource
   var shortCodeCosts = await client.listShortCodeCosts();
 

sdk/communication/communication-short-codes/README.md

@@ -84,7 +84,7 @@ import { Tiering } from "@azure-tools/communication-tiering";
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new Tiering(connectionString);
 
-async main function() {
+async function main() {
   const resourceId = "5d41e908-de88-4bbf-94dc-fe9a1b51029b";
 
   // Get acquired numbers and limits for a resource
@@ -104,7 +104,7 @@ import { Tiering } from "@azure-tools/communication-tiering";
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new Tiering(connectionString);
 
-async main function() {
+async function main() {
   const resourceId = "5d41e908-de88-4bbf-94dc-fe9a1b51029b";
 
   // Get tier info for a resource

sdk/communication/communication-tiering/README.md

@@ -75,6 +75,7 @@ After calling `useIdentityPlugin`, the native broker plugin is registered to the
 
 Once the plugin is registered, you can enable WAM broker authentication by passing `brokerOptions` with an `enabled` property set to `true` to a credential constructor. In the following example, we use the `InteractiveBrowserCredential`.
 
+<!-- eslint-skip -->
 ```typescript
 import { nativeBrokerPlugin } from "@azure/identity-broker";
 import { useIdentityPlugin, InteractiveBrowserCredential } from "@azure/identity";
@@ -108,6 +109,7 @@ For a complete example of using an Electron app for retrieving a window handle,
 
 When the `useDefaultBrokerAccount` option is set to `true`, the credential will attempt to silently use the default broker account. If using the default account fails, the credential will fall back to interactive authentication.
 
+<!-- eslint-skip -->
 ```typescript
 import { nativeBrokerPlugin } from "@azure/identity-broker";
 import { useIdentityPlugin, InteractiveBrowserCredential } from "@azure/identity";
@@ -145,7 +147,7 @@ See the Azure Identity [troubleshooting guide][https://github.com/Azure/azure-sd
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
 ```typescript
-import { setLogLevel } from ("@azure/logger");
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```

sdk/identity/identity-broker/README.md

@@ -141,7 +141,7 @@ to be used with a Mixed Reality client library:
 // to the client.
 const accessToken = GetMixedRealityAccessTokenFromWebService();
 
-RemoteRenderingClient client = new RemoteRenderingClient(remoteRenderingEndpoint, accountId, accessToken);
+const client = new RemoteRenderingClient(remoteRenderingEndpoint, accountId, accessToken);
 ```
 
 ## Key concepts
@@ -201,7 +201,7 @@ The code is as follows:
 ```typescript Snippet:StartAComplexAssetConversion
   const inputSettings: AssetConversionInputSettings = {
     storageContainerUrl: inputStorageUrl,
-    blobPrefix: "Bicycle"
+    blobPrefix: "Bicycle",
     relativeInputAssetPath: "bicycle.gltf"
   };
   const outputSettings: AssetConversionOutputSettings = {