feat: search for workspace root

vitejs · antfu · May 7, 2021 · Apr 4, 2021 · Apr 4, 2021 · Apr 4, 2021
commit f4e386947ce1dee0d94a39fbe14bf0dcae4f99ef
diff --git a/packages/vite/src/node/server/__tests__/fixtures/none/nested/package.json b/packages/vite/src/node/server/__tests__/fixtures/none/nested/package.json
@@ -0,0 +1,3 @@
+{
+  "private": true
+}
diff --git a/packages/vite/src/node/server/__tests__/fixtures/pnpm/nested/package.json b/packages/vite/src/node/server/__tests__/fixtures/pnpm/nested/package.json
@@ -0,0 +1,3 @@
+{
+  "private": true
+}
diff --git a/packages/vite/src/node/server/__tests__/fixtures/pnpm/package.json b/packages/vite/src/node/server/__tests__/fixtures/pnpm/package.json
@@ -0,0 +1,3 @@
+{
+  "private": true
+}
diff --git a/packages/vite/src/node/server/__tests__/fixtures/pnpm/pnpm-workspace.yaml b/packages/vite/src/node/server/__tests__/fixtures/pnpm/pnpm-workspace.yaml
diff --git a/packages/vite/src/node/server/__tests__/fixtures/yarn/nested/package.json b/packages/vite/src/node/server/__tests__/fixtures/yarn/nested/package.json
@@ -0,0 +1,3 @@
+{
+  "private": true
+}
diff --git a/packages/vite/src/node/server/__tests__/fixtures/yarn/package.json b/packages/vite/src/node/server/__tests__/fixtures/yarn/package.json
@@ -0,0 +1,6 @@
+{
+  "private": true,
+  "workspaces": [
+    "nested"
+  ]
+}
diff --git a/packages/vite/src/node/server/__tests__/search-root.spec.ts b/packages/vite/src/node/server/__tests__/search-root.spec.ts
@@ -0,0 +1,37 @@
+import { searchForWorkspaceRoot } from '../searchRoot'
+import { resolve } from 'path'
+
+describe('searchForWorkspaceRoot', () => {
+  test('pnpm', () => {
+    const resolved = searchForWorkspaceRoot(
+      resolve(__dirname, 'fixtures/pnpm/nested'),
+      5
+    )
+    expect(resolved).toBe(resolve(__dirname, 'fixtures/pnpm'))
+  })
+
+  test('yarn', () => {
+    const resolved = searchForWorkspaceRoot(
+      resolve(__dirname, 'fixtures/yarn/nested'),
+      5
+    )
+    expect(resolved).toBe(resolve(__dirname, 'fixtures/yarn'))
+  })
+
+  test('none', () => {
+    const resolved = searchForWorkspaceRoot(
+      resolve(__dirname, 'fixtures/none/nested'),
+      3
+    )
+    expect(resolved).toBe(resolve(__dirname, 'fixtures/none/nested'))
+  })
+
+  test('deeper', () => {
+    const resolved = searchForWorkspaceRoot(
+      resolve(__dirname, 'fixtures/none/nested'),
+      10
+    )
+    // resolved to vite repo's root
+    expect(resolved).toBe(resolve(__dirname, '../../../../../..'))
+  })
+})
diff --git a/packages/vite/src/node/server/searchRoot.ts b/packages/vite/src/node/server/searchRoot.ts
@@ -0,0 +1,50 @@
+import fs from 'fs'
+import { dirname } from 'path'
+import { join } from 'path'
+
+// https://github.com/vitejs/vite/issues/2820#issuecomment-812495079
+const ROOT_FILES = [
+  '.git',
+
+  // https://pnpm.js.org/workspaces/
+  'pnpm-workspace.yaml'
+
+  // https://rushjs.io/pages/advanced/config_files/
+  // 'rush.json',
+
+  // https://nx.dev/latest/react/getting-started/nx-setup
+  // 'workspace.json',
+  // 'nx.json'
+]
+
+// npm: https://docs.npmjs.com/cli/v7/using-npm/workspaces#installing-workspaces
+// yarn: https://classic.yarnpkg.com/en/docs/workspaces/#toc-how-to-use-it
+function hasWorkspacePackageJSON(root: string): boolean {
+  const path = join(root, 'package.json')
+  if (!fs.existsSync(path)) return false
+  const content = JSON.parse(fs.readFileSync(path, 'utf-8')) || {}
+  return !!content.workspaces
+}
+
+function hasRootFile(root: string): boolean {
+  for (const file of ROOT_FILES) {
+    if (fs.existsSync(join(root, file))) return true
+  }
+  return false
+}
+
+export function searchForWorkspaceRoot(
+  current: string,
+  depth: number,
+  root = current
+): string {
+  if (depth <= 0) return root
+  if (hasRootFile(current)) return current
+  if (hasWorkspacePackageJSON(current)) return current
+
+  const dir = dirname(current)
+  // reach the fs root
+  if (dir === current) return root
+
+  return searchForWorkspaceRoot(dir, depth - 1, root)
+}