microsoft / microsoft/TypeScript

JSDoc import integration doesn't support return-style AMD modules

オープン
#38,416 コメント 3 件 リアクション 0 件 担当者 1 名 GitHub で見る

@sandersn がすでに取り組んでいます。

2020年6月5日 から。

Awaiting More Feedback
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
2日 4時間
マージ済み PR(30日)
132

説明

TypeScript Version: 4.0.0-dev.20200508
also 3.8.3 (and presumably any other version)

Search Terms:
require, AMD, exports, import, JSDoc, module

Code

mod.js

// @ts-check

define(function () {
  // (1) this checks
  // exports.number = 12;

  // (2) this doesn't check
  // var exports = {
  //   number: 12
  // };
  // return exports;

  // (3) this also doesn't check
  return {
    number : 12
  }
});

usage.js

// @ts-check

define(function(require) {
  /** @type {import('mod')} */
  var Mod = require('mod');
  Mod.number;
});

My tsconfig is configured for JS/AMD/es5/noEmit:

    "allowJs": true,
    "module": "AMD",
    "target": "es5",
    "noEmit": true,

Expected behavior:

The import in the @type annotation in usage.js is correctly resolved for all three AMD module variants of mod.js .

Actual behavior:

Only the first variant, where number is explicitly added to exports works.
For the second and third variants, I get a compile error.

src/usage.js:4:23 - error TS2306: File 'd:/ns-prog/ts-jsdoc/src/mod.js' is not a module.

4     /** @type {import('mod')} */

Considering both (2) and (3) are valid AMD modules, I would expect this to work.

Note that JSDoc supports @exports annotation. Perhaps that could be utilized in the TypeScript-JSDoc integration?

Playground Link: N/A (I didn't see an option to have multiple files.)

Related Issues:
There's a StackOverflow question from 2016 https://stackoverflow.com/questions/37035462/importing-amd-modules-that-don-t-use-exports-with-typescript, but I didn't find any issue for it here.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。