Implement JavaScript-based constraints (#220)

* Implement JavaScript-based constraints

* Add more constraints for README.md and pull_request_template.md

* Update constraints to match latest module template

* Use latest version of Yarn

* Check if types export is the first

* Fix linting of Yarn config

* Revert change to ESLint config files

* Update `files` constraint

* Get workspace name from Yarn identifier instead of folder name

* Fix jsdoc

.depcheckrc.json

@@ -4,6 +4,7 @@
     "@lavamoat/preinstall-always-fail",
     "@metamask/auto-changelog",
     "@types/*",
+    "@yarnpkg/types",
     "prettier-plugin-packagejson",
     "ts-node",
     "typedoc"

.eslintrc.js

@@ -17,6 +17,20 @@ module.exports = {
       extends: ['@metamask/eslint-config-nodejs'],
     },
 
+    {
+      files: ['yarn.config.cjs'],
+      parserOptions: {
+        sourceType: 'script',
+        ecmaVersion: 2020,
+      },
+      settings: {
+        jsdoc: {
+          mode: 'typescript',
+        },
+      },
+      extends: ['@metamask/eslint-config-nodejs'],
+    },
+
     {
       files: ['*.test.ts', '*.test.js'],
       extends: [

.yarnrc.yml

@@ -1,3 +1,7 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
 enableScripts: false
 
 enableTelemetry: 0
@@ -11,7 +15,5 @@ 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"
-  - path: .yarn/plugins/@yarnpkg/plugin-constraints.cjs
-    spec: "@yarnpkg/plugin-constraints"
 
-yarnPath: .yarn/releases/yarn-3.2.1.cjs
+yarnPath: .yarn/releases/yarn-4.1.1.cjs

README.md

@@ -26,11 +26,11 @@ Follow these instructions when using this template.
 
 ## Installation
 
-`yarn add @metamask/this-module`
+`yarn add @metamask/metamask-module-template`
 
 or
 
-`npm install @metamask/this-module`
+`npm install @metamask/metamask-module-template`
 
 ## Usage
 

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@metamask/module-template",
+  "name": "@metamask/metamask-module-template",
   "version": "0.0.0",
   "description": "The MetaMask Node module template",
   "homepage": "https://github.com/MetaMask/metamask-module-template#readme",
@@ -13,9 +13,9 @@
   "sideEffects": false,
   "exports": {
     ".": {
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/types/index.d.ts"
+      "require": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -33,7 +33,7 @@
     "lint:changelog": "auto-changelog validate --prettier",
     "lint:constraints": "yarn constraints",
     "lint:dependencies": "depcheck && yarn dedupe",
-    "lint:eslint": "eslint . --cache --ext js,ts",
+    "lint:eslint": "eslint . --cache --ext js,cjs,ts",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:constraints --fix && yarn lint:misc --write && yarn lint:dependencies && yarn lint:changelog",
     "lint:misc": "prettier '**/*.json' '**/*.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "prepack": "./scripts/prepack.sh",
@@ -52,6 +52,7 @@
     "@types/node": "^16",
     "@typescript-eslint/eslint-plugin": "^5.43.0",
     "@typescript-eslint/parser": "^5.43.0",
+    "@yarnpkg/types": "^4.0.0-rc.52",
     "depcheck": "^1.4.3",
     "eslint": "^8.44.0",
     "eslint-config-prettier": "^8.8.0",
@@ -71,7 +72,7 @@
     "typedoc": "^0.23.15",
     "typescript": "~4.8.4"
   },
-  "packageManager": "yarn@3.2.1",
+  "packageManager": "yarn@4.1.1",
   "engines": {
     "node": "^18.18 || >=20"
   },