Skip to content

README.md

Latest commit

 

History

History
14 lines (10 loc) · 1.26 KB

README.md

File metadata and controls

14 lines (10 loc) · 1.26 KB

Work with guida.json and docs.json

This package is meant for people creating Guida tooling, like editor plugins. If you just want to make stuff in Guida, there is nothing here for you.

Finding Metadata Files

Guida creates a per-user cache of package information. This cache is READ-ONLY. Do not modify or add files to it. Inside the cache, you have the guida.json and docs.json for every package that has been downloaded and built. This means you can just read them locally and do whatever sort of visualization or analysis you want.

Note: The per-user cache of package information lives at the directory specified in the GUIDA_HOME environment variable. If this environment variable is not set, it defaults to ~/.guida/ on UNIX systems and C:/Users/<user>/AppData/Roaming/guida on Windows. Again, do not modify or add files in GUIDA_HOME for your work because:

  1. It will be very confusing and frustrating if this cache is corrupted.
  2. This cache is cleared very infrequently, so it should be as small as possible.

If you need to cache information for your plugin, it is better to find a separate solution. Use the local guida-stuff/ directory so that it is easy for users to (1) delete if there is a problem and (2) reclaim the storage.