JSDoc typedef imports are emitted with a resolved path to node_modules

[bashmish]

🔎 Search Terms

"JSDoc", "typedef", "node_modules", "resolved"

🕗 Version & Regression Information

• This is the behavior in every version I tried, and I reviewed the FAQ for entries about common bugs

⏯ Playground Link

https://stackblitz.com/edit/issue-ts-jsdoc-typedef-resolved-node-modules?file=issue.js,dist-types%2Fissue.d.ts

In the StackBlitz example you can run npm run build:watch to play with the input and output of issue.js.

💻 Code

/**
 * @typedef {import('@lion/ajax').LionRequestInit} LionRequestInit
 */

export class NewAjax {
  /**
   * @param {LionRequestInit} init
   */
  case1_works(init) {}

  /**
   * @param {LionRequestInit?} init
   */
  case2_works(init) {}

  /**
   * @param {LionRequestInit=} init
   */
  case3_works(init) {}

  /**
   * @type {(init?: LionRequestInit) => void}
   */
  case4_works(init) {}

  /**
   * @param {LionRequestInit} [init]
   */
  case5_unexpectedlyResolvesPathToNodeModules(init) {}
}

/**
 * @type {(init?: LionRequestInit) => void}
 */
// @ts-expect-error
NewAjax.prototype.case6_unexpectedlyResolvesPathToNodeModules;

🙁 Actual behavior

For some cases (case5 and case6) the emitted .d.ts files contains a path to node_modules, which is not needed and when published to NPM as part of my library will not resolve correctly.

/**
 * @typedef {import('@lion/ajax').LionRequestInit} LionRequestInit
 */
export class NewAjax {
    /**
     * @param {LionRequestInit} init
     */
    case1_works(init: LionRequestInit): void;
    /**
     * @param {LionRequestInit?} init
     */
    case2_works(init: LionRequestInit | null): void;
    /**
     * @param {LionRequestInit=} init
     */
    case3_works(init?: LionRequestInit | undefined): void;
    case4_works(init?: LionRequestInit): void;
    /**
     * @param {LionRequestInit} [init]
     */
    case5_unexpectedlyResolvesPathToNodeModules(init?: import("./node_modules/@lion/ajax/dist-types/types/types.js").LionRequestInit | undefined): void;
    /**
     * @type {(init?: LionRequestInit) => void}
     */
    case6_unexpectedlyResolvesPathToNodeModules: (init?: import("./node_modules/@lion/ajax/dist-types/types/types.js").LionRequestInit | undefined) => void;
}
export type LionRequestInit = import('@lion/ajax').LionRequestInit;

🙂 Expected behavior

case5 and case6 work the same as all others, just having methodName(init?: LionRequestInit | undefined): void;

Additional information about the issue

I'm using case6 to define method types without overriding it, because it's indirectly supporting smth that the parent class does not. So I'm intertested to make it work. Workarounds like case2-3-4 are not suitable for me.

[remcohaszing]

This happens consistently if TypeScript is unable to resolve a type from public exports based on inference.

This particular case looks different though.

[AlQubaiisi]

🔎 مصطلحات البحث

"JSDoc" ، "typedef" ، "node_modules" ، "تم حلها"

🕗 معلومات الإصدار والانحدار

• هذا هو السلوك في كل إصدار جربته ، وراجعت الأسئلة الشائعة للإدخالات حول الأخطاء الشائعة

⏯ رابط الملعب

https://stackblitz.com/edit/issue-ts-jsdoc-typedef-resolved-node-modules?file=issue.js,dist-types%2Fissue.d.ts

في مثال StackBlitz ، يمكنك الركض للعب بإدخال وإخراج .npm run build:watch``issue.js

💻 رمز

/**
 * @typedef {import('@lion/ajax').LionRequestInit} LionRequestInit
 */

export class NewAjax {
  /**
   * @param {LionRequestInit} init
   */
  case1_works(init) {}

  /**
   * @param {LionRequestInit?} init
   */
  case2_works(init) {}

  /**
   * @param {LionRequestInit=} init
   */
  case3_works(init) {}

  /**
   * @type {(init?: LionRequestInit) => void}
   */
  case4_works(init) {}

  /**
   * @param {LionRequestInit} [init]
   */
  case5_unexpectedlyResolvesPathToNodeModules(init) {}
}

/**
 * @type {(init?: LionRequestInit) => void}
 */
// @ts-expect-error
NewAjax.prototype.case6_unexpectedlyResolvesPathToNodeModules;

🙁 السلوك الفعلي

بالنسبة لبعض الحالات (و) ، تحتوي الملفات المنبعثة على مسار إلى ، وهو أمر غير مطلوب وعند نشره على NPM كجزء من مكتبتي لن يتم حله بشكل صحيح.case5``case6``.d.ts``node_modules

/**
 * @typedef {import('@lion/ajax').LionRequestInit} LionRequestInit
 */
export class NewAjax {
    /**
     * @param {LionRequestInit} init
     */
    case1_works(init: LionRequestInit): void;
    /**
     * @param {LionRequestInit?} init
     */
    case2_works(init: LionRequestInit | null): void;
    /**
     * @param {LionRequestInit=} init
     */
    case3_works(init?: LionRequestInit | undefined): void;
    case4_works(init?: LionRequestInit): void;
    /**
     * @param {LionRequestInit} [init]
     */
    case5_unexpectedlyResolvesPathToNodeModules(init?: import("./node_modules/@lion/ajax/dist-types/types/types.js").LionRequestInit | undefined): void;
    /**
     * @type {(init?: LionRequestInit) => void}
     */
    case6_unexpectedlyResolvesPathToNodeModules: (init?: import("./node_modules/@lion/ajax/dist-types/types/types.js").LionRequestInit | undefined) => void;
}
export type LionRequestInit = import('@lion/ajax').LionRequestInit;

🙂 سلوك متوقع

case5 والعمل مثل جميع الآخرين ، فقط وجود case6``methodName(init?: LionRequestInit | undefined): void;

معلومات إضافية حول المشكلة

أنا أستخدم لتحديد أنواع الأساليب دون تجاوزها ، لأنها تدعم بشكل غير مباشر smth الذي لا تفعله الفئة الأصلية. لذلك أنا متحمس لجعلها تعمل. الحلول البديلة مثل case2-3-4 ليست مناسبة لي.case6