feat(typescript): use Typescript index + many changes #407

bodinsamuel · 2019-08-12T20:09:06Z

Closes #401
Contributes #372

📦 What's inside ?

Use official list of @types, preloaded like jsDelivr
We should probably just restart the script on heroku once a day, until we code something to handle the cache automatically.
Check dependencies and devDependencies to see if package use typescript
It's a super light check and I'm almost sure all packages that are using typescript must have them listed as deps.
Example: in the snapshot we solved atomic-package.tab.d.ts that was listed as possible
Remove support for "possible: true", it's likely to be triggered by 99% of package whereas the check of dependencies should already cover 99% of package using Typescript (Super arbitrary assumption I may be wrong).
That also mean we no longer use unpkg for the moment, that will help going faster.

Haroenv · 2019-08-13T06:55:19Z

.d.ts can en added to projects that don’t use typescript themselves. I think “got” is an example for a package like that

bodinsamuel · 2019-08-13T07:48:05Z

.d.ts can en added to projects that don’t use typescript themselves. I think “got” is an example for a package like that

Got is made in typescript (at least now), I will try to find npm package with this pattern, but I'm not sure it's worth slowing down the script that much for the real potential it brings.

Haroenv · 2019-08-13T09:07:53Z

The most popular packages have a .d.ts and aren't written in TS:

https://github.com/mozilla/source-map
https://github.com/tj/commander.js/ (but it does have typescript as a devdep)
https://github.com/chalk/chalk
https://github.com/moment/moment
https://github.com/stefanpenner/es6-promise
https://github.com/wycats/handlebars.js (has ts as a devdep)
https://github.com/FezVrasta/popper.js

That was just the first few results, so we can't skip those IMO :)

src/__tests__/formatPkg.test.js

bodinsamuel · 2019-08-13T12:27:11Z

✅https://github.com/mozilla/source-map (typings props)
✅https://github.com/tj/commander.js/ (deps)
⚠️https://github.com/chalk/chalk (have @types/chalk and could be solve by also checking prop files)
✅https://github.com/moment/moment (deps)
✅https://github.com/stefanpenner/es6-promise (typings prop + files)
✅https://github.com/wycats/handlebars.js (types prop )
✅https://github.com/FezVrasta/popper.js (types prop)

I'm not saying your point is bad, but like I said this cover almost every package. I will add a check on the files prop.

src/formatPkg.js

bodinsamuel · 2019-08-19T13:11:49Z

@Haroenv I have removed the check for dependencies as it was not as certain as I thought.
With everything I put before, I now check jsDelivr:

typescript:
- if any file match d.ts, it's marked as include
- if no match, nothing more is done
changelogs:
- if any file match, we no longer do a HEAD call,
- if no match, rollback to the HEAD call if no match (some packages do not bundle CHANGELOG.md 😠)

I would recommend checking only b4b98ef (without whitespace diff)

Haroenv

I think we're almost ready here

Haroenv · 2019-08-19T13:39:41Z

src/changelog.js

+    pkgs.map((pkg, index) => {
+      const fromFS = checkChangelogFromFilesList(pkg, filesLists[index]);
+      if (fromFS) {
+        return fromFS;


hope this will have a nice impact! probably not too much since GitHub is fast, but less request is better

It has less impact than I initially anticipated because some packages does not bundle the changelog (most of them do though, because npm auto add this file), and we always rollback to slower method if not found.

src/typescript/__tests__/index.test.js

src/formatPkg.js

Haroenv · 2019-08-19T13:54:55Z

src/typescript/index.js

+  // t = @types/<name>
+  body.forEach(type => {
+    type.m.forEach(m => {
+      typesCache[m] = type.t;


how does this deal with @reach/router -> @types/reach__router?

~~It will work (if you look here it's already correctly name)~~
Your example made me found out that not all packages has a property m in the json

For example mapbox__polyline does not contain the correct package name, reach__router seems to have the same issue. I was expecting to have the correct package name in m but it seems not consistant.
(maybe @sandersn has an idea)
If no solution I will unescape the name probably to transform the __ into a /

I'm pretty sure that the module name is supposed to be the DT-mangled name, eg mapbox__polyline instead of @mapbox/polyline. Do you see unmangled package names too?

For example: @mapbox/geojson-area or arangodb appear as-is in the m property.
I'm really not sure what should or should not be mangled

src/watch.js

src/formatPkg.js

bodinsamuel · 2019-08-22T08:40:37Z

I added an unmangle function to fix this #407 (comment)

Haroenv · 2019-08-22T08:42:08Z

src/typescript/index.js

+}
+
+function unmangle(name) {
+  return name.replace('__', '/').replace('@', '');


can we add a test for this? Shouldn't we add an @ instead of removing it?

I can not add an @ because the index created by typescript also contain "fake module" like lodash/add (I'm not 100% sure I need to add those in the list)

Ah that's confusing

bodinsamuel · 2019-09-06T09:55:04Z

@Haroenv Do you feel okay merging this? and #413 ?

sindresorhus · 2020-02-10T20:30:14Z

I didn't check whether it's handled, but don't forget to handle the case where a package has a index.d.ts file in root, but not a types field in package.json. That's a common occurrence and it's allowed by TypeScript to omit the types field if the definition file uses the name index.d.ts.

Context: sindresorhus/type-fest#67 (comment)

Haroenv · 2020-02-11T09:15:02Z

good call @sindresorhus, I think that's not checked for now, if the main field isn't given. With this refactor that would indeed not be fixed

jimaek · 2021-05-27T12:39:11Z

Hey I was wondering on the status of this. Maybe it's good to get merged? It has some interesting features

bodinsamuel · 2021-05-27T12:55:54Z

@jimaek hey, thanks for pinging.
I have been too ambitious with this PR, I need to take some time to split the changes in a more reviewable/safe way.
It's been 2 years, a bit shameful for me 🙇🏻

I'll try to allocate some times to this in the coming weeks

bodinsamuel · 2021-07-06T20:26:04Z

Everything has been ported 🙇🏻

feat(typescript): use Typescript index + many changes

3b37ab3

bodinsamuel requested a review from Haroenv August 12, 2019 20:09

bodinsamuel self-assigned this Aug 12, 2019

Haroenv reviewed Aug 13, 2019

View reviewed changes

src/__tests__/formatPkg.test.js Outdated Show resolved Hide resolved

Haroenv reviewed Aug 13, 2019

View reviewed changes

src/formatPkg.js Outdated Show resolved Hide resolved

bodinsamuel and others added 2 commits August 19, 2019 14:54

check CHANGELOG and Typescript with jsDelivr

b4b98ef

Merge branch 'master' into feat/use-typescript-to-check

01953ce

Haroenv reviewed Aug 19, 2019

View reviewed changes

push non working code to not forget

56478ca

Haroenv reviewed Aug 19, 2019

View reviewed changes

src/formatPkg.js Show resolved Hide resolved

bodinsamuel and others added 2 commits August 19, 2019 20:29

fix files can be string + reached complexity

13fd22d

unmangle library name

df6a377

Haroenv reviewed Aug 22, 2019

View reviewed changes

bodinsamuel and others added 4 commits August 25, 2019 16:19

this part is useless

2bd42fc

Merge branch 'master' into feat/use-typescript-to-check

1155b1d

Merge branch 'master' into feat/use-typescript-to-check

6c0c9e9

do not handle sub/package

3537e0d

orta mentioned this pull request Feb 7, 2020

Add links to try them in the TypeScript Playground sindresorhus/type-fest#67

Open

sindresorhus mentioned this pull request Feb 11, 2020

Detect packages with TypeScript but without a types field in package.json #511

Closed

This was referenced Jul 2, 2021

feat(typescript): pre-load definitely typed pkg #639

Merged

feat(ts): use jsdelivr to check for d.ts #645

Merged

bodinsamuel closed this Jul 6, 2021

bodinsamuel deleted the feat/use-typescript-to-check branch July 19, 2021 17:52

feat(typescript): use Typescript index + many changes #407

feat(typescript): use Typescript index + many changes #407

Uh oh!

Conversation

bodinsamuel commented Aug 12, 2019

📦 What's inside ?

Uh oh!

Haroenv commented Aug 13, 2019

Uh oh!

bodinsamuel commented Aug 13, 2019

Uh oh!

Haroenv commented Aug 13, 2019

Uh oh!

Uh oh!

bodinsamuel commented Aug 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

bodinsamuel commented Aug 19, 2019

Uh oh!

Haroenv left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bodinsamuel Aug 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bodinsamuel commented Aug 22, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bodinsamuel commented Sep 6, 2019

Uh oh!

sindresorhus commented Feb 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Haroenv commented Feb 11, 2020

Uh oh!

jimaek commented May 27, 2021

Uh oh!

bodinsamuel commented May 27, 2021

Uh oh!

bodinsamuel commented Jul 6, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

bodinsamuel commented Aug 13, 2019 •

edited

Loading

bodinsamuel Aug 19, 2019 •

edited

Loading

sindresorhus commented Feb 10, 2020 •

edited

Loading