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

How about use addon-info.json to store metadata? #8

Open
Freed-Wu opened this issue Feb 27, 2023 · 1 comment
Open

How about use addon-info.json to store metadata? #8

Freed-Wu opened this issue Feb 27, 2023 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@Freed-Wu
Copy link

Freed-Wu commented Feb 27, 2023

google's vimdoc is a tool to generate doc/help.txt for vim plugin. It use addon-info.json to store metadata. This is an example:

{
  "name": "maktaba",
  "description": "Consistent Vimscript",
  "version": "1.16.0",
  "author": "Google",
  "repository": {"type": "git", "url": "git://github.com/google/maktaba"}
}

How about this plugin use same file to store metadata? It should be convenient for user to don't edit two json files.

Thanks!

For compatibility, vishop can detect vishop.json firstly, if vishop.json doesn't exist, detect or create addon-info.json:

{
  "name": "maktaba",
  "description": "Consistent Vimscript",
  "type": "utility"
  "required": "7.0",
  "version": "1.16.0",
  "author": "Google",
  "repository": {"type": "git", "url": "git://github.com/google/maktaba"}
}

And if name doesn't exists, vimdoc will use the current directory of addon-info.json as name. How about vishop do the same work?

@Xvezda Xvezda added enhancement New feature or request good first issue Good for newcomers labels Mar 1, 2023
@Xvezda
Copy link
Owner

Xvezda commented Mar 1, 2023

@Freed-Wu
Hi, thank you for your interest.
I actually didn't know about addon-info.json and it would be make much sense to use addon-info.jsonas fallback or default metadata file.
Thank you for your suggestion!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants