Edit Site: Add tsconfig.json validation for package #67406
+123
−31
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
ramonjd
added
[Type] Code Quality
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +34 B (0%) Total Size: 1.84 MB
ℹ️ View Unchanged
|
ramonjd
force-pushed
the
add/edit-site-ts-config-validation
branch
from
0f716eb to
0fc5fec
Compare
|
Flaky tests detected in a8c931c. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12510957091
|
ramonjd
commented
Nov 29, 2024
| @@ -84,8 +88,9 @@ export function getTopLevelStyleBookCategories(): StyleBookCategory[] { | |||
| ...STYLE_BOOK_THEME_SUBCATEGORIES, | |||
| ...STYLE_BOOK_CATEGORIES, | |||
| ].map( ( { slug } ) => slug ); | |||
| const extraCategories = getCategories().filter( | |||
| const extraCategories: StyleBookCategory[] = getCategories(); | |||
| const extraCategoriesFiltered = extraCategories.filter( | |||
There was a problem hiding this comment.
All this is for the TS parser
If there are any major type tweaks required, I'd rather do them in a follow up.
This is just to get typing working for this package.
packages/edit-site/src/components/style-book/color-examples.tsx
Outdated
Show resolved
Hide resolved
| // NOTE: This package is being progressively typed. You are encouraged to | ||
| // expand this array with files which can be type-checked. At some point in | ||
| // the future, this can be simplified to an `includes` of `src/**/*`. | ||
| "files": [ |
There was a problem hiding this comment.
Can't use globs apparently, except in "include"
There was a problem hiding this comment.
I'm not so familiar with the details of the TS configs so I can't speak about that but this PR seems to be fixing the erros I previously got in VScode while editing the stylebook files.
ciampo
reviewed
Dec 4, 2024
ramonjd
force-pushed
the
add/edit-site-ts-config-validation
branch
from
90e7a49 to
954d58e
Compare
…ject and so tsc will try to build them.
…d fixing type assignment
ramonjd
force-pushed
the
add/edit-site-ts-config-validation
branch
from
9cbb560 to
1b8c418
Compare
sirreal
reviewed
Dec 27, 2024
| @@ -27,6 +27,7 @@ | |||
| "module": "build-module/index.js", | |||
| "react-native": "src/index", | |||
| "wpScript": true, | |||
| "types": "build-types", | |||
There was a problem hiding this comment.
This line would expose the types to the world (public consumers via npm). It doesn't seem like this package is ready to be typed, but this PR is trying to fix internal build issues for Gutenberg.
I'd remove this line:
Suggested change
| "types": "build-types", |
packages/edit-site/src/components/style-book/color-examples.tsx
Outdated
Show resolved
Hide resolved
Comment on lines
+4
to
+7
| "compilerOptions": { | ||
| "rootDir": "src", | ||
| "declarationDir": "build-types" | ||
| }, |
There was a problem hiding this comment.
This becomes redundant after ca61601 (rebase required):
Suggested change
| "compilerOptions": { | |
| "rootDir": "src", | |
| "declarationDir": "build-types" | |
| }, |
| "src/components/style-book/color-examples.tsx", | ||
| "src/components/style-book/duotone-examples.tsx", | ||
| "src/components/style-book/examples.tsx" | ||
| ] |
There was a problem hiding this comment.
After ca61601, it becomes necessary to override the default include:
Suggested change
| ] | |
| ], | |
| "include": [] |
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.
What?
This PR:
TS9005 An explicit type annotation may unblock declaration emitWhy?
Style book added TS files, but no linting or config: #65430 (comment)
How?
Testing Instructions
Tests should pass and the CI should build.
Fire up the branch and smoke test the site editor, in particular the style book