bare-ts / tools / 5417308081

93%

push

github

feat: promote regular comments to doc-comments

BREAKING CHANGES: use regular comments instead

Previously, _bare-ts_ introduced a special syntax for doc-comments:

```bare
type Gender enum {
    ## Be inclusive :)
    FLUID
    MALE
    ## One is not born, but becomes a woman
    ##                  -- Simone de Beauvoir
    FEMALE
}

type Person {
    ## person's name
    name: str
    ## person's gender
    gender: optional<Gender>
}
```

This syntax is not part of the _BARE_ specification.
Thus, the syntax is not portable between _BARE__ implementations.
To avoid this issue, _bare-ts__ now uses regular comments as doc-comments.
Every comment that precedes a type definition, an enum value, or a field is a doc-comment.
The previous schema can now be written as follows:

```bare
type Gender enum {
    # Be inclusive :)
    FLUID
    MALE
    # One is not born, but becomes a woman
    #                  -- Simone de Beauvoir
    FEMALE
}

type Person {
    # person's name
    name: str
    # person's gender
    gender: optional<Gender>
}
```

839 of 920 branches covered (91.2%)

Branch coverage included in aggregate %.

2545 of 2711 relevant lines covered (93.88%)

243.83 hits per line