What's the relationship of @material-ui/core and @types/material-ui?

Question

Here I see an example project using material-ui.

I see I have the following packages inside of package.json file

{
  ...
  "dependencies": {
    "@material-ui/core": "^1.4.1",
    ...
  },
  "devDependencies": {
    "@types/material-ui": "^0.20.6",
    ...
  },
  ...
}

After the npm install, I see the following directories in my project folder

node_modules/@types/material-ui/
node_modules/@material-ui/core/

Here are my questions:

I wanted to understand why material-ui uses @ as part of its package name, is it true that this kind of package naming means it's a TS package? i.e., it itself carries the type information.
If the above is true, is it true that /@types/material-ui/ is not needed at all?

user_5030758 · Answer

@ in the package name doesn't mean it is a TypeScript package; plain JavaScript packages can also have the @ prefix.

The @ prefix means this is a scoped package; i.e. there is a family of packages under @material-ui/ as well as under @types/.

In this specific case, @material-ui/core contains its own type definitions (*.d.ts files), so @types/material-ui is not needed and will not actually be used. In general @types/ packages are needed for plain JavaScript packages which do not contain any type definitions on their own.

user_2513722 · Answer

@types modules are used by TypeScript to provide you with rich type definitions of methods and members. If you're using TypeScript, keep them, otherwise there's no need.

Read more here: https://basarat.gitbooks.io/typescript/docs/types/@types.html

user_743464 · Answer

Packages starting with @ are a convention for "scoping" them. It's awesome: https://docs.npmjs.com/misc/scope

The @types scope is TypeScript type definitions provided by the huge DefinitelyTyped project

What's the relationship of @material-ui/core and @types/material-ui?

3 Answers