Set global declaration in vscode JavaScript

Question

I'm working on a JavaScript transpiler that apart from other things will also replace certain functions and variables upon build.

For example the following file (./src/my-module.js):

defineModule("MyModule", function(exports) {
  return exports;
});

Will be copied and converted to (./build/my-module.js):

(function(global, factory) {
  "use strict";
  if (typeof exports !== "undefined" && typeof module !== "undefined") module.exports.MyModule = factory(exports.MyModule || {});
  else factory(global.MyModule = {});
})(this, function(exports) {
  return exports;
});

Some of these functions could also return a result. In that case I would like to be able to declare the types of the parameters and the result of the function without using require. Is it possible to have a global .d.ts definition in VSCode?

So far, all I've done is add the functions to the global variable of eslint so as to not have errors.

I am not sure if I understood correctly. Is this a Typescript project? If yes, what about adding the types to the paths config in tsconfig.json? Let me know if this is what you are looking for, so I will prepare an answer with details later. — saulotoledo
– saulotoledo, Commented Jul 21, 2019 at 14:06
So you are trying to declare the type of defineModule without defining the function (because it will only be inlined by the transpiler, there is no actual callable function anywhere)? — Bergi
– Bergi, Commented Jul 21, 2019 at 14:19
@saulotoledo, I'm working on a transpiler, which means that Im working on a project (completely besides the point if it is JavaScript or TypeScript) that will alter the contents of JavaScript files. It would be ideal to have the declarations in a global .d.ts file somwhere that I can reference from all my projects without the need of a require statement. — nick zoum
– nick zoum, Commented Jul 21, 2019 at 14:20

mootrichard · Accepted Answer · 2019-07-31 18:38:16Z

7

+100

You can specify your own TypeScript folder path in your settings.json where you can specify your own lib.*.d.ts files using the typescript.tsdk option.

{
  "typescript.tsdk": "node_modules/typescript/lib"
}

edited Jul 31, 2019 at 18:38

answered Jul 23, 2019 at 22:01

mootrichard

3,60116 silver badges26 bronze badges

Sign up to request clarification or add additional context in comments.

9 Comments

nick zoum Over a year ago

While I followed your instructions and put my .d.ts with the other .d.ts files of typescript, VSCode still says the type of defineModule is any. Also, VSCode was trying to get the node_modules/typescript/lib using a path relative to the current workspace instead of the Roaming/npm/node_modules. I have temporarily fixed the problem using an absolute path, though I would greatly appreciate it, if you could also point me in the right direction towards fixing this issue.

nick zoum Over a year ago

Are there any further actions I have to do?

mootrichard Over a year ago

I think if you had typescript installed globally you'd be able to circumvent this by having it point to the globally defined TypeScript installation. Obviously that'd create problems if your projects are pointing to different versions of TypeScript though.

nick zoum Over a year ago

Still a bit unclear, if I should create a new file (do I have to declare it?) under the lib directory or if I should use one of the existing files (which one?). Should I use export or declare? Could you please show an example exporting the defineModule function?

mootrichard Over a year ago

Oh, I figured you already knew how to create your own *.d.ts files and would just add it in there. There are a few examples that show how you can declare and export there elsewhere though stackoverflow.com/questions/21247278/about-d-ts-in-typescript

|

nick zoum · Accepted Answer · 2019-08-13 10:20:27Z

1

Acknowledgment

This answer was mostly inspired by mootrichard's answer, but since it had to be modified, to work with my project, I am also adding this answer.

Solution

If you press F12 on a global JavaScript function (i.e. eval) a typing declarations file will appear (lib.es5.d.ts), containing JavaScript documentation. You can just add any extra namespaces or function to that file. But you need to use declare and not export.

Example:

//... Other Global JavaScript Declarations

// JavaScript Number Interface
interface Number {
  //...
}

// JavaScript Date Interface
interface Date {
  //...
}

declare function ezDefine(moduleName: string, generator: *): void;

answered Aug 13, 2019 at 10:20

nick zoum

6,6538 gold badges43 silver badges93 bronze badges

2 Comments

Z. Zlatev Over a year ago

Am I the only one feeling uncomfortable editing files which belong to the typescript package that essentially is a vscode dependency?

platonic Over a year ago

I found this helpful. I used node_modules/@types/node/globals.d.ts and patch-package @types/node

Collectives™ on Stack Overflow

Set global declaration in vscode JavaScript

2 Answers 2

9 Comments

Acknowledgment

Solution

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

9 Comments

Acknowledgment

Solution

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related