BREAKING: Update dependencies, fix code style, and standardise workflows #139
Conversation
This commit adds/updates various configuration files in the project, including updating the `nvmrc` node version to the latest LTS, changing branch protection to default `main` branch, and adding an access field to the `package.json` for publishing under the `@metamask` scope. The linting configuration changes will ignore some new directories in certain files to make the tests pass. The TypeScript changes updates the `tsconfig.build.json` to improve building process, and make the project ready for documentation generation using `typedoc`.
This change updates the matrix of the build-lint-test.yml Github Actions workflow to only use Node.js 16.x, 18.x and 19.x.
|
@Mrtenz does the breakage actually break the package being able to run on v14, or is it just us officially saying "we don't do v14 issue support anymore" |
It actually breaks the package for Node.js 14, as I've updated the requirement in |
| "engines": { | ||
| "node": ">=14.0.0" | ||
| "node": ">=16.0.0" |
There was a problem hiding this comment.
Should we hold off on bumping this? Mobile still uses Node 14, and we haven't bumped the Node version across libraries yet (I'm guessing for that reason). Although it sounds like based on a thread in #metamask-dev that mobile is working on this. @Gudahtt do you know anything about this? Also forgive me if there's context I'm missing for this PR.
There was a problem hiding this comment.
We want to start bumping all packages to Node 16 since 14 is EOL at the end of April (if not now, then in a few weeks).
Since this package is rarely updated it seems fine to me to update it even if mobile can't use the changes instantly (bumping core for example would be a different story). Regardless though, from what Mark told me, mobile is a few weeks away from having Node 16.
There was a problem hiding this comment.
Ah okay. Gotcha. That makes sense then. Just wanted to make sure no one was surprised by this. I agree that this package isn't updated that often. We are about to replace web3-provider-engine with json-rpc-engine and friends in core, but we can certainly use the existing version for the time being as it does serve our purpose fine and then upgrade later when we bump all the core packages to Node 16.
v1.0.1 contains two changes that should have been considered semver-major: - Type-interface -incompatability with previous version (MetaMask/json-rpc-engine#139) - Introduced dependency `@metamask/json-rpc-engine` indicates a minimum supported Node.js version of 16. This prevents the module from installing on some package manager configurations, like default yarn classic. This will bere-released as v2.0.0.
v1.0.1 contains two changes that should have been considered semver-major: - Type-interface -incompatability with previous version (MetaMask/json-rpc-engine#139) - Introduced dependency `@metamask/json-rpc-engine` indicates a minimum supported Node.js version of 16. This prevents the module from installing on some package manager configurations, like default yarn classic. This will be re-released as v2.0.0.
v1.0.1 contains two changes that should have been considered semver-major: - Type-interface incompatability with previous version (MetaMask/json-rpc-engine#139) - Introduced dependency `@metamask/json-rpc-engine` indicates a minimum supported Node.js version of 16. This prevents the module from installing on some package manager configurations, like default yarn classic. This will be re-released as v2.0.0.
v1.0.1 contains two changes that should have been considered semver-major: - Type-interface incompatability with previous version (MetaMask/json-rpc-engine#139) - Introduced dependency `@metamask/json-rpc-engine` indicates a minimum supported Node.js version of 16. This prevents the module from installing on some package manager configurations, like default yarn classic. This will be re-released as v2.0.0.
v1.0.1 contains two changes that should have been considered semver-major: - Type-interface incompatability with previous version (MetaMask/json-rpc-engine#139) - Introduced dependency `@metamask/json-rpc-engine` indicates a minimum supported Node.js version of 16. This prevents the module from installing on some package manager configurations, like default yarn classic. This will be re-released as v2.0.0.
v1.0.1 contains two changes that should have been considered semver-major: - Type-interface incompatability with previous version (MetaMask/json-rpc-engine#139) - Introduced dependency `@metamask/json-rpc-engine` indicates a minimum supported Node.js version of 16. This prevents the module from installing on some package manager configurations, like default yarn classic. This will be re-released as v2.0.0.
Description
This pull request standardises the entire repository according to our latest module template.
Changes
Yarnto v3package.jsonfor publishing under the@metamaskscopetsconfig.build.jsonfile to improve the building process and make the project ready for documentation generation usingtypedoc.