chore: make package template a proper Yarn workspace

package.json

@@ -9,7 +9,8 @@
   },
   "workspaces": [
     "examples/*",
-    "packages/*"
+    "packages/*",
+    "scripts/create-package/package-template"
   ],
   "files": [],
   "scripts": {

scripts/create-package/constants.ts

@@ -14,7 +14,7 @@ export enum MonorepoFiles {
 export enum Placeholders {
   CurrentYear = 'CURRENT_YEAR',
   NodeVersions = 'NODE_VERSIONS',
-  PackageName = 'PACKAGE_NAME',
+  PackageName = '@metamask/package-template',
   PackageDescription = 'PACKAGE_DESCRIPTION',
   PackageDirectoryName = 'PACKAGE_DIRECTORY_NAME',
 }

scripts/create-package/package-template/README.md

@@ -4,11 +4,11 @@ PACKAGE_DESCRIPTION
 
 ## Installation
 
-`yarn add PACKAGE_NAME`
+`yarn add @metamask/package-template`
 
 or
 
-`npm install PACKAGE_NAME`
+`npm install @metamask/package-template`
 
 ## Contributing
 

scripts/create-package/package-template/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "PACKAGE_NAME",
+  "name": "@metamask/package-template",
   "version": "0.0.0",
   "description": "PACKAGE_DESCRIPTION",
   "keywords": [
@@ -42,8 +42,10 @@
     "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
     "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
     "build:docs": "typedoc",
-    "changelog:update": "../../scripts/update-changelog.sh PACKAGE_NAME",
-    "changelog:validate": "../../scripts/validate-changelog.sh PACKAGE_NAME",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/package-template",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/package-template",
+    "lint:tsconfigs": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts",
+    "lint:tsconfigs:fix": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts --fix",
     "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --check",
     "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --generate",
     "since-latest-release": "../../scripts/since-latest-release.sh",
@@ -65,6 +67,6 @@
     "typescript": "~5.3.3"
   },
   "engines": {
-    "node": "NODE_VERSIONS"
+    "node": "^18.18 || >=20"
   }
 }

yarn.config.cjs

@@ -83,6 +83,9 @@ module.exports = defineConfig({
       const isPrivate =
         hasProperty(workspace.manifest, 'private') &&
         workspace.manifest.private === true;
+      const isTemplate =
+        workspace.manifest.name === '@metamask/package-template';
+
       const dependenciesByIdentAndType = getDependenciesByIdentAndType(
         Yarn.dependencies({ workspace }),
       );
@@ -110,11 +113,19 @@ module.exports = defineConfig({
         expectWorkspaceField(workspace, 'keywords', ['Ethereum', 'MetaMask']);
 
         // All non-root packages must have a homepage URL that includes its name.
-        expectWorkspaceField(
-          workspace,
-          'homepage',
-          `${repositoryUri}/tree/main/packages/${workspaceBasename}#readme`,
-        );
+        if (isTemplate) {
+          expectWorkspaceField(
+            workspace,
+            'homepage',
+            `${repositoryUri}/tree/main/packages/PACKAGE_DIRECTORY_NAME#readme`,
+          );
+        } else {
+          expectWorkspaceField(
+            workspace,
+            'homepage',
+            `${repositoryUri}/tree/main/packages/${workspaceBasename}#readme`,
+          );
+        }
 
         // All non-root packages must have a URL for reporting bugs that points
         // to the Issues page for the repository.
@@ -289,7 +300,9 @@ module.exports = defineConfig({
         // All non-root packages must have a valid README.md file.
         await expectReadme(workspace, workspaceBasename, isPrivate);
 
-        await expectCodeowner(workspace, workspaceBasename);
+        if (!isTemplate) {
+          await expectCodeowner(workspace, workspaceBasename);
+        }
       }
     }
 

yarn.lock

@@ -8171,6 +8171,23 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@metamask/package-template@workspace:scripts/create-package/package-template":
+  version: 0.0.0-use.local
+  resolution: "@metamask/package-template@workspace:scripts/create-package/package-template"
+  dependencies:
+    "@metamask/auto-changelog": "npm:^6.1.0"
+    "@ts-bridge/cli": "npm:^0.6.4"
+    "@types/jest": "npm:^30.0.0"
+    deepmerge: "npm:^4.2.2"
+    jest: "npm:^30.4.2"
+    ts-jest: "npm:^29.4.11"
+    tsx: "npm:^4.20.5"
+    typedoc: "npm:^0.25.13"
+    typedoc-plugin-missing-exports: "npm:^2.0.0"
+    typescript: "npm:~5.3.3"
+  languageName: unknown
+  linkType: soft
+
 "@metamask/passkey-controller@npm:^3.1.0, @metamask/passkey-controller@workspace:packages/passkey-controller":
   version: 0.0.0-use.local
   resolution: "@metamask/passkey-controller@workspace:packages/passkey-controller"