merge main

code-pushup · Oct 18, 2024 · 97c8d30 · 97c8d30
2 parents 671d84f + 3465e16
commit 97c8d30
Show file tree

Hide file tree

Showing 64 changed files with 1,031 additions and 1,348 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -76,5 +76,5 @@
           - 'esbuild.config.js'
           - '.github/ISSUE_TEMPLATE/**'
           - '.husky/**'
-          - 'commitlint.config.js'
+          - 'commitlint.config.mjs'
           - '.verdaccio/config.yml'
diff --git a/.prettierrc b/.prettierrc
@@ -2,6 +2,7 @@
   "singleQuote": true,
   "arrowParens": "avoid",
   "trailingComma": "all",
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
   "importOrder": [
     "^@code-pushup/portal-client$",
     "^@code-pushup/(.*)$",

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,18 @@
+## 0.53.1 (2024-10-18)
+
+### 🚀 Features
+
+- add keywords for NPM to display ([17a0c498](https://github.com/code-pushup/cli/commit/17a0c498))
+
+### 🩹 Fixes
+
+- **ci:** handle monorepo mode in non-PR flow ([d7ba5a3f](https://github.com/code-pushup/cli/commit/d7ba5a3f))
+
+### ❤️ Thank You
+
+- Matěj Chalk
+- Vojtech Masek @vmasek
+
 ## 0.53.0 (2024-10-17)
 
 ### 🚀 Features

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,11 +16,11 @@ npm install
 
 This table provides a quick overview of the environmental setup, with detailed explanations in the corresponding sections.
 
-| Feature                          | Local Default | CI Default         | Description                                                                                                                   |
-| -------------------------------- | ------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
-| `env.INCLUDE_SLOW_TESTS` **❗️** | `false`       | `true`             | Controls inclusion of long-running tests. Overridden by setting. Details in the [Testing](#Testing) section.                  |
-| `env.CUSTOM_CHROME_PATH`         | N/A           | Windows **❗️❗️** | Path to Chrome executable. See [plugin-lighthouse/CONTRIBUTING.md](./packages/plugin-lighthouse/CONTRIBUTING.md#chrome-path). |
-| Quality Pipeline                 | Off           | On                 | Runs all plugins against the codebase.                                                                                        |
+| Feature                         | Local Default | CI Default       | Description                                                                                                                   |
+| ------------------------------- | ------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `env.INCLUDE_SLOW_TESTS` **❗️** | `false`       | `true`           | Controls inclusion of long-running tests. Overridden by setting. Details in the [Testing](#Testing) section.                  |
+| `env.CUSTOM_CHROME_PATH`        | N/A           | Windows **❗️❗️** | Path to Chrome executable. See [plugin-lighthouse/CONTRIBUTING.md](./packages/plugin-lighthouse/CONTRIBUTING.md#chrome-path). |
+| Quality Pipeline                | Off           | On               | Runs all plugins against the codebase.                                                                                        |
 
 **❗️** Test Inclusion Logic
 

diff --git a/commitlint.config.js → commitlint.config.mjs b/commitlint.config.js → commitlint.config.mjs
@@ -1,25 +1,23 @@
-const { RuleConfigSeverity } = require('@commitlint/types');
-const { rules } = require('@commitlint/config-conventional');
-const {
-  utils: { getProjects },
-} = require('@commitlint/config-nx-scopes');
+import config from '@commitlint/config-conventional';
+import nxScopes from '@commitlint/config-nx-scopes';
+import { RuleConfigSeverity } from '@commitlint/types';
 
 /** @type {import('@commitlint/types').UserConfig} */
-const configuration = {
+export default {
   extends: ['@commitlint/config-conventional'],
   plugins: ['commitlint-plugin-tense'],
   rules: {
     'scope-enum': async ctx => {
-      const projects = await getProjects(
+      const projects = nxScopes.utils.getProjects(
         ctx,
-        ({ name, projectType, tags }) =>
+        ({ projectType }) =>
           projectType === 'library' || projectType === 'application',
       );
       const scopes = [...projects, 'tools', 'workflows', 'testing'].sort();
       return [RuleConfigSeverity.Error, 'always', scopes];
     },
     'type-enum': () => {
-      const defaultTypes = rules['type-enum'][2];
+      const defaultTypes = config.rules['type-enum'][2];
       const types = [
         ...defaultTypes,
         'release', // custom type for release commits
@@ -33,5 +31,3 @@ const configuration = {
     ],
   },
 };
-
-module.exports = configuration;
diff --git a/docs/e2e.md b/docs/e2e.md
@@ -102,7 +102,7 @@ Root/
 // nx.json
 {
   // ...
-  "plugins": ["tools/src/npm/npm.plugin.ts", "tools/src/publish/publish.plugin.ts", "tools/src/verdaccio/verdaccio.plugin.ts"]
+  "plugins": ["tools/src/npm/npm.plugin.ts", "tools/src/publish/publish.plugin.ts", "tools/src/verdaccio/verdaccio.plugin.ts"],
 }
 ```
 
@@ -115,10 +115,10 @@ Root/
     "e2e": {
       "executor": "@nx/vite:test",
       "options": {
-        "configFile": "e2e/<project-name>-e2e/vite.config.e2e.ts"
-      }
-    }
-  }
+        "configFile": "e2e/<project-name>-e2e/vite.config.e2e.ts",
+      },
+    },
+  },
 }
 ```
 

diff --git a/e2e/cli-e2e/tests/collect.e2e.test.ts b/e2e/cli-e2e/tests/collect.e2e.test.ts
@@ -32,7 +32,7 @@ describe('CLI collect', () => {
       audits: audits.map(
         pluginReport.slug === 'lighthouse' ? omitVariableAuditData : p => p,
       ) as AuditReport[],
-    } as PluginReport);
+    }) as PluginReport;
   const omitVariableReportData = ({
     commit,
     date,

diff --git a/esbuild.config.js b/esbuild.config.js
@@ -1,4 +1,3 @@
-const { readFile, writeFile, stat } = require('node:fs/promises');
 const { exec } = require('node:child_process');
 const { promisify } = require('node:util');
 
@@ -45,7 +44,7 @@ module.exports = {
 
           try {
             await promisify(exec)(
-              `tsc --emitDeclarationOnly --project ${tsConfig} --outDir dist`,
+              `npx tsc --emitDeclarationOnly --project ${tsConfig} --outDir dist`,
             );
           } catch (err) {
             console.error(err);
@@ -54,71 +53,5 @@ module.exports = {
         });
       },
     },
-    {
-      name: 'PackageJSON',
-      setup(build) {
-        build.onEnd(async result => {
-          if (result.errors.length > 0) return;
-
-          const project = await getNxProject();
-          const { outputPath } = getESBuildExecutorOptions(project);
-
-          const sourcePackageJsonPath = `${project.data.root}/package.json`;
-          const outputPackageJsonPath = `${outputPath}/package.json`;
-
-          const isPublishable = await stat(sourcePackageJsonPath)
-            .then(stats => stats.isFile())
-            .catch(() => false);
-
-          if (!isPublishable) {
-            /** @type {import('nx/src/utils/package-json').PackageJson} */
-            const newPackageJson = {
-              name: `@code-pushup/${project.name}`,
-              private: true,
-              type: 'module',
-              main: 'index.js',
-              types: 'src/index.d.ts',
-            };
-            await writeFile(
-              outputPackageJsonPath,
-              JSON.stringify(newPackageJson, null, 2),
-            );
-            return;
-          }
-
-          /** @type {import('nx/src/utils/package-json').PackageJson} */
-          const packageJson = JSON.parse(
-            await readFile(sourcePackageJsonPath, 'utf8'),
-          );
-
-          /** @type {import('nx/src/utils/package-json').PackageJson} */
-          const rootPackageJson = JSON.parse(
-            await readFile('package.json', 'utf8'),
-          );
-
-          packageJson.license = rootPackageJson.license;
-          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,
-            directory: project.data.root,
-          };
-          packageJson.contributors = rootPackageJson.contributors;
-          packageJson.publishConfig = { access: 'public' };
-          packageJson.type = 'module';
-          packageJson.main = './index.js';
-          packageJson.types = './src/index.d.ts';
-
-          await writeFile(
-            outputPackageJsonPath,
-            JSON.stringify(packageJson, null, 2),
-          );
-        });
-      },
-    },
   ],
 };
diff --git a/examples/react-todos-app/index.html b/examples/react-todos-app/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8" />

diff --git a/knip.config.ts b/knip.config.ts
@@ -1,5 +1,5 @@
 import {
-  KnipConfigPlugin,
+  type KnipConfigPlugin,
   combineNxKnipPlugins,
   withEsbuildApps,
   withEsbuildPublishableLibs,
@@ -48,7 +48,7 @@ const withNxStandards = (): KnipConfigPlugin => () => {
     project: ['**/*.{ts,js,tsx,jsx}'],
     ignore: ['tmp/**', 'node_modules/**'],
     commitlint: {
-      config: ['commitlint.config.js'],
+      config: ['commitlint.config.mjs'],
     },
     exclude: ['duplicates'],
     entry: [