You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Lots (if not most) of @std files are single export files wich only export one function or class.
The file name is normally the same as the exported thing (case may be adjusted, prefixed files with unstable are special treated).
Files that differ from that pattern are mostly multi export files (for example fmt/colors.ts).
There are multiple files in @std/front-matter that do not conform to any of these conventions:
front-matter/any.ts exports extract()
front-matter/json.ts exports extract()
front-matter/toml.ts exports extract()
front-matter/yaml.ts exports extract()
front-matter/unstable_yaml.ts exports extract()
In front-matter/mod.ts the extract() functions even have aliases because their names overlap.
Describe the solution you'd like
I think we should enforce any apply that convention to front-matter:
rename front-matter/any.ts to front-matter/extract.ts
rename front-matter/json.ts to front-matter/extract_json.ts, rename exported function from extract() to extractJson()
rename front-matter/toml.ts to front-matter/extract_toml.ts, rename exported function from extract() to extractToml()
rename front-matter/json.ts to front-matter/extract_yaml.ts, rename exported function from extract() to extractYaml()
I am aware that front-matter is stable, but this issue may be part of 2.0 which I imagine would allow for breaking changes.
(@kt3k Is there a roadmap for 2.0 mods?)
In the meantime, We could add aliases for a smooth transition.
Describe alternatives you've considered
Don't enforce convention.
The text was updated successfully, but these errors were encountered:
This needs consensus in both core team and community.
I'm personally not in favor of this change. I've never heard of the user feedbacks of getting confused by this structure. On the other hand, there are many usages in github search https://github.com/search?q=std%2Ffront-matter&type=code . Many of them import extract from ./any or ./yaml. I think the current structure is already reasonably accepted by the community. So I don't see much value to this change, rather I only see the negative effect of disrupting the existing usages.
Is your feature request related to a problem? Please describe.
Lots (if not most) of
@std
files are single export files wich only export one function or class.The file name is normally the same as the exported thing (case may be adjusted, prefixed files with
unstable
are special treated).Files that differ from that pattern are mostly multi export files (for example
fmt/colors.ts
).There are multiple files in
@std/front-matter
that do not conform to any of these conventions:front-matter/any.ts
exportsextract()
front-matter/json.ts
exportsextract()
front-matter/toml.ts
exportsextract()
front-matter/yaml.ts
exportsextract()
front-matter/unstable_yaml.ts
exportsextract()
In
front-matter/mod.ts
theextract()
functions even have aliases because their names overlap.Describe the solution you'd like
I think we should enforce any apply that convention to
front-matter
:front-matter/any.ts
tofront-matter/extract.ts
front-matter/json.ts
tofront-matter/extract_json.ts
, rename exported function fromextract()
toextractJson()
front-matter/toml.ts
tofront-matter/extract_toml.ts
, rename exported function fromextract()
toextractToml()
front-matter/json.ts
tofront-matter/extract_yaml.ts
, rename exported function fromextract()
toextractYaml()
I am aware that
front-matter
is stable, but this issue may be part of2.0
which I imagine would allow for breaking changes.(@kt3k Is there a roadmap for 2.0 mods?)
In the meantime, We could add aliases for a smooth transition.
Describe alternatives you've considered
Don't enforce convention.
The text was updated successfully, but these errors were encountered: