Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add package name #123

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add package name #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ The manifest would look like:
`my-project/custom-elements.json`:
```json
{
"name": "my-element",
"schemaVersion": "2.0.0",
"readme": "README.md",
"modules": [
Expand Down
3 changes: 2 additions & 1 deletion examples/simple-element.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,6 @@
}
]
}
]
],
"name": "my-element"
}
5 changes: 5 additions & 0 deletions schema.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@
* canonical export that should be used.
*/
export interface Package {
/**
* The name of the schema, it's best to be unique.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should say that it's the name of the package.

We almost certainly want to namespace the package names too, since npm isn't the only package registry in town. We have at least GitHub, JSR, and internal repositories. We should discuss namespacing conventions in #119

*/
name?: string;

/**
* The version of the schema used in this file.
*/
Expand Down
3 changes: 3 additions & 0 deletions schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1088,6 +1088,9 @@
"schemaVersion": {
"description": "The version of the schema used in this file.",
"type": "string"
},
"name": {
"description": "The name of the schema."
}
},
"required": [
Expand Down