Skip to content

Commit

Permalink
Prepare release 2.0.0 (#110)
Browse files Browse the repository at this point in the history
  • Loading branch information
justinfagnani authored Sep 13, 2022
1 parent a2e73f4 commit e44378d
Show file tree
Hide file tree
Showing 6 changed files with 276 additions and 195 deletions.
6 changes: 1 addition & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

<!-- ## [x.y.z] - YYYY-MM-DD -->

## Unreleased

<!-- ### Changed -->
## [2.0.0] - 2022-09-12

### Added

Expand All @@ -36,8 +34,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

- Added an optional `summary` field to Function and Method return types. ([#109](https://github.com/webcomponents/custom-elements-manifest/pull/109))

<!-- ### Removed -->

### Fixed

- Fixed how custom element declarations extend class declarations. Previously CustomElementDeclaration didn't include CustomElement properties, and MixinDeclaration required some CustomElement properties. Added new CustomElementMixinDeclaration interface. Fixes https://github.com/webcomponents/custom-elements-manifest/issues/69 ([#103](https://github.com/webcomponents/custom-elements-manifest/pull/103))
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ In order to allow tools to find npm packages with custom element manifests witho
## Schema Versioning

The schema has a `schemaVersion` field in the top-level object to facilitate
evolution of the schema. The schema follows [semver](https://semver.org/) versioning, the current schema version is `1.0.0`.
evolution of the schema. The schema follows [semver](https://semver.org/) versioning, the current schema version is `2.0.0`.

This version will not always match the npm package version, as some changes to the npm package might not have changes to the schema. We will publish a list of schema versions and their associated npm versions and git tags.

Expand Down Expand Up @@ -75,7 +75,7 @@ The manifest would look like:
`my-project/custom-elements.json`:
```json
{
"schemaVersion": "1.0.0",
"schemaVersion": "2.0.0",
"readme": "README.md",
"modules": [
{
Expand All @@ -84,8 +84,10 @@ The manifest would look like:
"declarations": [
{
"kind": "class",
"description": "This is the description of the class",
"customElement": true,
"name": "MyElement",
"tagName": "my-element",
"description": "This is the description of the class",
"members": [
{
"kind": "field",
Expand All @@ -111,9 +113,7 @@ The manifest would look like:
],
"superclass": {
"name": "HTMLElement"
},
"tagName": "my-element",
"customElement": true
}
}
],
"exports": [
Expand Down
12 changes: 6 additions & 6 deletions examples/simple-element.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
{
"schemaVersion": "1.0.0",
"schemaVersion": "2.0.0",
"readme": "README.md",
"modules": [
{
"kind": "javascript-module",
"path": "my-project/my-element.js",
"declarations": [
{
"kind": "class",
"description": "This is the description of the class",
"kind": "class",
"customElement": true,
"name": "MyElement",
"tagName": "my-element",
"description": "This is the description of the class",
"members": [
{
"kind": "field",
Expand All @@ -35,9 +37,7 @@
],
"superclass": {
"name": "HTMLElement"
},
"tagName": "my-element",
"customElement": true
}
}
],
"exports": [
Expand Down
Loading

0 comments on commit e44378d

Please sign in to comment.