https://github.com/lue-bird/elm-docs-diff

compare versions of an elm API
https://github.com/lue-bird/elm-docs-diff

elm elm-diff semantic-versioning

Last synced: about 2 months ago
JSON representation

compare versions of an elm API

• Host: GitHub
• URL: https://github.com/lue-bird/elm-docs-diff
• Owner: lue-bird
• License: mit
• Created: 2024-02-17T16:38:27.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-20T20:40:29.000Z (11 months ago)
• Last Synced: 2024-10-14T00:42:05.797Z (3 months ago)
• Topics: elm, elm-diff, semantic-versioning
• Language: Elm
• Homepage: https://lue-bird.github.io/elm-docs-diff/
• Size: 127 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changes.md

Awesome Lists containing this project

README

        
## elm-docs-diff

Compare versions of an API using their `docs.json`. It's both

  - a [website](https://lue-bird.github.io/elm-docs-diff/) that allows you to select local `docs.json` files or fetch them online and show a nice diff

  - an unopinionated package with `Elm...Diff` helpers for [packages, modules, declarations and types](https://dark.elm.dmy.fr/packages/elm/project-metadata-utils/latest/Elm-Docs)

    in case you want to use an emulated `elm diff` in another context like [elm-review](https://dark.elm.dmy.fr/packages/jfmengels/elm-review/latest/) or [elm-posix](https://dark.elm.dmy.fr/packages/albertdahlin/elm-posix/latest/)

The idea is for this to be a more general `elm diff` to show changes between for example

  - versions of a package that doesn't have a complete change log

  - the original package and a fork or re-publish under a different name

  - versions of private packages

## thanks

  - rlefevre for [elm.dmy.fr](https://github.com/dmy/elm.dmy.fr) which the diff website uses as a proxy because it allows fetching package `docs.json`

  - Rupert Smith for [elm-syntax-dsl](https://dark.elm.dmy.fr/packages/the-sett/elm-syntax-dsl/latest/) which the diff website uses to format changed declarations