Skip to content

docs: clarify package name rules #1326

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

Merged
merged 3 commits into from
Oct 14, 2024
Merged

docs: clarify package name rules #1326

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d9c567
Update creating-a-package-json-file.mdx
kenshanta Oct 14, 2024
2155520
fixup: Update content/packages-and-modules/contributing-packages-to-t…
wraithgar Oct 14, 2024
065ed41
markdown text formatting and grammar fixes
kenshanta Oct 14, 2024
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
8 changes: 4 additions & 4 deletions ...-modules/contributing-packages-to-the-registry/creating-a-package-json-file.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ A `package.json` file:

A `package.json` file must contain `"name"` and `"version"` fields.

The `"name"` field contains your package's name, and must be lowercase and one word, and may contain hyphens and underscores.
The `"name"` field contains your package's name and *must* be lowercase *without* any spaces. May contain _hyphens_, _dots_, and _underscores_.

The `"version"` field must be in the form `x.x.x` and follow the [semantic versioning guidelines][semver].

### Author field

If you want to include package author information in `"author"` field, use the following format (email and website are both optional):
If you want inclusive package author information, in the `"author"` field use the following format (email and website are both optional):

```
Your Name <[email protected]> (http://example.com)
Your Name <[email protected]> (https://example.com)
```

### Example
Expand All @@ -43,7 +43,7 @@ Your Name <[email protected]> (http://example.com)
{
"name": "my-awesome-package",
"version": "1.0.0",
"author": "Your Name <[email protected]> (http://example.com)"
"author": "Your Name <[email protected]> (https://example.com)"
}
```

Expand Down