Merge pull request #2196 from ember-cli/switch-to-pnpm

Switch to pnpm + vitest (away from yarn @ 1 and jest)

Author: NullVoxPopuli

.github/workflows/ci.yml

@@ -10,28 +10,39 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
+  self-lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: pnpm/action-setup@v4
+      with:
+        run_install: false
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 22.x
+        cache: 'pnpm'
+
+    - run: pnpm install
+    - run: pnpm lint
 
+  build:
     runs-on: ${{ matrix.os }}-latest
 
     strategy:
       matrix:
         os: [ ubuntu, windows ]
-        node-version: [18.x, 20.x, 21.x]
+        node-version: [18.x, 20.x, 22.x]
 
     steps:
     - uses: actions/checkout@v4
-
+    - uses: pnpm/action-setup@v4
+      with:
+        run_install: false
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-        cache: 'yarn'
-
-    - run: yarn install --frozen-lockfile --non-interactive
-
-    - run: yarn lint
-
-    - run: yarn update && git diff --exit-code
+        cache: 'pnpm'
 
-    - run: yarn test:coverage --runInBand
+    - run: pnpm install
+    - run: pnpm test:coverage

.npmrc

@@ -0,0 +1,9 @@
+# npm / pnpm settings here
+
+# as a library, we want to make sure we explicitly handle peers,
+# and not rely on hidden behavior of package-managers.
+auto-install-peers=false
+strict-peer-dependents=true
+dedupe-peer-dependents=true
+prefer-workspaces-packages=true
+resolve-peers-from-workspace-root=false

README.md

@@ -15,12 +15,6 @@
 
 ### 1. Install plugin
 
-```shell
-yarn add --dev eslint-plugin-ember
-```
-
-Or
-
 ```shell
 npm install --save-dev eslint-plugin-ember
 ```
@@ -178,7 +172,7 @@ rules in templates can be disabled with eslint directives with mustache or html
 ![gjs logo](/docs/svgs/gjs.svg) Set in the `recommended-gjs` [configuration](https://github.com/ember-cli/eslint-plugin-ember#-configurations).\
 ![gts logo](/docs/svgs/gts.svg) Set in the `recommended-gts` [configuration](https://github.com/ember-cli/eslint-plugin-ember#-configurations).\
 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
-💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 ### Components
 
@@ -354,10 +348,10 @@ If you have any suggestions, ideas, or problems, feel free to [create an issue](
   - `lib/rules/new-rule.js` (implementation, see [no-proxies](lib/rules/no-proxies.js) for an example)
   - `docs/rules/new-rule.md` (documentation, start from the template -- [raw](https://raw.githubusercontent.com/ember-cli/eslint-plugin-ember/master/docs/rules/_TEMPLATE_.md), [rendered](docs/rules/_TEMPLATE_.md))
   - `tests/lib/rules/new-rule.js` (tests, see [no-proxies](tests/lib/rules/no-proxies.js) for an example)
-- Run `yarn update` to automatically update the README and other files (and re-run this if you change the rule name or description)
+- Run `pnpm update` to automatically update the README and other files (and re-run this if you change the rule name or description)
 - Make sure your changes will pass [CI](./.github/workflows/ci.yml) by running:
-  - `yarn test`
-  - `yarn lint` (`yarn lint:js --fix` can fix many errors)
+  - `pnpm test`
+  - `pnpm lint` (`pnpm lint:js --fix` can fix many errors)
 - Create a PR and link the created issue in the description
 
 Note that new rules should not immediately be added to the [recommended](./lib/recommended-rules.js) configuration, as we only consider such breaking changes during major version updates.

RELEASE.md

@@ -8,4 +8,4 @@
 
 4. `export EDITOR="vim"` to choose an editor for editing the changelog
 
-5. `yarn release` (uses [@release-it-plugins/lerna-changelog](https://github.com/release-it-plugins/lerna-changelog) to handle versioning, the changelog, publishing to GitHub and NPM, etc)
+5. `pnpm release` (uses [@release-it-plugins/lerna-changelog](https://github.com/release-it-plugins/lerna-changelog) to handle versioning, the changelog, publishing to GitHub and NPM, etc)

docs/rules/no-unused-services.md

@@ -1,6 +1,6 @@
 # ember/no-unused-services
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

docs/rules/route-path-style.md

@@ -1,6 +1,6 @@
 # ember/route-path-style
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

eslint.config.js

@@ -5,7 +5,6 @@ const js = require('@eslint/js');
 const babelEslintParser = require('@babel/eslint-parser');
 const eslintPluginEslintPluginAll = require('eslint-plugin-eslint-plugin/configs/all');
 const eslintPluginFilenames = require('eslint-plugin-filenames');
-const eslintPluginJest = require('eslint-plugin-jest');
 const eslintPluginMarkdown = require('eslint-plugin-markdown');
 const eslintPluginN = require('eslint-plugin-n');
 const eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended');
@@ -33,23 +32,10 @@ module.exports = [
   eslintPluginN.configs['flat/recommended'],
   eslintPluginUnicorn.configs['flat/recommended'],
 
-  {
-    ignores: [
-      'coverage/',
-      'node_modules/',
-      'lib/recommended-rules.js',
-      'lib/recommended-rules-gjs.js',
-      'lib/recommended-rules-gts.js',
-      'tests/__snapshots__/',
-
-      // # Contains <template> in js markdown
-      'docs/rules/no-empty-glimmer-component-classes.md',
-      'docs/rules/template-no-let-reference.md',
-    ],
-  },
   {
     languageOptions: {
       parser: babelEslintParser,
+      sourceType: 'script',
       parserOptions: {
         ecmaVersion: 2022,
         sourceType: 'script',
@@ -153,6 +139,8 @@ module.exports = [
       'import/no-webpack-loader-syntax': 'error',
       'import/unambiguous': 'error',
 
+      'n/no-unsupported-features/node-builtins': 'off',
+
       // Unicorn rules:
       'unicorn/no-array-callback-reference': 'off',
       'unicorn/no-array-method-this-argument': 'off',
@@ -168,29 +156,7 @@ module.exports = [
   {
     // Test files:
     files: ['**/*.js', '**/*.js.snap'],
-    plugins: { jest: eslintPluginJest },
-    rules: {
-      ...eslintPluginJest.configs.recommended.rules,
-      ...eslintPluginJest.configs.style.rules,
-
-      // Optional jest rules:
-      'jest/consistent-test-it': 'error',
-      'jest/no-duplicate-hooks': 'error',
-      'jest/no-hooks': 'error',
-      'jest/no-if': 'error',
-      'jest/no-large-snapshots': 'error',
-      'jest/no-restricted-matchers': 'error',
-      'jest/no-test-return-statement': 'error',
-      'jest/prefer-called-with': 'error',
-      'jest/prefer-hooks-on-top': 'error',
-      'jest/prefer-lowercase-title': 'error',
-      'jest/prefer-spy-on': 'error',
-      'jest/prefer-strict-equal': 'error',
-      'jest/prefer-todo': 'error',
-      'jest/require-to-throw-message': 'error',
-      'jest/require-top-level-describe': 'error',
-      'jest/valid-title': 'error',
-    },
+    plugins: {},
     languageOptions: {
       globals: {
         ...globals.jest,
@@ -206,6 +172,7 @@ module.exports = [
     // Markdown code samples in documentation:
     files: ['**/*.md/*.js'],
     languageOptions: {
+      sourceType: 'module',
       parserOptions: {
         sourceType: 'module',
         ecmaFeatures: { legacyDecorators: true },
@@ -216,10 +183,6 @@ module.exports = [
       'filenames/match-regex': 'off',
       'import/no-unresolved': 'off',
       'import/unambiguous': 'off',
-      'jest/expect-expect': 'off',
-      'jest/no-done-callback': 'off',
-      'jest/no-test-callback': 'off',
-      'jest/require-top-level-describe': 'off',
       'n/no-extraneous-import': 'off',
       'n/no-missing-import': 'off',
       'n/no-missing-require': 'off',
@@ -259,6 +222,23 @@ module.exports = [
       'import/no-named-as-default-member': 'off',
       'import/no-unresalved': 'off',
       'import/no-missing-import': 'off',
+
+      // vite config format does not match regex
+      'filenames/match-regex': 'off',
     },
   },
+  {
+    ignores: [
+      'coverage/',
+      'node_modules/',
+      'lib/recommended-rules.js',
+      'lib/recommended-rules-gjs.js',
+      'lib/recommended-rules-gts.js',
+      'tests/__snapshots__/',
+
+      // # Contains <template> in js markdown
+      'docs/rules/no-empty-glimmer-component-classes.md',
+      'docs/rules/template-no-let-reference.md',
+    ],
+  },
 ];

lib/rules/no-get.js

@@ -224,7 +224,7 @@ module.exports = {
       );
     }
 
-    let currentProxyObject = null;
+    const proxyObjects = [];
     let currentClassWithUnknownPropertyMethod = null;
 
     let importedGetName;
@@ -251,17 +251,17 @@ module.exports = {
       },
 
       'CallExpression:exit'(node) {
-        if (currentProxyObject === node) {
-          currentProxyObject = null;
+        if (proxyObjects.at(-1) === node) {
+          proxyObjects.pop();
         }
         if (currentClassWithUnknownPropertyMethod === node) {
           currentClassWithUnknownPropertyMethod = null;
         }
       },
 
       'ClassDeclaration:exit'(node) {
-        if (currentProxyObject === node) {
-          currentProxyObject = null;
+        if (proxyObjects.at(-1) === node) {
+          proxyObjects.pop();
         }
         if (currentClassWithUnknownPropertyMethod === node) {
           currentClassWithUnknownPropertyMethod = null;
@@ -270,7 +270,7 @@ module.exports = {
 
       ClassDeclaration(node) {
         if (emberUtils.isEmberProxy(context, node)) {
-          currentProxyObject = node; // Keep track of being inside a proxy object.
+          proxyObjects.push(node); // Keep track of being inside a proxy object.
         }
         if (emberUtils.isEmberObjectImplementingUnknownProperty(node, scopeManager)) {
           currentClassWithUnknownPropertyMethod = node; // Keep track of being inside an object implementing `unknownProperty`.
@@ -284,12 +284,12 @@ module.exports = {
         // **************************
 
         if (emberUtils.isEmberProxy(context, node)) {
-          currentProxyObject = node; // Keep track of being inside a proxy object.
+          proxyObjects.push(node); // Keep track of being inside a proxy object.
         }
         if (emberUtils.isEmberObjectImplementingUnknownProperty(node, scopeManager)) {
           currentClassWithUnknownPropertyMethod = node;
         }
-        if (currentProxyObject || currentClassWithUnknownPropertyMethod) {
+        if (proxyObjects.at(-1) || currentClassWithUnknownPropertyMethod) {
           // Proxy objects and objects implementing `unknownProperty()`
           // still require using `get()`, so ignore any code inside them.
           return;

package.json

@@ -40,40 +40,24 @@
     "changelog": "lerna-changelog",
     "lint": "npm-run-all --continue-on-error --aggregate-output --parallel \"lint:!(fix)\"",
     "lint:docs": "markdownlint \"**/*.md\"",
-    "lint:docs:fix": "npm-run-all \"lint:docs -- --fix\"",
-    "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
+    "lint:docs:fix": "pnpm lint:docs --fix",
+    "lint:eslint-docs": "pnpm update:eslint-docs --check",
     "lint:eslint-docs:fix": "npm-run-all \"update:eslint-docs\"",
     "lint:fix": "npm-run-all \"lint:*:fix\"",
-    "lint:js": "eslint --cache .",
-    "lint:js:fix": "npm-run-all \"lint:js -- --fix\"",
+    "lint:js": "eslint .",
+    "lint:js:fix": "pnpm lint:js --fix",
     "lint:package-json": "npmPkgJsonLint .",
     "lint:package-json-sorting": "sort-package-json --check",
     "lint:package-json-sorting:fix": "sort-package-json package.json",
     "lint:remote": "eslint-remote-tester",
     "release": "release-it",
-    "start": "yarn run test:watch",
-    "test": "jest",
-    "test:coverage": "jest --coverage",
-    "test:watch": "jest --watchAll",
+    "start": "pnpm test:watch",
+    "test": "vitest run",
+    "test:coverage": "vitest --coverage",
+    "test:watch": "vitest",
     "update": "node ./scripts/update-rules.js && node ./scripts/list-jquery-methods.js && npm-run-all update:eslint-docs",
     "update:eslint-docs": "eslint-doc-generator"
   },
-  "jest": {
-    "coverageThreshold": {
-      "global": {
-        "branches": 95,
-        "functions": 98.95,
-        "lines": 98,
-        "statements": 98
-      }
-    },
-    "testMatch": [
-      "**/tests/**/*.js"
-    ],
-    "testPathIgnorePatterns": [
-      "<rootDir>/tests/helpers/"
-    ]
-  },
   "dependencies": {
     "@ember-data/rfc395-data": "^0.0.4",
     "css-tree": "^2.3.1",
@@ -87,6 +71,7 @@
     "snake-case": "^3.0.3"
   },
   "devDependencies": {
+    "@babel/core": "^7.25.9",
     "@babel/eslint-parser": "^7.22.15",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@babel/plugin-proposal-decorators": "^7.23.2",
@@ -95,21 +80,20 @@
     "@release-it-plugins/lerna-changelog": "^6.0.0",
     "@types/eslint": "^8.44.6",
     "@typescript-eslint/parser": "^7.0.1",
+    "@vitest/coverage-v8": "^2.1.3",
     "eslint": "^8.55.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-doc-generator": "^1.5.3",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-eslint-plugin": "^5.1.1",
     "eslint-plugin-filenames": "^1.3.2",
     "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-jest": "^27.8.0",
     "eslint-plugin-markdown": "^3.0.1",
-    "eslint-plugin-n": "^16.2.0",
+    "eslint-plugin-n": "^17.11.1",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-unicorn": "^51.0.0",
     "eslint-remote-tester": "^3.0.1",
     "globals": "^14.0.0",
-    "jest": "^29.7.0",
     "jquery": "^3.7.1",
     "jsdom": "^24.0.0",
     "markdownlint-cli": "^0.39.0",
@@ -119,7 +103,9 @@
     "release-it": "^17.0.0",
     "sort-package-json": "^2.6.0",
     "typescript": "^5.2.2",
-    "typescript-eslint": "^8.7.0"
+    "typescript-eslint": "^8.7.0",
+    "vite": "^5.4.9",
+    "vitest": "^2.1.3"
   },
   "peerDependencies": {
     "@typescript-eslint/parser": "*",
@@ -130,12 +116,13 @@
       "optional": true
     }
   },
+  "packageManager": "[email protected]",
   "engines": {
     "node": "18.* || 20.* || >= 21"
   },
   "volta": {
-    "node": "21.5.0",
-    "yarn": "1.22.21"
+    "node": "22.10.0",
+    "pnpm": "9.12.2"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"