feat(typescript): automatically setup typescript references

yarnpkg · Apr 7, 2021 · c42a7b8 · c42a7b8
1 parent fc2fc2a
commit c42a7b8
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 3 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/packages/plugin-typescript/package.json b/packages/plugin-typescript/package.json
@@ -4,6 +4,7 @@
   "license": "BSD-2-Clause",
   "main": "./sources/index.ts",
   "dependencies": {
+    "@yarnpkg/fslib": "workspace:^2.4.0",
     "@yarnpkg/plugin-pack": "workspace:^2.2.3",
     "algoliasearch": "^4.2.0",
     "semver": "^7.1.2",

diff --git a/packages/plugin-typescript/sources/index.ts b/packages/plugin-typescript/sources/index.ts
@@ -1,7 +1,8 @@
+import {structUtils, ThrowReport, miscUtils, Hooks as CoreHooks}                                           from '@yarnpkg/core';
 import {Descriptor, Plugin, Workspace, ResolveOptions, Manifest, AllDependencies, DescriptorHash, Package} from '@yarnpkg/core';
-import {structUtils, ThrowReport, miscUtils}                                                               from '@yarnpkg/core';
-import {Hooks as EssentialsHooks}                                                                          from '@yarnpkg/plugin-essentials';
+import {xfs, ppath, Filename}                                                                              from "@yarnpkg/fslib";
 import {suggestUtils}                                                                                      from '@yarnpkg/plugin-essentials';
+import {Hooks as EssentialsHooks}                                                                          from '@yarnpkg/plugin-essentials';
 import {Hooks as PackHooks}                                                                                from '@yarnpkg/plugin-pack';
 import semver                                                                                              from 'semver';
 
@@ -128,8 +129,31 @@ const beforeWorkspacePacking = (workspace: Workspace, rawManifest: any) => {
   }
 };
 
-const plugin: Plugin<EssentialsHooks & PackHooks> = {
+const plugin: Plugin<EssentialsHooks & PackHooks & CoreHooks> = {
   hooks: {
+    async afterAllInstalled(project) {
+      for (const workspace of project.workspaces) {
+        const referencedWorkspaces = miscUtils.mapAndFilter(workspace.dependencies, ([identHash, descriptor]) => {
+          const dependingWorkspace = project.tryWorkspaceByDescriptor(descriptor);
+          if (!dependingWorkspace || dependingWorkspace === workspace)
+            return miscUtils.mapAndFilter.skip;
+
+          return ppath.relative(workspace.cwd, dependingWorkspace.cwd);
+        });
+
+        let tsconfig: {references?: Array<{path: string}>} = {};
+        try {
+          tsconfig = await xfs.readJsonPromise(ppath.join(workspace.cwd, `tsconfig.json` as Filename));
+        } catch { }
+
+        if (referencedWorkspaces.length === 0)
+          tsconfig.references = undefined;
+        else
+          tsconfig.references = referencedWorkspaces.map(relativePath => ({path: relativePath}));
+
+        await xfs.writeJsonPromise(ppath.join(workspace.cwd, `tsconfig.json` as Filename), tsconfig);
+      }
+    },
     afterWorkspaceDependencyAddition,
     afterWorkspaceDependencyRemoval,
     beforeWorkspacePacking,

diff --git a/yarn.lock b/yarn.lock
@@ -6191,6 +6191,7 @@ __metadata:
     "@yarnpkg/builder": "workspace:^2.1.3"
     "@yarnpkg/cli": "workspace:^2.4.0"
     "@yarnpkg/core": "workspace:^2.4.0"
+    "@yarnpkg/fslib": "workspace:^2.4.0"
     "@yarnpkg/plugin-essentials": "workspace:^2.4.0"
     "@yarnpkg/plugin-pack": "workspace:^2.2.3"
     algoliasearch: ^4.2.0