license-cop 2.1.2 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +10 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -36,6 +36,16 @@ npx license-cop
36
36
 
37
37
  The `license-cop` command will use an exit code of 0 if all your dependencies conform to the settings in your config file.
38
38
 
39
+ ## Supported projects
40
+
41
+ license-cop reads the dependencies your package manager has already installed, so run your package manager's install first. It supports npm, pnpm, Yarn and Bun, including their workspaces (run license-cop from the workspace root).
42
+
43
+ ### Yarn Plug'n'Play
44
+
45
+ Yarn 3 and 4 are tested with both of their linkers: `nodeLinker: node-modules` and the default, Plug'n'Play. A Plug'n'Play project has no `node_modules` for license-cop to read, so it reads the project's `.pnp.cjs` instead, and the packages in your Yarn cache (including the global cache and zero-install repositories) or in `.yarn/unplugged`.
46
+
47
+ A `.pnp.cjs` is JavaScript that Yarn generates, and reading it means running it, in the same way `yarn run` does. As with running any other command in a project, only run license-cop against a Plug'n'Play project you trust.
48
+
39
49
  ## Command line options
40
50
 
41
51
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "license-cop",
3
- "version": "2.1.2",
3
+ "version": "2.2.1",
4
4
  "type": "module",
5
5
  "bin": {
6
6
  "license-cop": "./dist/bin.js"
@@ -43,7 +43,7 @@
43
43
  "oss"
44
44
  ],
45
45
  "dependencies": {
46
- "@license-cop/core": "2.1.2",
46
+ "@license-cop/core": "2.2.1",
47
47
  "cosmiconfig": "^10.0.0",
48
48
  "deepmerge": "^4.3.1",
49
49
  "json5": "^2.2.3",