@antongolub/lockfile 0.0.0-snapshot.14 → 0.0.0-snapshot.16

package/README.md

@@ -60,9 +60,9 @@ idx.edges
 ```
 
 ### Terms
-* `nmtree` — fs projection of deps, directories structure
-* `deptree` — bounds full dep paths with their resolved packages
-* `depgraph` — describes how resolved pkgs are related with each other
+`nmtree` — fs projection of deps, directories structure  
+`deptree` — bounds full dep paths with their resolved packages  
+`depgraph` — describes how resolved pkgs are related with each other
 
 ### Lockfiles types
 | Package manager      | Meta format | Read | Write |
@@ -73,7 +73,7 @@ idx.edges
 | yarn 1 (classic)     | 1           | ✓    | ✓     |
 | yarn 2, 3, 4 (berry) | 5, 6, 7     | ✓    | ✓     |
 
-### Protocols
+### Dependency protocols
 | Type      | Supported | Example                                 | Description                                                    |
 |-----------|-----------|-----------------------------------------|----------------------------------------------------------------|
 | semver    | ✓         | `^1.2.3`                                | Resolves from the default registry                             |
@@ -88,8 +88,9 @@ idx.edges
 | portal    |           | `portal:./my-folder`                    | Creates a link to the ./my-folder folder (follow dependencies) |
 | workspace | _limited_ | `workspace:*`                           | Creates a link to a package in another workspace               |
 
-https://v3.yarnpkg.com/features/protocols
-https://yarnpkg.com/protocols
+https://v3.yarnpkg.com/features/protocols  
+https://yarnpkg.com/protocols  
+https://docs.npmjs.com/cli/v10/configuring-npm/package-json#dependencies
 
 ### `TSnapshot`
 ```ts
@@ -107,8 +108,8 @@ export type TEntry = {
     md5?:     string
   }
   source:     {
-    type: TSourceType // npm, workspace, gh, patch, etc
-    id: string
+    type:     TSourceType // npm, workspace, gh, patch, etc
+    id:       string
     registry?: string
   }
   // optional pm-specific lockfile meta
@@ -123,7 +124,7 @@ export type TEntry = {
   bin?:                   Record<string, string>
   engines?:               Record<string, string>
   funding?:               Record<string, string>
-}>
+}
 ```
 
 ### `TSnapshotIndex`
@@ -156,7 +157,7 @@ export interface TSnapshotIndex {
 * yarn berry: no idea how to resolve and inject PnP patches https://github.com/yarnpkg/berry/tree/master/packages/plugin-compat
 * npm2 and npm3 requires `engines` and `funding` data, while yarn* or npm1 does not contain it
 * many `nmtree` projections may correspond to the specified `depgraph`
-* pkg.json `resolutions` directive is completely ignored for now
+* pkg.json `resolutions` and `overrides` directives are completely ignored for now
 * pkg aliases are not supported yet [#2](https://github.com/antongolub/lockfile/issues/2#issuecomment-1786613893)
 
 ### Inspired by
@@ -171,6 +172,12 @@ export interface TSnapshotIndex {
 * [what-is-package-lock-json](https://snyk.io/blog/what-is-package-lock-json/)
 * [the-ultimate-guide-to-yarn-lock-lockfiles](https://www.arahansen.com/the-ultimate-guide-to-yarn-lock-lockfiles/)
 * [package-lock-json-the-complete-guide](https://medium.com/helpshift-engineering/package-lock-json-the-complete-guide-2ae40175ebdd)
+<details>
+  <summary>more</summary>
+
+* [cvent/pnpm-lock-export](https://github.com/cvent/pnpm-lock-export)
+* [why-keep-package-lockjson](https://blog.npmjs.org/post/621733939456933888/npm-v7-series-why-keep-package-lockjson.html)
+</details>
 
-### License
+## License
 [MIT](./LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antongolub/lockfile",
-  "version": "0.0.0-snapshot.14",
+  "version": "0.0.0-snapshot.16",
   "publishConfig": {
     "access": "public"
   },