Merge branch 'main' of github.com:getlarge/code-pushup-cli

Author: getlarge

.github/workflows/ci.yml

@@ -105,6 +105,15 @@ jobs:
         uses: nrwl/nx-set-shas@v4
       - name: Install dependencies
         run: npm ci
+      - name: Set custom Chrome path for Windows only
+        if: matrix.os == 'windows-latest'
+        # This path is considered in `testing/setup/src/lib/chrome-path-setup.ts` and used in different test configurations
+        run: |
+          echo "CUSTOM_CHROME_PATH=C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe" | Out-File -FilePath $env:GITHUB_ENV -Append -Encoding utf8
+        shell: pwsh
+      #- name: Log all environment variables
+      #  run: |
+      #      printenv
       - name: Integration test affected projects
         run: npx nx affected -t integration-test --parallel=3 --coverage.enabled
 

.github/workflows/code-coverage.yml

@@ -34,11 +34,11 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: Execute all tests and generate coverage reports
-        run: npx nx run ${{ matrix.lib }}:${{ matrix.scope }}-test --coverage.enabled
+        run: npx nx run ${{ matrix.lib }}:${{ matrix.scope }}-test --coverage.enabled --skipNxCache
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v4
         with:
-          directory: ./coverage/${{ matrix.lib }}/${{ matrix.scope }}-tests/
+          directory: coverage/${{ matrix.lib }}/${{ matrix.scope }}-tests/
           files: ./lcov.info
           flags: ${{ matrix.lib }}-${{ matrix.scope }}
           token: ${{ secrets.CODECOV_TOKEN }}

CONTRIBUTING.md

@@ -12,6 +12,25 @@ Make sure to install dependencies:
 npm install
 ```
 
+## Environment Variables
+
+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.                                                                                        |
+
+**❗️** Test Inclusion Logic
+
+- `INCLUDE_SLOW_TESTS='false'` skips long tests.
+- without `INCLUDE_SLOW_TESTS`, tests run if `CI` is set.
+
+**❗️❗️** Windows specific path set only in CI
+
+- some setups also require this setting locally
+
 ## Development
 
 Refer to docs on [how to run tasks in Nx](https://nx.dev/core-features/run-tasks).
@@ -41,6 +60,15 @@ npx nx affected:lint
 npx nx code-pushup -- collect
 ```
 
+## Testing
+
+Some of the plugins have a longer runtime. In order to ensure better DX, longer tests are excluded by default when executing tests locally.
+
+You can control the execution of long-running tests over the `INCLUDE_SLOW_TESTS` environment variable.
+
+To change this setup, open (or create) the `.env` file in the root folder.
+Edit or add the environment variable there as follows: `INCLUDE_SLOW_TESTS=true`.
+
 ## Git
 
 Commit messages must follow [conventional commits](https://conventionalcommits.org/) format.

code-pushup.config.ts

@@ -87,18 +87,22 @@ const config: CoreConfig = {
     {
       slug: 'bug-prevention',
       title: 'Bug prevention',
+      description: 'Lint rules that find **potential bugs** in your code.',
       refs: [{ type: 'group', plugin: 'eslint', slug: 'problems', weight: 1 }],
     },
     {
       slug: 'code-style',
       title: 'Code style',
+      description:
+        'Lint rules that promote **good practices** and consistency in your code.',
       refs: [
         { type: 'group', plugin: 'eslint', slug: 'suggestions', weight: 1 },
       ],
     },
     {
       slug: 'code-coverage',
       title: 'Code coverage',
+      description: 'Measures how much of your code is **covered by tests**.',
       refs: [
         {
           type: 'group',
@@ -111,6 +115,7 @@ const config: CoreConfig = {
     {
       slug: 'security',
       title: 'Security',
+      description: 'Finds known **vulnerabilities** in 3rd-party packages.',
       refs: [
         {
           type: 'group',
@@ -123,6 +128,7 @@ const config: CoreConfig = {
     {
       slug: 'updates',
       title: 'Updates',
+      description: 'Finds **outdated** 3rd-party packages.',
       refs: [
         {
           type: 'group',

packages/cli/project.json

@@ -31,18 +31,14 @@
     },
     "unit-test": {
       "executor": "@nx/vite:test",
-      "outputs": ["{options.reportsDirectory}"],
       "options": {
-        "config": "packages/cli/vite.config.unit.ts",
-        "reportsDirectory": "../../coverage/cli/unit-tests"
+        "config": "packages/cli/vite.config.unit.ts"
       }
     },
     "integration-test": {
       "executor": "@nx/vite:test",
-      "outputs": ["{options.reportsDirectory}"],
       "options": {
-        "config": "packages/cli/vite.config.integration.ts",
-        "reportsDirectory": "../../coverage/cli/integration-tests"
+        "config": "packages/cli/vite.config.integration.ts"
       }
     },
     "run-help": {

packages/cli/vite.config.integration.ts

@@ -16,7 +16,7 @@ export default defineConfig({
     coverage: {
       reporter: ['text', 'lcov'],
       reportsDirectory: '../../coverage/cli/integration-tests',
-      exclude: ['mocks/**'],
+      exclude: ['mocks/**', '**/types.ts'],
     },
     environment: 'node',
     include: ['src/**/*.integration.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],

packages/cli/vite.config.unit.ts

@@ -16,7 +16,7 @@ export default defineConfig({
     coverage: {
       reporter: ['text', 'lcov'],
       reportsDirectory: '../../coverage/cli/unit-tests',
-      exclude: ['mocks/**'],
+      exclude: ['mocks/**', '**/types.ts'],
     },
     environment: 'node',
     include: ['src/**/*.unit.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],

packages/core/project.json

@@ -31,18 +31,14 @@
     },
     "unit-test": {
       "executor": "@nx/vite:test",
-      "outputs": ["{options.reportsDirectory}"],
       "options": {
-        "config": "packages/core/vite.config.unit.ts",
-        "reportsDirectory": "../../coverage/core/unit-tests"
+        "config": "packages/core/vite.config.unit.ts"
       }
     },
     "integration-test": {
       "executor": "@nx/vite:test",
-      "outputs": ["{options.reportsDirectory}"],
       "options": {
-        "config": "packages/core/vite.config.integration.ts",
-        "reportsDirectory": "../../coverage/core/integration-tests"
+        "config": "packages/core/vite.config.integration.ts"
       }
     }
   },

packages/core/vite.config.integration.ts

@@ -16,7 +16,7 @@ export default defineConfig({
     coverage: {
       reporter: ['text', 'lcov'],
       reportsDirectory: '../../coverage/core/integration-tests',
-      exclude: ['mocks/**'],
+      exclude: ['mocks/**', '**/types.ts'],
     },
     environment: 'node',
     include: ['src/**/*.integration.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],

packages/core/vite.config.unit.ts

@@ -16,7 +16,7 @@ export default defineConfig({
     coverage: {
       reporter: ['text', 'lcov'],
       reportsDirectory: '../../coverage/core/unit-tests',
-      exclude: ['mocks/**'],
+      exclude: ['mocks/**', '**/types.ts'],
     },
     environment: 'node',
     include: ['src/**/*.unit.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],