Fix: Publish types (+ validate and use types + generate type maps) #21
Conversation
package.json
Outdated
| }, | ||
| "files": [ | ||
| "index.js", | ||
| "index.d.ts", | ||
| "index.d.ts.map", |
There was a problem hiding this comment.
I don't think it should publish a Source Map
There was a problem hiding this comment.
Why not? It's just a way to ensure that "go to source" in eg. VSCode actually still goes to the source and not to the type file?
And its only this big:
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"AA+BA,0CAHW;IAAE,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,GAC7B,OAAO,CAgFnB"}There was a problem hiding this comment.
Related: microsoft/TypeScript#14479
And https://www.typescriptlang.org/docs/handbook/project-references.html#declarationmaps
But sure, I can remove it
Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
Co-authored-by: LitoMore <LitoMore@users.noreply.github.com>
voxpelli
requested review from
LitoMore and
sindresorhus
and removed request for
sindresorhus and
LitoMore
|
Anything I can do to help push this further? |
package.json
Outdated
| "test": "xo && nyc ava", | ||
| "create-types": "tsc index.js --allowJs --declaration --emitDeclarationOnly" | ||
| "test": "xo && nyc ava && tsc", | ||
| "create-types": "tsc -p declaration.tsconfig.json" |
There was a problem hiding this comment.
Use the long-flag rather than -p.
index.js
Outdated
| function parseVersion(versionString) { | ||
| if (/^\d{3,4}$/.test(versionString)) { | ||
| // Env var doesn't always use dots. example: 4601 => 46.1.0 | ||
| const m = /(\d{1,2})(\d{2})/.exec(versionString); | ||
| const m = /(\d{1,2})(\d{2})/.exec(versionString) ?? []; |
There was a problem hiding this comment.
You need to either upgrade XO or not use ??. I suggest not using ?? as that's a less invasive change.
There was a problem hiding this comment.
Fixed @sindresorhus
|
Not sure why master branch is failing when this PR passed. https://github.com/jamestalmage/supports-hyperlinks/actions/runs/4363207180 |
I noticed that this package was generating types but then told
npmto only publishbrowser.jsandindex.jsand not the actually generated types.This fixes that + generates declarations maps + validates the types with TS
strict=true.It also adds a
tsconfig.jsonto tell eg. VSCode that hey, this repository wants you to make use of TS types inindex.js.Tell me if you want me to pull something of this PR and I'll make it more granular 👍
Note: I bumped the lowest supported Node-version to a reasonable current LTS-focused version range so that the
tsconfig.jsonfile could be pointed towards a reasonable fitting definition with correctlibdefinition:es2020Fixes #15
Closes #20