fix(front-matter): improve extract types
#5325
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5325 +/- ##
=======================================
Coverage 95.80% 95.80%
=======================================
Files 458 458
Lines 37852 37864 +12
Branches 5562 5562
=======================================
+ Hits 36264 36276 +12
Misses 1548 1548
Partials 40 40 ☔ View full report in Codecov by Sentry. |
iuioiua
suggested changes
Jul 5, 2024
| @@ -3,9 +3,15 @@ | |||
| import { createExtractor, type Parser } from "./_create_extractor.ts"; | |||
| import { parse as parseYaml } from "@std/yaml/parse"; | |||
| import { parse as parseToml } from "@std/toml/parse"; | |||
| import type { Extractor } from "./types.ts"; | |||
| import type { Extract, Extractor } from "./types.ts"; | |||
There was a problem hiding this comment.
There no longer seems a reason to export Extractor.
Suggested change
| import type { Extract, Extractor } from "./types.ts"; | |
| import type { Extract } from "./types.ts"; |
|
|
||
| export type { Extractor }; | ||
| export type { Extract, Extractor }; |
There was a problem hiding this comment.
Suggested change
| export type { Extract, Extractor }; | |
| export type { Extract }; |
Comment on lines
+10
to
+14
| const _extractor = createExtractor({ | ||
| yaml: parseYaml as Parser, | ||
| toml: parseToml as Parser, | ||
| json: JSON.parse as Parser, | ||
| }); |
There was a problem hiding this comment.
Suggested change
| const _extractor = createExtractor({ | |
| yaml: parseYaml as Parser, | |
| toml: parseToml as Parser, | |
| json: JSON.parse as Parser, | |
| }); |
I'll do that in a later PR with BREAKING tag. |
iuioiua
approved these changes
Jul 5, 2024
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.
Currently in
std/front-matterpackageextractfunctions are typed asExtractorvariable, and therefore it doesn't show type information of@params,@returns, etc.This PR changes them to functions and improves the docs.
BEFORE
AFTER
This PR also exports
Extracttype (which is return type ofextract) from each language file. This resolves #5323