docs: update package.json docs (#780)

BioPhoton · web-flow · commit 7db09b9b7556 · 2024-08-05T21:01:14.000+02:00
diff --git a/esbuild.config.js b/esbuild.config.js
@@ -97,7 +97,11 @@ module.exports = {
           );
 
           packageJson.license = rootPackageJson.license;
-          packageJson.homepage = rootPackageJson.homepage;
+          if (project.name === 'cli') {
+            packageJson.homepage = rootPackageJson.homepage;
+          } else {
+            packageJson.homepage = `https://github.com/code-pushup/cli/tree/main/packages/${project.name}#readme`;
+          }
           packageJson.bugs = rootPackageJson.bugs;
           packageJson.repository = {
             ...rootPackageJson.repository,
diff --git a/package.json b/package.json
@@ -2,41 +2,15 @@
   "name": "@code-pushup/cli-source",
   "version": "0.0.0",
   "license": "MIT",
-  "homepage": "https://github.com/code-pushup/cli#readme",
+  "description": "A CLI to run all kinds of code quality measurements to align your team with company goals",
+  "homepage": "code-pushup.dev",
   "bugs": {
     "url": "https://github.com/code-pushup/cli/issues"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/code-pushup/cli.git"
   },
-  "contributors": [
-    {
-      "name": "Igor Katsuba",
-      "email": "igor@katsuba.dev",
-      "url": "https://katsuba.dev"
-    },
-    {
-      "name": "Kateřina Pilátová",
-      "email": "katerina.pilatova@flowup.cz",
-      "url": "https://github.com/Tlacenka"
-    },
-    {
-      "name": "Matěj Chalk",
-      "email": "matej.chalk@flowup.cz",
-      "url": "https://github.com/matejchalk"
-    },
-    {
-      "name": "Michael Hladky",
-      "email": "michael.hladky@push-based.io",
-      "url": "https://push-based.io"
-    },
-    {
-      "name": "Michael Seredenko",
-      "email": "misha.seredenko@push-based.io",
-      "url": "https://github.com/MishaSeredenkoPushBased"
-    }
-  ],
   "scripts": {
     "prepare": "husky install",
     "commit": "git-cz",
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -2,6 +2,7 @@
   "name": "@code-pushup/cli",
   "version": "0.49.0",
   "license": "MIT",
+  "description": "A CLI to run all kinds of code quality measurements to align your team with company goals",
   "bin": {
     "code-pushup": "index.js"
   },
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -2,12 +2,11 @@
   "name": "@code-pushup/core",
   "version": "0.49.0",
   "license": "MIT",
+  "description": "Core business logic for the used by the Code PushUp CLI",
   "dependencies": {
     "@code-pushup/models": "0.49.0",
     "@code-pushup/utils": "0.49.0",
     "@code-pushup/portal-client": "^0.9.0",
     "ansis": "^3.3.0"
-  },
-  "type": "commonjs",
-  "main": "./index.cjs"
+  }
 }
diff --git a/packages/models/package.json b/packages/models/package.json
@@ -2,6 +2,7 @@
   "name": "@code-pushup/models",
   "version": "0.49.0",
   "license": "MIT",
+  "description": "Model definitions and validators for the Code PushUp CLI",
   "dependencies": {
     "zod": "^3.22.1",
     "vscode-material-icons": "^0.1.0"
diff --git a/packages/nx-plugin/package.json b/packages/nx-plugin/package.json
@@ -2,6 +2,7 @@
   "name": "@code-pushup/nx-plugin",
   "version": "0.29.0",
   "license": "MIT",
+  "description": "Nx plugin to integrate the Code PushUp CLI into your workspace 🛠️",
   "dependencies": {
     "@nx/devkit": "^17.1.3",
     "tslib": "2.6.2",
diff --git a/packages/plugin-coverage/package.json b/packages/plugin-coverage/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@code-pushup/coverage-plugin",
   "version": "0.49.0",
+  "description": "Code PushUp plugin for tracking code coverage ☂",
   "dependencies": {
     "@code-pushup/models": "0.49.0",
     "@code-pushup/utils": "0.49.0",
diff --git a/packages/plugin-eslint/package.json b/packages/plugin-eslint/package.json
@@ -2,6 +2,7 @@
   "name": "@code-pushup/eslint-plugin",
   "version": "0.49.0",
   "license": "MIT",
+  "description": "Code PushUp plugin for detecting problems in source code using ESLint.📋",
   "dependencies": {
     "@code-pushup/utils": "0.49.0",
     "@code-pushup/models": "0.49.0",
diff --git a/packages/plugin-js-packages/package.json b/packages/plugin-js-packages/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@code-pushup/js-packages-plugin",
   "version": "0.49.0",
+  "description": "Code PushUp plugin for JavaScript packages 🛡️",
   "dependencies": {
     "@code-pushup/models": "0.49.0",
     "@code-pushup/utils": "0.49.0",
diff --git a/packages/plugin-lighthouse/package.json b/packages/plugin-lighthouse/package.json
@@ -2,6 +2,7 @@
   "name": "@code-pushup/lighthouse-plugin",
   "version": "0.49.0",
   "license": "MIT",
+  "description": "Code PushUp plugin for measuring web performance and quality with Lighthouse 🔥",
   "dependencies": {
     "@code-pushup/models": "0.49.0",
     "@code-pushup/utils": "0.49.0",
diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@code-pushup/utils",
   "version": "0.49.0",
+  "description": "Low-level utilities (helper functions, etc.) used by Code PushUp CLI",
   "dependencies": {
     "@code-pushup/models": "0.49.0",
     "@isaacs/cliui": "^8.0.2",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@code-pushup/coverage-plugin",`
`3`	`3`	`"version": "0.49.0",`
	`4`	`+ "description": "Code PushUp plugin for tracking code coverage ☂",`
`4`	`5`	`"dependencies": {`
`5`	`6`	`"@code-pushup/models": "0.49.0",`
`6`	`7`	`"@code-pushup/utils": "0.49.0",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@code-pushup/js-packages-plugin",`
`3`	`3`	`"version": "0.49.0",`
	`4`	`+ "description": "Code PushUp plugin for JavaScript packages 🛡️",`
`4`	`5`	`"dependencies": {`
`5`	`6`	`"@code-pushup/models": "0.49.0",`
`6`	`7`	`"@code-pushup/utils": "0.49.0",`