46 lines
986 B
Plaintext
46 lines
986 B
Plaintext
# @changesets/parse
|
|
|
|
[](https://changelogs.xyz/@changesets/parse)
|
|
|
|
Parses a changeset from its written format to a data object.
|
|
|
|
```js
|
|
import parse from "@changesets/parse";
|
|
|
|
const changeset = `---
|
|
"@changesets/something": minor
|
|
"@changesets/something-else": patch
|
|
---
|
|
|
|
A description of a minor change`;
|
|
|
|
const parsedChangeset = parse(changeset);
|
|
```
|
|
|
|
For example, it can convert:
|
|
|
|
```md
|
|
---
|
|
"@changesets/something": minor
|
|
"@changesets/something-else": patch
|
|
---
|
|
|
|
A description of a minor change
|
|
```
|
|
|
|
to
|
|
|
|
```json
|
|
{
|
|
"summary": "A description of a minor change",
|
|
"releases": [
|
|
{ "name": "@changesets/something", "type": "minor" },
|
|
{ "name": "@changesets/something-else", "type": "patch" }
|
|
]
|
|
}
|
|
```
|
|
|
|
Note that this is not quite a complete Changeset for most tools as it lacks an `id`.
|
|
|
|
For written changesets, the id is normally given as the file name, which parse is not aware of.
|