refactor!: Synchronize dev toolchain with module template and core monorepo

.depcheckrc.json

@@ -0,0 +1,22 @@
+{
+  "ignores": [
+    "@arethetypeswrong/cli",
+    "@lavamoat/allow-scripts",
+    "@lavamoat/preinstall-always-fail",
+    "@metamask/auto-changelog",
+    "@metamask/eslint-config",
+    "@metamask/eslint-config-*",
+    "@types/*",
+    "@typescript-eslint/utils",
+    "@vitest/coverage-istanbul",
+    "@vitest/eslint-plugin",
+    "@yarnpkg/types",
+    "eslint-config-*",
+    "eslint-import-resolver-typescript",
+    "eslint-plugin-*",
+    "prettier-plugin-packagejson",
+    "ts-node",
+    "typedoc",
+    "typescript-eslint"
+  ]
+}

.gitattributes

@@ -1,3 +1,8 @@
 * text=auto
 
 yarn.lock linguist-generated=false
+
+# yarn v3
+# See: https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
+/.yarn/releases/** binary
+/.yarn/plugins/** binary

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+<!--
+Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes:
+
+* What is the current state of things and why does it need to change?
+* What is the solution your changes offer and how does it work?
+
+Are there any issues or other links reviewers should consult to understand this pull request better? For instance:
+
+* Fixes #12345
+* See: #67890
+-->

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 dist/
 coverage/
+docs/
 
 # Logs
 logs

.prettierrc.js → .prettierrc.mjs

@@ -1,8 +1,11 @@
 // All of these are defaults except singleQuote, but we specify them
 // for explicitness
-module.exports = {
+const config = {
   quoteProps: 'as-needed',
   singleQuote: true,
   tabWidth: 2,
   trailingComma: 'all',
+  plugins: ['prettier-plugin-packagejson'],
 };
+
+export default config;

.yarnrc.yml

@@ -14,4 +14,4 @@ nodeLinker: node-modules
 
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-allow-scripts.cjs
-    spec: 'https://raw.githubusercontent.com/LavaMoat/LavaMoat/main/packages/yarn-plugin-allow-scripts/bundles/@yarnpkg/plugin-allow-scripts.js'
+    spec: "https://raw.githubusercontent.com/LavaMoat/LavaMoat/main/packages/yarn-plugin-allow-scripts/bundles/@yarnpkg/plugin-allow-scripts.js"

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** Distribute separate CommonJS and ESM files ([#351](https://github.com/MetaMask/eth-block-tracker/pull/351))
+  - Use the `exports` field of `package.json`, breaking some previously valid imports.
+
 ## [12.2.1]
 
 ### Fixed

README.md

@@ -106,35 +106,28 @@ Run `yarn lint` to run the linter, or run `yarn lint:fix` to run the linter and
 The project follows the same release process as the other libraries in the MetaMask organization. The GitHub Actions [`action-create-release-pr`](https://github.com/MetaMask/action-create-release-pr) and [`action-publish-release`](https://github.com/MetaMask/action-publish-release) are used to automate the release process; see those repositories for more information about how they work.
 
 1. Choose a release version.
-
    - The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See [the SemVer specification](https://semver.org/) for more information.
 
 2. If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g. `1.x` for a `v1` backport release).
-
    - The major version branch should be set to the most recent release with that major version. For example, when backporting a `v1.0.2` release, you'd want to ensure there was a `1.x` branch that was set to the `v1.0.1` tag.
 
 3. Trigger the [`workflow_dispatch`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch) event [manually](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow) for the `Create Release Pull Request` action to create the release PR.
-
    - For a backport release, the base branch should be the major version branch that you ensured existed in step 2. For a normal release, the base branch should be the main branch for that repository (which should be the default value).
    - This should trigger the [`action-create-release-pr`](https://github.com/MetaMask/action-create-release-pr) workflow to create the release PR.
 
 4. Update the changelog to move each change entry into the appropriate change category ([See here](https://keepachangelog.com/en/1.0.0/#types) for the full list of change categories, and the correct ordering), and edit them to be more easily understood by users of the package.
-
    - Generally any changes that don't affect consumers of the package (e.g. lockfile changes or development environment changes) are omitted. Exceptions may be made for changes that might be of interest despite not having an effect upon the published package (e.g. major test improvements, security improvements, improved documentation, etc.).
    - Try to explain each change in terms that users of the package would understand (e.g. avoid referencing internal variables/concepts).
    - Consolidate related changes into one change entry if it makes it easier to explain.
    - Run `yarn auto-changelog validate --rc --prettier` to check that the changelog is correctly formatted.
 
 5. Review and QA the release.
-
    - If changes are made to the base branch, the release branch will need to be updated with these changes and review/QA will need to restart again. As such, it's probably best to avoid merging other PRs into the base branch while review is underway.
 
 6. Squash & Merge the release.
-
    - This should trigger the [`action-publish-release`](https://github.com/MetaMask/action-publish-release) workflow to tag the final release commit and publish the release on GitHub.
 
 7. Publish the release on npm.
-
    - Be very careful to use a clean local environment to publish the release, and follow exactly the same steps used during CI.
    - Use `npm publish --dry-run` to examine the release contents to ensure the correct files are included. Compare to previous releases if necessary (e.g. using `https://unpkg.com/browse/[package name]@[package version]/`).
    - Once you are confident the release contents are correct, publish the release using `npm publish`.

eslint.config.mjs

@@ -0,0 +1,60 @@
+import base, { createConfig } from '@metamask/eslint-config';
+import jest from '@metamask/eslint-config-jest';
+import nodejs from '@metamask/eslint-config-nodejs';
+import typescript from '@metamask/eslint-config-typescript';
+
+const config = createConfig([
+  {
+    ignores: ['dist/', 'docs/', '.yarn/'],
+  },
+
+  {
+    extends: base,
+
+    languageOptions: {
+      sourceType: 'module',
+      parserOptions: {
+        tsconfigRootDir: import.meta.dirname,
+        project: ['./tsconfig.json'],
+      },
+    },
+
+    settings: {
+      'import-x/extensions': ['.js', '.mjs'],
+    },
+  },
+
+  {
+    files: ['**/*.ts'],
+    extends: typescript,
+    rules: {
+      // TODO: These should perhaps be enabled
+      '@typescript-eslint/prefer-nullish-coalescing': 'off',
+      'no-restricted-syntax': 'off',
+      // TODO: Thise should definitely be enabled
+      '@typescript-eslint/naming-convention': 'warn',
+      '@typescript-eslint/unbound-method': 'warn',
+      '@typescript-eslint/consistent-type-definitions': 'warn',
+      '@typescript-eslint/explicit-function-return-type': 'warn',
+    },
+  },
+
+  {
+    files: ['**/*.js', '**/*.cjs'],
+    extends: nodejs,
+
+    languageOptions: {
+      sourceType: 'script',
+    },
+  },
+
+  {
+    files: ['./test/**/*', '**/*.test.ts', '**/*.test.js'],
+    extends: [jest, nodejs],
+    rules: {
+      'import-x/no-nodejs-modules': 'off',
+    },
+  },
+]);
+
+export default config;

jest.config.ts

@@ -137,7 +137,7 @@ const config: Config.InitialOptions = {
   // setupFiles: [],
 
   // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  setupFilesAfterEnv: ['./tests/setupAfterEnv.ts'],
+  setupFilesAfterEnv: ['./test/setupAfterEnv.ts'],
 
   // The number of seconds after which a test is considered as slow and reported as such in the results.
   // slowTestThreshold: 5,

package.json

@@ -2,66 +2,91 @@
   "name": "@metamask/eth-block-tracker",
   "version": "12.2.1",
   "description": "A block tracker for the Ethereum blockchain. Keeps track of the latest block",
+  "homepage": "https://github.com/MetaMask/eth-block-tracker#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/eth-block-tracker/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/eth-block-tracker.git"
   },
   "license": "MIT",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
   "files": [
-    "dist/"
+    "dist"
   ],
   "scripts": {
-    "build": "tsc --project tsconfig.build.json",
+    "build": "ts-bridge --project tsconfig.build.json --clean",
     "build:clean": "rimraf dist && yarn build",
-    "lint": "yarn lint:eslint && yarn lint:constraints && yarn lint:misc --check",
+    "build:docs": "typedoc",
+    "lint": "yarn lint:eslint && yarn lint:constraints && yarn lint:misc --check && yarn lint:dependencies --check && yarn lint:changelog",
+    "lint:changelog": "auto-changelog validate --prettier",
     "lint:constraints": "yarn constraints",
-    "lint:eslint": "eslint . --cache --ext js,ts",
-    "lint:fix": "yarn lint:eslint --fix && yarn lint:constraints --fix && yarn lint:misc --write",
-    "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
+    "lint:dependencies": "depcheck && yarn dedupe --check",
+    "lint:dependencies:fix": "depcheck && yarn dedupe",
+    "lint:eslint": "eslint . --cache",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:constraints --fix && yarn lint:misc --write && yarn lint:dependencies:fix && yarn lint:changelog",
+    "lint:misc": "prettier '**/*.json' '**/*.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "prepack": "./scripts/prepack.sh",
-    "test": "jest",
+    "test": "jest && attw --pack",
     "test:watch": "jest --watch"
   },
   "dependencies": {
     "@metamask/eth-json-rpc-provider": "^5.0.0",
     "@metamask/safe-event-emitter": "^3.1.1",
     "@metamask/utils": "^11.0.1",
-    "json-rpc-random-id": "^1.0.1",
-    "pify": "^5.0.0"
+    "json-rpc-random-id": "^1.0.1"
   },
   "devDependencies": {
-    "@lavamoat/allow-scripts": "^2.3.1",
-    "@metamask/auto-changelog": "^3.0.0",
-    "@metamask/eslint-config": "^12.0.0",
-    "@metamask/eslint-config-jest": "^12.0.0",
-    "@metamask/eslint-config-nodejs": "^12.0.0",
-    "@metamask/eslint-config-typescript": "^12.0.0",
+    "@arethetypeswrong/cli": "^0.15.3",
+    "@jest/types": "^27.5.1",
+    "@lavamoat/allow-scripts": "^3.0.4",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/eslint-config": "^14.0.0",
+    "@metamask/eslint-config-jest": "^14.0.0",
+    "@metamask/eslint-config-nodejs": "^14.0.0",
+    "@metamask/eslint-config-typescript": "^14.0.0",
     "@metamask/json-rpc-engine": "^10.0.0",
-    "@types/jest": "^29.1.2",
+    "@ts-bridge/cli": "^0.6.3",
+    "@types/jest": "^27.4.1",
     "@types/json-rpc-random-id": "^1.0.1",
-    "@types/node": "^18.16",
-    "@types/pify": "^5.0.1",
-    "@typescript-eslint/eslint-plugin": "^5.61.0",
-    "@typescript-eslint/parser": "^5.61.0",
-    "@yarnpkg/types": "^4.0.0",
-    "eslint": "^8.21.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-import-resolver-typescript": "^2.7.1",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jest": "^27.1.5",
-    "eslint-plugin-jsdoc": "^41.0.0",
-    "eslint-plugin-n": "^15.7.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-promise": "^6.1.1",
-    "jest": "^29.1.2",
-    "prettier": "^2.7.1",
-    "prettier-plugin-packagejson": "^2.2.11",
+    "@types/node": "^18.18",
+    "@yarnpkg/types": "^4.0.1",
+    "depcheck": "^1.4.3",
+    "eslint": "^9.11.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-import-x": "^4.3.0",
+    "eslint-plugin-jest": "^28.8.3",
+    "eslint-plugin-jsdoc": "^50.2.4",
+    "eslint-plugin-n": "^17.10.3",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-promise": "^7.1.0",
+    "jest": "^27.5.1",
+    "prettier": "^3.3.3",
+    "prettier-plugin-packagejson": "^2.5.8",
     "rimraf": "^3.0.2",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.7.0",
-    "typescript": "~4.8.4"
+    "ts-jest": "^27.1.4",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.24.8",
+    "typescript": "~5.2.2",
+    "typescript-eslint": "^8.7.0"
   },
   "packageManager": "yarn@4.5.3",
   "engines": {
@@ -73,7 +98,8 @@
   },
   "lavamoat": {
     "allowScripts": {
-      "@lavamoat/preinstall-always-fail": false
+      "@lavamoat/preinstall-always-fail": false,
+      "eslint-plugin-import-x>unrs-resolver": false
     }
   }
 }