fix(sys): fix expected types for createNodeLogger and createNodeSys
#5375
Conversation
|
| Path | Error Count |
|---|---|
| src/dev-server/index.ts | 37 |
| src/dev-server/server-process.ts | 32 |
| src/compiler/prerender/prerender-main.ts | 22 |
| src/testing/puppeteer/puppeteer-element.ts | 22 |
| src/runtime/client-hydrate.ts | 20 |
| src/screenshot/connector-base.ts | 19 |
| src/runtime/vdom/vdom-render.ts | 17 |
| src/dev-server/request-handler.ts | 15 |
| src/compiler/prerender/prerender-optimize.ts | 14 |
| src/compiler/sys/stencil-sys.ts | 14 |
| src/compiler/transpile/transpile-module.ts | 14 |
| src/sys/node/node-sys.ts | 14 |
| src/compiler/prerender/prerender-queue.ts | 13 |
| src/compiler/sys/in-memory-fs.ts | 13 |
| src/runtime/connected-callback.ts | 13 |
| src/runtime/set-value.ts | 13 |
| src/compiler/output-targets/output-www.ts | 12 |
| src/compiler/transformers/test/parse-vdom.spec.ts | 12 |
| src/compiler/transformers/transform-utils.ts | 12 |
| src/mock-doc/test/attribute.spec.ts | 12 |
Our most common errors
| Typescript Error Code | Count |
|---|---|
| TS2322 | 361 |
| TS2345 | 349 |
| TS18048 | 206 |
| TS18047 | 82 |
| TS2722 | 37 |
| TS2532 | 24 |
| TS2531 | 21 |
| TS2454 | 14 |
| TS2790 | 11 |
| TS2352 | 10 |
| TS2769 | 8 |
| TS2538 | 8 |
| TS2416 | 6 |
| TS2493 | 3 |
| TS18046 | 2 |
| TS2684 | 1 |
| TS2430 | 1 |
Unused exports report
There are 14 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!
Unused exports
| File | Line | Identifier |
|---|---|---|
| src/runtime/bootstrap-lazy.ts | 21 | setNonce |
| src/screenshot/screenshot-fs.ts | 18 | readScreenshotData |
| src/testing/testing-utils.ts | 198 | withSilentWarn |
| src/utils/index.ts | 145 | CUSTOM |
| src/utils/index.ts | 269 | normalize |
| src/utils/index.ts | 7 | escapeRegExpSpecialCharacters |
| src/compiler/app-core/app-data.ts | 25 | BUILD |
| src/compiler/app-core/app-data.ts | 115 | Env |
| src/compiler/app-core/app-data.ts | 117 | NAMESPACE |
| src/compiler/fs-watch/fs-watch-rebuild.ts | 123 | updateCacheFromRebuild |
| src/compiler/types/validate-primary-package-output-target.ts | 61 | satisfies |
| src/compiler/types/validate-primary-package-output-target.ts | 61 | Record |
| src/testing/puppeteer/puppeteer-declarations.ts | 485 | WaitForEventOptions |
| src/compiler/sys/fetch/write-fetch-success.ts | 7 | writeFetchSuccessSync |
PR built and packed!Download the tarball here: https://github.com/ionic-team/stencil/actions/runs/8235460475/artifacts/1315440517 If your browser saves files to |
| * @returns a {@link Logger} object | ||
| */ | ||
| export declare function createNodeLogger(c: { process: any }): Logger; | ||
| export declare function createNodeLogger(): Logger; |
There was a problem hiding this comment.
It looks like we removed this in c114f0a - I don't see any comments to this effect, but I think we held off here due to breaking a public API (createNodeLogger is a available from @stencil/core/sys/node). @alicewriteswrongs do you remember by chance?
There was a problem hiding this comment.
yeah I think that might be why we left it like that, I don't remember exactly tbh
There was a problem hiding this comment.
👍 In that case, can we add a TODO comment here instead of removing c? We can slate this change for Stencil v5
There was a problem hiding this comment.
I created two versions and deprecated one which will result in the following:
| * @returns a {@link Logger} object | ||
| */ | ||
| export declare function createNodeLogger(c: { process: any }): Logger; | ||
| export declare function createNodeLogger(): Logger; |
There was a problem hiding this comment.
👍 In that case, can we add a TODO comment here instead of removing c? We can slate this change for Stencil v5
christian-bromann
force-pushed
the
cb/type-fixes
branch
from
aa8c4fa to
1098d9d
Compare
Co-authored-by: Ryan Waskiewicz <ryanwaskiewicz@gmail.com>
christian-bromann
force-pushed
the
cb/type-fixes
branch
from
78a8067 to
0302a90
Compare
Co-authored-by: Ryan Waskiewicz <ryanwaskiewicz@gmail.com>
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
|
This has been released with Stencil 🚞 v4.13.0 |
What is the current behavior?
The methods
createNodeLoggerandcreateNodeSyscurrently have a wrong parameter definition.What is the new behavior?
Update types to match with implementation:
createNodeLogger: see https://github.com/ionic-team/stencil/blob/9062e1a967461dd962881b925b0c55aebddd8975/src/sys/node/logger/index.ts#L12-L16createNodeSys, see https://github.com/ionic-team/stencil/blob/4959295c24ec3effcc8d63a8305dffd6e07a617d/src/sys/node/node-sys.ts#L37and adds types for export methods:
setupNodeProcess: exported in https://github.com/ionic-team/stencil/blob/9062e1a967461dd962881b925b0c55aebddd8975/src/sys/node/index.ts#L2Documentation
Does this introduce a breaking change?
Yes and no: yes we change public API interfaces but also no since these have been wrong in the first place.
Testing
n/a
Other information
n/a