Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

metadata vfile location #7

Open
Lynncubus opened this issue Feb 27, 2018 · 1 comment
Open

metadata vfile location #7

Lynncubus opened this issue Feb 27, 2018 · 1 comment

Comments

@Lynncubus
Copy link

Hey there, just a quick little question.

As the vfile documentation suggests there is a standard location for storing custom data in a vfile under .data (https://github.com/vfile/vfile#vfiledata). Was .metadata chosen on purpose in awoo-matter and awoo-metadata? It'd make sense to store such data in its standard location.

@zipang
Copy link

zipang commented Jul 4, 2018

Hi everyone !
I'll give my 👍 to this request, because vfile has so clearly documented this location, and it makes more sense to store front-matter parsed fields inside data because my front matter is clearly data belonging to the file and not external data..
I would really reserve the namespace metadata to store external relations like : next and previous (for a collection plugin similar to metalsmith-collection that i intend to provide sometime soon).
I would argue that promoting and documenting the separate use of these namespaces for clearly different purposes will help establish good practices for plugin authors and should mitigate the key collision issue (something that metalsmith failed at).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants