https://github.com/elm/project-metadata-utils

Work with elm.json and docs.json files in Elm
https://github.com/elm/project-metadata-utils

docs documentation elm

Last synced: 3 months ago
JSON representation

Work with elm.json and docs.json files in Elm

• Host: GitHub
• URL: https://github.com/elm/project-metadata-utils
• Owner: elm
• License: bsd-3-clause
• Created: 2017-08-02T19:02:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-04-14T20:54:33.000Z (over 3 years ago)
• Last Synced: 2024-09-30T10:03:45.629Z (3 months ago)
• Topics: docs, documentation, elm
• Language: Elm
• Homepage: https://package.elm-lang.org/packages/elm/project-metadata-utils/latest/
• Size: 50.8 KB
• Stars: 16
• Watchers: 10
• Forks: 13
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Work with `elm.json` and `docs.json`

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

Both `package.elm-lang.org` and `elm reactor` needed the functionality provided by this package, and over time, it became clear that this subset can be reasonably shared.

## Finding Metadata Files

Elm 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 `elm.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 `ELM_HOME` environment variable. If this environment variable is not set, it defaults to  `~/.elm/` on UNIX systems and `C:/Users//AppData/Roaming/elm` on Windows. Again, **do not modify or add files in `ELM_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 `elm-stuff/` directory so that it is easy for users to (1) delete if there is a problem and (2) reclaim the storage.