Release v5.2.0 (#407)

### eslint-plugin v5.2.0

#### Added

- feat: Start supporting new template data and syntax, as described in [#370](#370). Not added to the documentation yet, as it is still in beta testing phase.
- feat: Add setting `legacy-templates` to enable/disable the old template data and syntax. By default, it is enabled for backward compatibility. Not added to the documentation yet, as the new template data and syntax is still in beta testing phase.
- feat([#371](#371)): Publish eslint-plugin both to @boundaries/eslint-plugin and eslint-plugin-boundaries package names.
- feat: Add `cache` setting to enable/disable the new cache mechanism used to boost performance. By default, it is enabled. We recommend to keep it enabled unless you experience issues. In such case, please, open an issue describing the problem.

#### Changed

- feat: Improve performance in approximately 30% in large codebases by optimizing cache usage and reducing redundant computations when resolving elements and matching rules.
- refactor([#371](#371)): Extract element descriptors and matching logic to a separate module to improve code organization, readability and reusability.
- refactor: Overall performance improvements and code optimizations.
- feat: Add empty schema to rules without options to validate them correctly.

#### Fixed

- fix: Assign internalPaths correctly when in elements setting the mode is 'file' but the pattern matches folders, not files. Now it returns the correct internalPaths instead of the matched folder name.
- fix: Assign relationships correctly in dependencies. Now ancestor and nephew relationships are assigned correctly. Previously, all ancestors with a common parent were considered uncles.

### elements v1.1.0

#### Added

- feat: Implement cache for micromatch results, regex and captures to improve performance.
- feat: Add `cache` option to allow disabling the cache.

#### Changed

- refactor: Overall performance improvements and code optimizations.

#### Fixed

- fix: Fix cache performance issues by implementing custom string generation for well-known objects, and removing caching for keys based on complex objects to avoid performance degradation.
- fix: Legacy selectors being an array with only one element now correctly treated as a single string selector.

Author: javierbrea

.github/CONTRIBUTING.md

@@ -3,7 +3,8 @@
 # Table of Contents
 
 - [Getting started](#getting-started)
-- [package tasks](#package-tasks)
+- [Contributing workflow](#contributing-workflow)
+- [Package Tasks](#package-tasks)
 - [Branching model](#branching-model)
 - [Pull Request](#pull-request)
 - [Release process](#release-process)
@@ -29,7 +30,19 @@ To get started, clone the repository and install the dependencies:
 pnpm install
 ```
 
-# Package tasks
+# Contributing workflow
+
+In short, the contributing workflow is as follows:
+
+1. Create an RFC (if needed)
+2. Create Issue(s) from RFC
+3. Break Down into Sub-Issues (if needed)
+4. Add to Project & Assign to Milestone
+5. Contributors Pick Up Tasks
+
+Read the full details in the [contributing workflow guide](../docs/contributing-workflow.md).
+
+# Package Tasks
 
 Package task names are standardized across the repository. This enables to define common dependencies and files impacting them in the root `nx.json` file. The following are the most common tasks:
 
@@ -38,20 +51,21 @@ Package task names are standardized across the repository. This enables to defin
 * `check:spell`: Checks the spelling in the package.
 * `build`: Builds the package.
 * `test:unit`: Runs the unit tests.
+* `test:mutation`: Runs the mutation tests.
 * `test:e2e`: Runs the end-to-end tests.
 * `check:all`: Run all the checks and build the package.
 
-You can also rewrite the tasks to fit the package's needs. For example, if a package has special requirements for unit tests, you can define a `test:unit` task in the package's `project.json` file, redefining the Nx inputs, outputs, and dependencies in order to fit the package's needs and optimize the cache accordingly. _(See how the `eslint-plugin-boundaries` package does this for an example)_
+You can also rewrite the tasks to fit the package's needs. For example, if a package has special requirements for unit tests, you can define a `test:unit` task in the package's `project.json` file, redefining the Nx inputs, outputs, and dependencies in order to fit the package's needs and optimize the cache accordingly. _(See how the `eslint-plugin` package does this for an example)_
 
 > [!WARNING]
 > It is crucial to configure properly the tasks dependencies, input, and output files, so __Nx can keep or clean the cache correctly, avoiding running unnecessary tasks__, both locally or in the pipeline.
 
 ## Running tasks in packages
 
-Nx provides a way to run commands in a specific package, taking care of the task dependencies. To run a command in a package, use the following syntax: `pnpm nx run <task> <package>`. For example, to run the unit tests in the `eslint-plugin-boundaries` package, use the following command:
+Nx provides a way to run commands in a specific package, taking care of the task dependencies. To run a command in a package, use the following syntax: `pnpm nx run <task> <package>`. For example, to run the unit tests in the `eslint-plugin` package, use the following command:
 
 ```bash
-pnpm nx test:unit eslint-plugin-boundaries
+pnpm nx test:unit eslint-plugin
 ```
 
 > ![TIP]
@@ -86,7 +100,7 @@ Some important points to consider:
    * It is long-lived because we also have bots that will open PRs. So, they can be configured to open PRs to the "release" branch, and their changes will also enter in the process of preparing the release, such as changes from any other contributor.
 * __The "release" branch is the default branch for PRs.__ Only a project maintainer should open a PR to the "main" branch, and only when the release is ready to be published.
 * Usually, feature branches should be short-lived, and they should be merged into the "release" branch as soon as possible. This way, the changes will be included in the next release, and the feature branch can be deleted.
-* When necessary, a medium-lived branch can be created from the "release" branch to group changes that will be released together and require more time to be prepared. Once the changes are ready, the branch can be merged into the "release" branch.
+* When necessary, a medium-lived branch can be created from the "release" branch to group changes that will be released together and require more time to be prepared, such as `release-<version>`. Once the changes are ready, the branch can be merged into the "release" branch.
 * For publishing beta versions or fix versions of precedent releases, medium-lived branches should be also created from the "release" branch. A branch naming convention should be followed in order to identify these branches easily. For example:
    * `release-X.Y.Z-beta.N`: For beta versions of the next release.
 
@@ -99,7 +113,7 @@ We use the __squash and merge strategy for merging PRs to the release branch__.
 
 But we use the __merge commit strategy for merging PRs to the main branch from the release branch__. The reasons are:
 
-* To keep in the history the information about the features that were merged separately into the release branch. This is very important, because we may have changes from different packages in the release branch. Squashing all the changes into a single commit would make it difficult to understand or revert the changes for a specific package.
+* To keep in the history the information about the features that were merged separately into the release branch. This is very important, because we may have changes from different packages in the release branch, or from features that are not related. Squashing all the changes into a single commit would make it difficult to understand or revert the changes for a specific package or feature.
 * To avoid having to rebase the release branch every time a PR is merged to the main branch.
 
 # Pull Request

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: javierbrea

.github/actions/install/action.yml

@@ -5,6 +5,10 @@ inputs:
   node-version:
     description: The Node.js version to use
     required: true
+  windows-fix-symlinks:
+    description: Whether to apply Windows-specific PNPM symlink fixes
+    required: false
+    default: 'false'
 
 runs:
   using: composite
@@ -24,7 +28,13 @@ runs:
       uses: actions/cache@v4
       with:
         path: node_modules
-        key: pnpm-${{ hashFiles('pnpm-lock.yaml') }}
+        key: pnpm-windows-${{ hashFiles('pnpm-lock.yaml') }}
+
+    - name: Fix PNPM symlinks on Windows
+      if: ${{ inputs.windows-fix-symlinks == 'true' }}
+      shell: bash
+      run: |
+        pnpm config set node-linker hoisted
 
     - name: Install Node.js dependencies
       shell: bash

.github/workflows/build.yml

@@ -4,11 +4,13 @@ on:
     branches:
       - master
       - release
-      - refactor/monorepo
+      - release-v*
   pull_request:
+
 concurrency:  
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
+
 jobs:
   check-root:
     runs-on: ubuntu-latest
@@ -33,62 +35,99 @@ jobs:
       - uses: ./.github/actions/install
         with:
           node-version: ${{ matrix.node }}
-      # NOTE: For the moment, we run the check:all target in all packages instead of running affected check in affected packages only
-      - name: Check all
-        if: ${{ matrix.node == '22.14.0' }}
-        run: pnpm nx run-many --target=check:all --all --output-style=stream --parallel=1
       # NOTE: In other Node versions, we only run unit tests to save time in the CI and to avoid dev tools Node incompatibilities
       - name: Test Unit
         if: ${{ matrix.node != '22.14.0' }}
         run: pnpm nx run-many --target=test:unit --all
-      - name: Upload test results
+      # NOTE: For the moment, we run the check:all target in all packages instead of running affected check in affected packages only
+      - name: Check all
+        if: ${{ matrix.node == '22.14.0' }}
+        run: pnpm nx run-many --target=check:all --all --output-style=stream --parallel=1
+      - name: Upload elements test results
+        if: ${{ matrix.node == '22.14.0' }}
         uses: actions/upload-artifact@v4
         with:
-          name: coverage-${{ matrix.node }}
-          path: packages/eslint-plugin-boundaries/coverage
+          name: elements-coverage
+          path: packages/elements/coverage
+          retention-days: 1
+      - name: Upload eslint-plugin test results
+        if: ${{ matrix.node == '22.14.0' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: eslint-plugin-coverage
+          path: packages/eslint-plugin/coverage
+          retention-days: 1
+      - name: Upload elements build
+        if: ${{ matrix.node == '22.14.0' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: elements-build
+          path: packages/elements/dist
           retention-days: 1
   build-windows:
     runs-on: windows-2022
-    strategy:
-      matrix:
-        node: ["18.20.3", "20.13.1", "22.14.0"]
+    needs: build
     steps:
       - name: Checkout
         uses: actions/checkout@v4
       - uses: ./.github/actions/install
         with:
-          node-version: ${{ matrix.node }}
-      - name: Check all
-        if: ${{ matrix.node == '22.14.0' }}
-        run: pnpm nx run-many --target=check:all --all
-      # NOTE: In other Node versions, we only run unit tests to save time in the CI and to avoid dev tools Node incompatibilities
-      - name: Test Unit
-        if: ${{ matrix.node != '22.14.0' }}
-        run: pnpm nx run-many --target=test:unit --all
+          node-version: "22.14.0"
+          windows-fix-symlinks: "true"
+      - name: Download elements build
+        uses: actions/download-artifact@v4
+        with:
+          name: elements-build
+          path: packages/elements/dist
+      - name: Test Unit ESLint Plugin
+        working-directory: ./packages/eslint-plugin
+        run: pnpm test:unit
   reports:
     runs-on: ubuntu-latest
     needs: build
+    env:
+      SONAR_TOKEN_ELEMENTS: ${{ secrets.SONAR_TOKEN_ELEMENTS }}
+      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Download test results
+      - name: Download elements test results
+        uses: actions/download-artifact@v4
+        with:
+          name: elements-coverage
+          path: packages/elements/coverage
+      - name: Download eslint-plugin test results
         uses: actions/download-artifact@v4
         with:
-          name: coverage-22.14.0
-          path: packages/eslint-plugin-boundaries/coverage
-      - name: Coveralls
+          name: eslint-plugin-coverage
+          path: packages/eslint-plugin/coverage
+      - name: Coveralls for Elements
         uses: coverallsapp/github-action@v2
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          base-path: packages/eslint-plugin-boundaries
-      # TODO: Configure sonarcloud for monorepo
-      - name: SonarCloud Scan
+          path-to-lcov: ./packages/elements/coverage/lcov.info
+          flag-name: elements
+      - name: Coveralls for Eslint Plugin
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: ./packages/eslint-plugin/coverage/lcov.info
+          flag-name: eslint-plugin
+      - name: SonarCloud Scan - Elements
+        if: env.SONAR_TOKEN_ELEMENTS != ''
+        uses: SonarSource/sonarqube-scan-action@v6
+        with:
+          projectBaseDir: packages/elements
+        env:
+         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+         SONAR_TOKEN: ${{ secrets.SONAR_TOKEN_ELEMENTS }}
+      - name: SonarCloud Scan - Eslint Plugin
         if: env.SONAR_TOKEN != ''
-        uses: sonarsource/sonarcloud-github-action@master
+        uses: SonarSource/sonarqube-scan-action@v6
         with:
-          projectBaseDir: packages/eslint-plugin-boundaries
+          projectBaseDir: packages/eslint-plugin
         env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.github/workflows/publish-beta.yml

@@ -33,11 +33,11 @@ jobs:
       env:
         HUSKY_SKIP_INSTALL: 1
 
-    - run: pnpm nx run-many -t check:all --all
+    - run: pnpm check:all
 
     - uses: MerthinTechnologies/edit-json-action@v1
       with:
-        filename: './packages/eslint-plugin-boundaries/package.json'
+        filename: './packages/eslint-plugin/package.json'
         key: 'name'
         value: '@javierbrea/eslint-plugin-boundaries'
 

.github/workflows/publish-to-github.yml

@@ -2,15 +2,49 @@ name: publish-to-npm
 on:
   release:
     types: [created]
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
 jobs:
   publish:
     runs-on: ubuntu-latest
     if: contains(github.event.release.target_commitish, '-beta.') == false
     steps:
     - uses: actions/checkout@v4
     - uses: ./.github/actions/install
-    - run: pnpm nx run-many -t check:all --all
+    - run: pnpm check:all
     - run: pnpm -r publish --no-git-checks
       env:
         NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+    - uses: MerthinTechnologies/edit-json-action@v1
+      with:
+        filename: './packages/eslint-plugin/package.json'
+        key: 'name'
+        value: 'eslint-plugin-boundaries'
+    - run: pnpm -r publish --no-git-checks
+      env:
+        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  publish-beta:
+    runs-on: ubuntu-latest
+    if: contains(github.event.release.target_commitish, 'release-') && contains(github.event.release.target_commitish, '-beta.')
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ./.github/actions/install
+    - run: pnpm check:all
+    - run: pnpm -r publish --no-git-checks --tag beta
+      env:
+        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+    - uses: MerthinTechnologies/edit-json-action@v1
+      with:
+        filename: './packages/eslint-plugin/package.json'
+        key: 'name'
+        value: 'eslint-plugin-boundaries'
+    - run: pnpm -r publish --no-git-checks --tag beta
+      env:
+        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Test Mutation
+on:
+  push:
+    branches:
+      - master
+      - release
+  pull_request:
+    branches:
+      - master
+
+concurrency:  
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-mutation:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: ./.github/actions/install
+        with:
+          node-version: 22.14.0
+      - name: Test Mutation Elements
+        run: pnpm nx test:mutation elements
+        env:
+          STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}
+      - name: Upload test mutation report for elements
+        uses: actions/upload-artifact@v4
+        with:
+          name: report-test-mutation-elements
+          path: packages/elements/reports/mutation
+          retention-days: 1

.github/workflows/test-mutation.yml

@@ -5,6 +5,6 @@
   },
   "sonarlint.connectedMode.project": {
     "connectionId": "javierbrea",
-    "projectKey": "javierbrea_eslint-plugin-boundaries"
+    "projectKey": "javierbrea_eslint-plugin-boundaries_elements"
   }
 }

.vscode/settings.json

@@ -320,6 +320,18 @@ You can also provide an absolute path in the environment variable, but it may be
 
 </details>
 
+#### __`boundaries/cache`__
+
+Enable or disable the cache mechanism used to boost performance. By default, it is enabled. We recommend to keep it enabled unless you experience issues. In such case, please, open an issue describing the problem.
+
+```js
+export default [{
+  settings: {
+    "boundaries/cache": true // or false to disable the cache
+  }
+}]
+```
+
 ### Predefined configurations
 
 The plugin is distributed with two different predefined configurations: "recommended" and "strict".