Title: Errors in generated declaration files · Issue #37552 · microsoft/TypeScript · GitHub
Open Graph Title: Errors in generated declaration files · Issue #37552 · microsoft/TypeScript
X Title: Errors in generated declaration files · Issue #37552 · microsoft/TypeScript
Description: TypeScript Version: 3.9.0-dev.20200324 Search Terms: declaration errors, declaration files, TS1147, TS2307, TS2503 (ISSUE EXPLANATION BELOW) Code Source: ./file-a.js /** * @namespace myTypes * @global * @type {Object
Open Graph Description: TypeScript Version: 3.9.0-dev.20200324 Search Terms: declaration errors, declaration files, TS1147, TS2307, TS2503 (ISSUE EXPLANATION BELOW) Code Source: ./file-a.js /** * @namespace myTypes * @glo...
X Description: TypeScript Version: 3.9.0-dev.20200324 Search Terms: declaration errors, declaration files, TS1147, TS2307, TS2503 (ISSUE EXPLANATION BELOW) Code Source: ./file-a.js /** * @namespace myTypes * @glo...
Opengraph URL: https://github.com/microsoft/TypeScript/issues/37552
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Errors in generated declaration files","articleBody":"\u003c!-- 🚨 STOP 🚨 𝗦𝗧𝗢𝗣 🚨 𝑺𝑻𝑶𝑷 🚨\r\n\r\nHalf of all issues filed here are duplicates, answered in the FAQ, or not appropriate for the bug tracker. Even if you think you've found a *bug*, please read the FAQ first, especially the Common \"Bugs\" That Aren't Bugs section!\r\n\r\nPlease help us by doing the following steps before logging an issue:\r\n * Search: https://github.com/Microsoft/TypeScript/search?type=Issues\r\n * Read the FAQ: https://github.com/Microsoft/TypeScript/wiki/FAQ\r\n\r\nPlease fill in the *entire* template below.\r\n-->\r\n\r\n\u003c!--\r\nPlease try to reproduce the issue with the latest published version. It may have already been fixed.\r\nFor npm: `typescript@next`\r\nThis is also the 'Nightly' version in the playground: http://www.typescriptlang.org/play/?ts=Nightly\r\n-->\r\n**TypeScript Version:** 3.9.0-dev.20200324\r\n\r\n\u003c!-- Search terms you tried before logging this (so others can find this issue more easily) -->\r\n**Search Terms:** declaration errors, declaration files, TS1147, TS2307, TS2503\r\n\r\n***(ISSUE EXPLANATION BELOW)***\r\n\r\n**Code**\r\n---\r\n**Source:**\r\n\r\n***./file-a.js***\r\n```js\r\n/**\r\n * @namespace myTypes\r\n * @global\r\n * @type {Object\u003cstring,*>}\r\n */\r\nconst myTypes = {\r\n // SOME PROPS HERE\r\n};\r\n\r\n/** @typedef {string|RegExp|Array\u003cstring|RegExp>} myTypes.typeA */\r\n\r\n/**\r\n * @typedef myTypes.typeB\r\n * @property {myTypes.typeA} prop1 - Prop 1.\r\n * @property {string} prop2 - Prop 2.\r\n */\r\n\r\n/** @typedef {myTypes.typeB|Function} myTypes.typeC */\r\n\r\nexport {myTypes};\r\n```\r\n\r\n***./file-b.js***\r\n```js\r\nimport {myTypes} from './file-a.js';\r\n\r\n/**\r\n * @namespace testFnTypes\r\n * @global\r\n * @type {Object\u003cstring,*>}\r\n */\r\nconst testFnTypes = {\r\n // SOME PROPS HERE\r\n};\r\n\r\n/** @typedef {boolean|myTypes.typeC} testFnTypes.input */\r\n\r\n/**\r\n * @function testFn\r\n * @description A test function.\r\n * @param {testFnTypes.input} input - Input.\r\n * @returns {number|null} Result.\r\n */\r\nfunction testFn(input) {\r\n if (typeof input === 'number') {\r\n return 2 * input;\r\n } else {\r\n return null;\r\n }\r\n}\r\n\r\nexport {testFn, testFnTypes};\r\n\r\n```\r\n\r\n**Generated Declarations:**\r\n\r\n***./file-a.d.ts***\r\n```ts\r\n/**\r\n * @namespace myTypes\r\n * @global\r\n * @type {Object\u003cstring,*>}\r\n */\r\nexport const myTypes: {\r\n [x: string]: any;\r\n};\r\nexport namespace myTypes {\r\n export type typeA = string | RegExp | (string | RegExp)[];\r\n export type typeB = {\r\n /**\r\n * - Prop 1.\r\n */\r\n prop1: string | RegExp | (string | RegExp)[];\r\n /**\r\n * - Prop 2.\r\n */\r\n prop2: string;\r\n };\r\n export type typeC = Function | typeB;\r\n}\r\n```\r\n\r\n***./file-b.d.ts***\r\n```ts\r\n/** @typedef {boolean|myTypes.typeC} testFnTypes.input */\r\n/**\r\n * @function testFn\r\n * @description A test function.\r\n * @param {testFnTypes.input} input - Input.\r\n * @returns {number|null} Result.\r\n */\r\nexport function testFn(input: boolean | Function | myTypes.typeB): number; // TS2503 ERROR HERE!\r\n/**\r\n * @namespace testFnTypes\r\n * @global\r\n * @type {Object\u003cstring,*>}\r\n */\r\nexport const testFnTypes: {\r\n [x: string]: any;\r\n};\r\nexport namespace testFnTypes {\r\n export type input = boolean | Function | myTypes.typeB;\r\n import { myTypes } from \"./file-a.js\"; // TS1147, TS2307 ERRORS HERE!\r\n}\r\n// WHY IS ABOVE IMPORT STATEMENT NOT PLACED HERE? MANUALLY DOING IT, APPARENTLY SOLVES THE ISSUE.\r\n\r\n```\r\n\r\n**Issue explanation:**\r\n\r\nTypeSctript does a very good job generating declaration files based on existing JS files, even in complex scenarios.\r\n\r\nHowever, some errors appear when TypeScript decides to import declarations from other files. This happens when referenced declarations are sufficiently large (as in this example) to not be just copied.\r\n\r\nIn the `./file-b.d.ts` generated declaration file I get the following errors in order of appearance (see code):\r\n\r\n* `TS2503: Cannot find namespace 'myTypes'.`\r\n* `TS1147: Import declarations in a namespace cannot reference a module.`\r\n* `TS2307: Cannot find module './file-a.js' or its corresponding type declarations.`\r\n\r\nWhen the import statement is moved outside of the namespace, all errors disappear (makes sense from a JS point of view).\r\n\r\nBeside this highlighted errors, only seen when opening the generated declaration files. Everything seems to work as intended (Type checking, auto-completion, etc.). Even when consuming the compiled library with the generated declaration files included (with those \"errors\" present).\r\n\r\n**Expected behavior:**\r\n\r\nNo error to be present in generated declaration files.\r\n\r\n**Actual behavior:**\r\n\r\nErrors are present as explained above.\r\n\r\n**Playground Link:** \u003c!-- A link to a TypeScript Playground \"Share\" link which demonstrates this behavior --> Not possible because import/export involved.\r\n\r\n**Related Issues:** \u003c!-- Did you find other bugs that looked similar? --> None.\r\n\r\n**Additional Details:**\r\n\r\n\u003cdetails>\r\n\u003csummary>TypeScript Configuration\u003c/summary>\r\n\r\n```js\r\n{\r\n \"compilerOptions\": {\r\n \"target\": \"ESNext\",\r\n \"module\": \"ESNext\",\r\n \"moduleResolution\": \"Node\",\r\n \"lib\": [\"ESNext\", \"DOM\"],\r\n \"allowJs\": true,\r\n \"checkJs\": true,\r\n \"strict\": true,\r\n \"noImplicitAny\": false,\r\n \"strictNullChecks\": false,\r\n \"types\": [\"node\", \"mocha\", \"chai\"],\r\n \"esModuleInterop\": false,\r\n \"forceConsistentCasingInFileNames\": true,\r\n \"useDefineForClassFields\": true\r\n \"noEmit\": false,\r\n \"noEmitOnError\": false,\r\n \"declaration\": true,\r\n \"emitDeclarationOnly\": true,\r\n \"declarationDir\": \"./types\"\r\n },\r\n \"files\": [\"./src/index.js\"],\r\n \"exclude\": [\"./src/__tests__/**/*.js\"]\r\n}\r\n```\r\n\u003c/details>\r\n","author":{"url":"https://github.com/ernestostifano","@type":"Person","name":"ernestostifano"},"datePublished":"2020-03-24T13:08:28Z","url":"https://github.com/microsoft/TypeScript/issues/37552"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:a8557fe0-78d0-626d-590f-5ca8158c14b7 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8AA0:19AA62:2ADD3A2:3670A22:6B01AA3E |
| html-safe-nonce | 46eb9a7ef19bcac8f859c5b55bb0ea8428e08391f37042b04bd38c3798695e0d |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QUEwOjE5QUE2MjoyQUREM0EyOjM2NzBBMjI6NkIwMUFBM0UiLCJ2aXNpdG9yX2lkIjoiMjg3NDU0ODczMTcwODAyNTQwNiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 18bdf137be3b9fbe013df1d4afc0ff44e38563a5290f830748317d4a7d00a267 |
| hovercard-subject-tag | issue:586946929 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/microsoft/TypeScript/37552/issue_layout |
| twitter:image | https://opengraph.githubassets.com/ae1783ec608994411f6f566c28313b6163b88b908770f5e046161b88103668a0/microsoft/TypeScript/issues/37552 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/ae1783ec608994411f6f566c28313b6163b88b908770f5e046161b88103668a0/microsoft/TypeScript/issues/37552 |
| og:image:alt | TypeScript Version: 3.9.0-dev.20200324 Search Terms: declaration errors, declaration files, TS1147, TS2307, TS2503 (ISSUE EXPLANATION BELOW) Code Source: ./file-a.js /** * @namespace myTypes * @glo... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | ernestostifano |
| hostname | github.com |
| expected-hostname | github.com |
| None | cc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c |
| turbo-cache-control | no-preview |
| go-import | github.com/microsoft/TypeScript git https://github.com/microsoft/TypeScript.git |
| octolytics-dimension-user_id | 6154722 |
| octolytics-dimension-user_login | microsoft |
| octolytics-dimension-repository_id | 20929025 |
| octolytics-dimension-repository_nwo | microsoft/TypeScript |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 20929025 |
| octolytics-dimension-repository_network_root_nwo | microsoft/TypeScript |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 8c77c9e8439031ad54c75a250694842892f693e1 |
| ui-target | canary-1 |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width