fix!: include type definitions when publishing #21
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
achou11
force-pushed
the
ac/type-fixes
branch
from
ae2682c
to
417d553
Compare
achou11
force-pushed
the
ac/type-fixes
branch
from
417d553
to
bcab832
Compare
achou11
commented
Sep 27, 2024
lib/utils/streams.js
Outdated
There was a problem hiding this comment.
Changes here related to TransformOptions are not ideal but they were causing an error when emitting declarations via npm run build:types.
Error was:
lib/utils/streams.js:1:1 - error TS9006: Declaration emit for this file requires using private name '_IReadable' from module '"/Users/andrewchou/GitHub/digidem/styled-map-package/node_modules/@types/readable-stream/index"'. An explicit type annotation may unblock declaration emit.
1 import { Readable, Writable, Transform } from 'readable-stream'| @@ -80,6 +89,7 @@ | |||
| "png-stream": "^1.0.5", | |||
| "prettier": "^3.3.3", | |||
| "random-bytes-readable-stream": "^3.0.0", | |||
| "rimraf": "^4.4.1", | |||
There was a problem hiding this comment.
Pinned to v4 since >= v5 removes support for node 18
Comment on lines
+19
to
+24
| "files": [ | ||
| "bin", | ||
| "dist", | ||
| "lib", | ||
| "map-viewer" | ||
| ], |
There was a problem hiding this comment.
not sure about including map-viewer. anything else to include here otherwise?
achou11
changed the title
achou11
commented
Sep 27, 2024
Comment on lines
+6
to
+33
| ".": { | ||
| "types": "./dist/index.d.ts", | ||
| "import": "./lib/index.js" | ||
| }, | ||
| "./reader.js": { | ||
| "types": "./dist/reader.d.ts", | ||
| "import": "./lib/reader.js" | ||
| }, | ||
| "./writer.js": { | ||
| "types": "./dist/writer.d.ts", | ||
| "import": "./lib/writer.js" | ||
| }, | ||
| "./server.js": { | ||
| "types": "./dist/server.d.ts", | ||
| "import": "./lib/server.js" | ||
| }, | ||
| "./style-downloader.js": { | ||
| "types": "./dist/style-downloader.d.ts", | ||
| "import": "./lib/style-downloader.js" | ||
| }, | ||
| "./tile-downloader.js": { | ||
| "types": "./dist/tile-downloader.d.ts", | ||
| "import": "./lib/tile-downloader.js" | ||
| }, | ||
| "./download.js": { | ||
| "types": "./dist/download.d.ts", | ||
| "import": "./lib/download.js" | ||
| } |
There was a problem hiding this comment.
changes here informed by publint, which is generally a super helpful tool that i've become reliant on
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mainly:
.jssuffix at the end, which I believe is generally recommended/idiomatic. Not strictly necessary for us to do so open to reverting that change if preferredShould introduce
noUncheckedIndexedAccessin the tsconfig as a follow-up but it will lead to errors that will require code changes outside the scope of this PR.