microsoft / microsoft/TypeScript
Inconsistent typechecking with require() in JS and TS
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
🔎 Search Terms
require import js ts module esm esmodule cjs commonjs
🕗 Version & Regression Information
- This happens in the nightly version of TS
⏯ Playground Link
Multiple files not supported in playground, see bug workbench
💻 Code
// @types: ["node"]
// @allowJs
// @checkJs
// @filename: module-cjs-js.js
const Value = "module-cjs-js";
module.exports = { Value };
// @filename: module-cjs-ts.ts
const Value = "module-cjs-ts";
module.exports = { Value };
// @filename: module-esm-js.js
const Value = "module-esm-js";
export { Value };
// @filename: module-esm-ts.ts
const Value = "module-esm-ts";
export { Value };
// @filename: main-js.js
const ConstRequireCjsJs = require("./module-cjs-js");
const ConstRequireEsmJs = require("./module-esm-js");
const ConstRequireCjsTs = require("./module-cjs-ts");
const ConstRequireEsmTs = require("./module-esm-ts");
console.log(ConstRequireCjsJs.Value); // (alias) const Value: "module-cjs-js"
// ^?
console.log(ConstRequireEsmJs.Value); // (alias) const Value: "module-esm-js"
// ^?
console.log(ConstRequireCjsTs.Value); // Error: Property 'Value' does not exist on type 'typeof import("./module-cjs-ts")'
// ^?
console.log(ConstRequireEsmTs.Value); // (alias) const Value: "module-esm-ts"
// ^?
import * as ImportFromCjsJs from "./module-cjs-js";
import * as ImportFromEsmJs from "./module-esm-js";
import * as ImportFromCjsTs from "./module-cjs-ts";
import * as ImportFromEsmTs from "./module-esm-ts";
console.log(ImportFromCjsJs.Value); // (alias) const Value: "module-cjs-js"
// ^?
console.log(ImportFromEsmJs.Value); // (alias) const Value: "module-esm-js"
// ^?
console.log(ImportFromCjsTs.Value); // Error: Property 'Value' does not exist on type 'typeof import("./module-cjs-ts")'
// ^?
console.log(ImportFromEsmTs.Value); // (alias) const Value: "module-esm-ts"
// ^?
// @filename: main-ts.ts
const ConstRequireCjsJs = require("./module-cjs-js");
const ConstRequireEsmJs = require("./module-esm-js");
const ConstRequireCjsTs = require("./module-cjs-ts");
const ConstRequireEsmTs = require("./module-esm-ts");
console.log(ConstRequireCjsJs.Value); // any
// ^?
console.log(ConstRequireEsmJs.Value); // any
// ^?
console.log(ConstRequireCjsTs.Value); // any
// ^?
console.log(ConstRequireEsmTs.Value); // any
// ^?
import * as ImportFromCjsJs from "./module-cjs-js";
import * as ImportFromEsmJs from "./module-esm-js";
import * as ImportFromCjsTs from "./module-cjs-ts";
import * as ImportFromEsmTs from "./module-esm-ts";
console.log(ImportFromCjsJs.Value); // (alias) const Value: "module-cjs-js"
// ^?
console.log(ImportFromEsmJs.Value); // (alias) const Value: "module-esm-js"
// ^?
console.log(ImportFromCjsTs.Value); // Error: Property 'Value' does not exist on type 'typeof import("./module-cjs-ts")'
// ^?
console.log(ImportFromEsmTs.Value); // (alias) const Value: "module-esm-ts"
// ^?
import ImportRequireCjsJs = require("./module-cjs-js");
import ImportRequireEsmJs = require("./module-esm-js");
import ImportRequireCjsTs = require("./module-cjs-ts");
import ImportRequireEsmTs = require("./module-esm-ts");
console.log(ImportRequireCjsJs.Value); // (alias) const Value: "module-cjs-js"
// ^?
console.log(ImportRequireEsmJs.Value); // (alias) const Value: "module-esm-js"
// ^?
console.log(ImportRequireCjsTs.Value); // Error: Property 'Value' does not exist on type 'typeof import("./module-cjs-ts")'
// ^?
console.log(ImportRequireEsmTs.Value); // (alias) const Value: "module-esm-ts"
// ^?
🙁 Actual behavior
Type resolution is inconsistent when using require() from .js and .ts files:
- CommonJS modules with .ts extension have no properties regardless of import type (no error if ESModule.ts or CommonJS.js)
- Using
require()in a .ts file is always unchecked (checked in a .js file or in .ts file withimport X =syntax)
| MainExt | Type | Ext | RequireOrImport | Issue |
|---|---|---|---|---|
| JS | CJS | JS | const X = require("Y") | |
| JS | ESM | JS | const X = require("Y") | |
| JS | CJS | TS | const X = require("Y") | Error |
| JS | ESM | TS | const X = require("Y") | |
| JS | CJS | JS | import * as X from "Y" | |
| JS | ESM | JS | import * as X from "Y" | |
| JS | CJS | TS | import * as X from "Y" | Error |
| JS | ESM | TS | import * as X from "Y" | |
| JS | CJS | JS | const X = require("Y") | |
| JS | ESM | JS | const X = require("Y") | |
| JS | CJS | TS | const X = require("Y") | Error |
| JS | ESM | TS | const X = require("Y") | |
| TS | CJS | JS | const X = require("Y") | Any |
| TS | ESM | JS | const X = require("Y") | Any |
| TS | CJS | TS | const X = require("Y") | Any |
| TS | ESM | TS | const X = require("Y") | Any |
| TS | CJS | JS | import * as X from "Y" | |
| TS | ESM | JS | import * as X from "Y" | |
| TS | CJS | TS | import * as X from "Y" | Error |
| TS | ESM | TS | import * as X from "Y" | |
| TS | CJS | JS | import X = require("Y") | |
| TS | ESM | JS | import X = require("Y") | |
| TS | CJS | TS | import X = require("Y") | Error |
| TS | ESM | TS | import X = require("Y") |
🙂 Expected behavior
I expected require() to be typechecked in .ts files because it's typechecked in .js files.
I expected imports of CommonJS .ts files to work because CommonJS .js files work and are typechecked.
Additional information about the issue
This problem happens when porting an existing Node.JS codebase that uses CommonJS require() modules to TypeScript. It's not possible to port the code without also forcing it into ES Modules because:
- CommonJS .ts files don't work
- require() from .ts files is not typechecked
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con il Workbench Repro fornito e confronta le forme require() e import nei file di modulo CommonJS ed ESM .js e .ts elencati. Traccia i punti di ingresso del controllo dei tipi e della risoluzione dei moduli per questi casi, quindi aggiungi una copertura di regressione che mostri un controllo coerente delle proprietà e gli import CommonJS .ts nell’intera matrice.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, node.js, typescript
- Ambito
- compilers
- Tipo di issue
- Bug
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 30/100