elm / compiler

Compiler for Elm, a functional language for reliable webapps.
https://elm-lang.org/
BSD 3-Clause "New" or "Revised" License
7.48k stars 658 forks source link

exposing variants → major version; should be minor #2290

Open lue-bird opened 1 year ago

lue-bird commented 1 year ago

If a package exposes variants of a type that did not expose its variants in a previous version, it will be marked as a major change, even though it doesn't remove but only add API → minor change.

SSCCE

module Data exposing (Data)
{-| -}
{-| -}
type Data
    = Data

changed to

module Data exposing (Data(..))
{-| -}
{-| -}
type Data
    = Data

then

elm diff

prints out

This is a MAJOR change.

---- N - MAJOR ----

    Changed:
      - type Data 
      + type Data  = Data

docs json output

elm make --docs=....json

previous version

{"name":"Data","comment":" \n","args":[],"cases":[]}

new version

{"name":"Data","comment":" \n","args":[],"cases":[["Data"]]}
github-actions[bot] commented 1 year ago

Thanks for reporting this! To set expectations:

Finally, please be patient with the core team. They are trying their best with limited resources.