@pnpm/default-reporter 8.5.1 → 8.5.2

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 (1) hide show
  1. package/package.json +4 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pnpm/default-reporter",
3
- "version": "8.5.1",
3
+ "version": "8.5.2",
4
4
  "description": "The default reporter of pnpm",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -24,7 +24,7 @@
24
24
  "@pnpm/config": "13.7.1",
25
25
  "@pnpm/core-loggers": "6.1.1",
26
26
  "@pnpm/error": "2.0.0",
27
- "@pnpm/render-peer-issues": "1.0.1",
27
+ "@pnpm/render-peer-issues": "1.0.2",
28
28
  "@pnpm/types": "7.7.1",
29
29
  "ansi-diff": "^1.1.1",
30
30
  "boxen": "^5.0.0",
@@ -59,5 +59,6 @@
59
59
  "_test": "jest",
60
60
  "test": "pnpm run compile && pnpm run _test",
61
61
  "compile": "rimraf lib tsconfig.tsbuildinfo && tsc --build && pnpm run lint -- --fix"
62
- }
62
+ },
63
+ "readme": "# @pnpm/default-reporter\n\n> The default reporter of pnpm\n\n## Installation\n\n```\n<pnpm|npm|yarn> add @pnpm/default-reporter\n```\n\n## Usage\n\n```ts\nimport { streamParser } from '@pnpm/logger'\nimport defaultReporter from '@pnpm/default-reporter'\n\nconst stopReporting = defaultReporter({\n context: {\n argv: [],\n },\n streamParser,\n})\n\ntry {\n // calling some pnpm APIs\n} finally {\n stopReporting()\n}\n```\n\n## Style Guide\n\n1. Never use blue or grey as font color as they are hard to read in many consoles.\n 1. Use dim instead of grey\n 1. Use cyan bright instead of blue\n1. Don't hide the CLI cursor. (It is easier to never hide but it is really needed only when scripts are running.)\n1. Don't use green and yellow to distinct something.\n\n## License\n\n[MIT](LICENSE)\n"
63
64
  }