Skip to content

Commit

Permalink
docs: fix README typo, improve PackageJSON description (#40)
Browse files Browse the repository at this point in the history
'noticed a typo, reworded description

Otherwise the new release looks good to me.

Note: It would probably behoove this project to have a clearer
definition of what fields are / aren't defined in `PackageJSON`.
package.json files are a mishmash of ad-hoc state, which makes for a bit
of a slippery slope in terms of which types should / should not be
defined here. But that's a problem for a future date.

---------

Co-authored-by: Steven <[email protected]>
  • Loading branch information
broofa and styfle authored May 8, 2024
1 parent 4548f2c commit 5511d4b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Response type for the `https://registry.npmjs.org/:packageName` endpoint, _when
Response type for the `https://registry.npmjs.org/:packageName/:packageVersion` endpoint, _when made with the 'Accept: application/vnd.npm.install-v1+json' header_. Also the type of `Manifest['versions']` entries.

### PackageJSON
A "loose" definition of the "package.json" file type.
A "loose" definition of package.json structures.

> [!NOTE]
> This is not an authoritative definition of package.json structures. It is merely a best-effort attempt to define the fields that may appear in `PackumentVersion` structures, are copied from a module's package.json file.
> This is not an authoritative definition of package.json structures. Rather, it is a best-effort attempt to describe the fields that are de-facto standards for Node.js, npm, and TypeScript development.

0 comments on commit 5511d4b

Please sign in to comment.