Build tasks: Fix various JSDoc types #3380
Merged
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
colinrotherham
commented
Mar 13, 2023
| @@ -14,7 +14,7 @@ export async function writeAsset (filePath, result) { | |||
| const writeTasks = [] | |||
|
|
|||
| // Files to write | |||
| const code = result.code || result.css?.toString() | |||
| const code = 'css' in result ? result.css : result.code | |||
There was a problem hiding this comment.
Since Dart Sass landed in #3164 so result.css no longer needs toString()
colinrotherham
commented
Mar 13, 2023
| @@ -49,5 +49,5 @@ export async function writeAsset (filePath, result) { | |||
| * 2. Terser minified bundle | |||
| * 3. Sass compiler result | |||
| * | |||
| * @typedef {import('rollup').OutputChunk | import('terser').MinifyOutput | import('node-sass').Result} AssetOutput | |||
| * @typedef {import('rollup').OutputChunk | import('terser').MinifyOutput | import('postcss').Result} AssetOutput | |||
There was a problem hiding this comment.
Missed reference to node-sass which should be the PostCSS transform result
colinrotherham
force-pushed
the
build-task-types
branch
from
4d754e2
to
4ec4388
Compare
colinrotherham
changed the title
colinrotherham
commented
Mar 13, 2023
| @@ -111,7 +111,8 @@ | |||
| "stylelint-config-gds": "^0.2.0", | |||
| "stylelint-order": "^6.0.2", | |||
| "typed-query-selector": "^2.9.1", | |||
| "typescript": "^4.9.5" | |||
| "typescript": "^4.9.5", | |||
| "vinyl": "^3.0.0" | |||
There was a problem hiding this comment.
We removed this one but forgot we still type component data with it:
/**
* @param {import('vinyl')} file
* @returns {Promise<import('vinyl')>}
*/
colinrotherham
force-pushed
the
build-task-types
branch
from
4ec4388
to
5f9d5e3
Compare
colinrotherham
force-pushed
the
build-task-types
branch
from
5f9d5e3
to
2d8b490
Compare
colinrotherham
force-pushed
the
build-task-types
branch
from
2d8b490
to
b560fd8
Compare
colinrotherham
force-pushed
the
build-paths
branch
from
1039b99
to
d4db145
Compare
| @@ -170,7 +170,7 @@ async function generateMacroOptions (file) { | |||
| * Parse YAML file content as JavaScript | |||
| * | |||
| * @param {import('vinyl')} file - Component data ${componentName}.yaml | |||
| * @returns {Promise<{ examples?: unknown[]; params?: unknown[] }>} Component options | |||
| * @returns {Promise<{ examples?: Record<string, unknown>[]; params?: Record<string, unknown>[] }>} Component options | |||
There was a problem hiding this comment.
question Likely non blocking, but what does the Record type represent?
There was a problem hiding this comment.
It's a utility type for objects that are always keyed with the same name/value pair
There was a problem hiding this comment.
Oh didn't think to look in the built-in types, cheers 😄
colinrotherham
force-pushed
the
build-paths
branch
from
d4db145
to
f14899f
Compare
Incorrectly presumed to be unused in ad61d19
romaricpascal
approved these changes
Mar 17, 2023
colinrotherham
force-pushed
the
build-task-types
branch
from
b560fd8
to
a0109c1
Compare
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.
This PR fixes various JSDoc types that have drifted due to:
node-sassnow removed)tsconfig.json