Merge remote-tracking branch 'remotes/origin/main' into default-value-inline-content

Author: octogonz

common/changes/@microsoft/tsdoc-config/octogonz-missing-changelog_2024-07-25-03-42.json

@@ -1,6 +1,31 @@
 {
   "name": "eslint-plugin-tsdoc",
   "entries": [
+    {
+      "version": "0.4.0",
+      "tag": "eslint-plugin-tsdoc_v0.4.0",
+      "date": "Sat, 23 Nov 2024 00:23:35 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Include CHANGELOG.md in published releases again"
+          }
+        ],
+        "minor": [
+          {
+            "comment": "Leverage `parserOptions.tsConfigRootDir` to reduce file system probing. This field is commonly used when eslint is configured with `@typescript-eslint/parser`."
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@microsoft/tsdoc\" to `0.15.1`"
+          },
+          {
+            "comment": "Updating dependency \"@microsoft/tsdoc-config\" to `0.17.1`"
+          }
+        ]
+      }
+    },
     {
       "version": "0.3.0",
       "tag": "eslint-plugin-tsdoc_v0.3.0",

common/changes/@microsoft/tsdoc/octogonz-missing-changelog_2024-07-25-03-42.json

@@ -1,6 +1,17 @@
 # Change Log - eslint-plugin-tsdoc
 
-This log was last generated on Tue, 28 May 2024 21:34:19 GMT and should not be manually modified.
+This log was last generated on Sat, 23 Nov 2024 00:23:35 GMT and should not be manually modified.
+
+## 0.4.0
+Sat, 23 Nov 2024 00:23:35 GMT
+
+### Minor changes
+
+- Leverage `parserOptions.tsConfigRootDir` to reduce file system probing. This field is commonly used when eslint is configured with `@typescript-eslint/parser`.
+
+### Patches
+
+- Include CHANGELOG.md in published releases again
 
 ## 0.3.0
 Tue, 28 May 2024 21:34:19 GMT

common/changes/eslint-plugin-tsdoc/octogonz-missing-changelog_2024-07-25-03-42.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-tsdoc",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "An ESLint plugin that validates TypeScript doc comments",
   "keywords": [
     "TypeScript",

eslint-plugin/CHANGELOG.json

@@ -26,6 +26,7 @@ const CACHE_MAX_SIZE: number = 100;
 export class ConfigCache {
   // findConfigPathForFolder() result --> loaded tsdoc.json configuration
   private static _cachedConfigs: Map<string, ICachedConfig> = new Map<string, ICachedConfig>();
+  private static _cachedPaths: Map<string, string> = new Map();
 
   /**
    * Node.js equivalent of performance.now().
@@ -35,11 +36,17 @@ export class ConfigCache {
     return seconds * 1000 + nanoseconds / 1000000;
   }
 
-  public static getForSourceFile(sourceFilePath: string): TSDocConfigFile {
+  public static getForSourceFile(
+    sourceFilePath: string,
+    tsConfigRootDir?: string | undefined
+  ): TSDocConfigFile {
     const sourceFileFolder: string = path.dirname(path.resolve(sourceFilePath));
 
     // First, determine the file to be loaded. If not found, the configFilePath will be an empty string.
-    const configFilePath: string = TSDocConfigFile.findConfigPathForFolder(sourceFileFolder);
+    // If the eslint config has specified where the tsconfig file is, use that path directly without probing the filesystem.
+    const configFilePath: string = tsConfigRootDir
+      ? path.join(tsConfigRootDir, TSDocConfigFile.FILENAME)
+      : TSDocConfigFile.findConfigPathForFolder(sourceFileFolder);
 
     // If configFilePath is an empty string, then we'll use the folder of sourceFilePath as our cache key
     // (instead of an empty string)

eslint-plugin/CHANGELOG.md

@@ -41,13 +41,16 @@ const plugin: IPlugin = {
         }
       },
       create: (context: eslint.Rule.RuleContext) => {
-        const sourceFilePath: string = context.getFilename();
+        const sourceFilePath: string = context.filename;
+        // If eslint is configured with @typescript-eslint/parser, there is a parser option
+        // to explicitly specify where the tsconfig file is. Use that if available.
+        const tsConfigDir: string | undefined = context.parserOptions.tsconfigRootDir;
         Debug.log(`Linting: "${sourceFilePath}"`);
 
         const tsdocConfiguration: TSDocConfiguration = new TSDocConfiguration();
 
         try {
-          const tsdocConfigFile: TSDocConfigFile = ConfigCache.getForSourceFile(sourceFilePath);
+          const tsdocConfigFile: TSDocConfigFile = ConfigCache.getForSourceFile(sourceFilePath, tsConfigDir);
           if (!tsdocConfigFile.fileNotFound) {
             if (tsdocConfigFile.hasErrors) {
               context.report({

eslint-plugin/package.json

@@ -1,6 +1,23 @@
 {
   "name": "@microsoft/tsdoc-config",
   "entries": [
+    {
+      "version": "0.17.1",
+      "tag": "@microsoft/tsdoc-config_v0.17.1",
+      "date": "Sat, 23 Nov 2024 00:23:35 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Include CHANGELOG.md in published releases again"
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@microsoft/tsdoc\" to `0.15.1`"
+          }
+        ]
+      }
+    },
     {
       "version": "0.17.0",
       "tag": "@microsoft/tsdoc-config_v0.17.0",

eslint-plugin/src/ConfigCache.ts

@@ -1,6 +1,13 @@
 # Change Log - @microsoft/tsdoc-config
 
-This log was last generated on Tue, 28 May 2024 21:34:19 GMT and should not be manually modified.
+This log was last generated on Sat, 23 Nov 2024 00:23:35 GMT and should not be manually modified.
+
+## 0.17.1
+Sat, 23 Nov 2024 00:23:35 GMT
+
+### Patches
+
+- Include CHANGELOG.md in published releases again
 
 ## 0.17.0
 Tue, 28 May 2024 21:34:19 GMT