feat: detect js workspaces (#3)

* feat(js-workspaces): detect js-workspaces

* chore: clean linting errors

* chore(js-workspaces): set interface keys at buildInfo level

package.json

@@ -55,5 +55,9 @@
   },
   "engines": {
     "node": ">=8.3.0"
+  },
+  "dependencies": {
+    "@npmcli/map-workspaces": "^1.0.3",
+    "read-pkg": "^5.2.0"
   }
 }

src/context.js

@@ -0,0 +1,39 @@
+const { resolve } = require('path')
+const { cwd } = require('process')
+
+const readPkg = require('read-pkg')
+
+const getPackageJson = async function (dir) {
+  try {
+    const packageJson = await readPkg({ cwd: dir, normalize: false })
+    if (packageJson === undefined) {
+      return {}
+    }
+
+    return packageJson
+  } catch (error) {
+    return {}
+  }
+}
+
+const getContext = async function ({ projectDir = cwd(), rootDir } = {}) {
+  // Get the absolute dirs for both project and root
+  const absoluteProjectDir = resolve(cwd(), projectDir)
+  const absoluteRootDir = rootDir ? resolve(cwd(), rootDir) : undefined
+
+  // We only pass through the root dir if it was provided and is actually different
+  // from the project dir
+  const validRootDir = absoluteRootDir && absoluteRootDir !== absoluteProjectDir ? absoluteRootDir : undefined
+
+  // If rootDir equals projectDir we'll be getting the projectDir package.json
+  // Later on if we also need the projectDir package.json we can check for it
+  // and only perform one resolution
+  const rootPackageJson = await getPackageJson(rootDir || projectDir)
+  return {
+    projectDir: absoluteProjectDir,
+    rootDir: validRootDir,
+    rootPackageJson,
+  }
+}
+
+module.exports = { getContext }

src/core.js

@@ -0,0 +1,33 @@
+'use strict'
+
+const mapWorkspaces = require('@npmcli/map-workspaces')
+
+const getWorkspaceInfo = async function ({ rootPackageJson, projectDir, rootDir }) {
+  if (!rootPackageJson.workspaces) {
+    return
+  }
+
+  const workspacesMap = await mapWorkspaces({
+    cwd: rootDir || projectDir,
+    pkg: rootPackageJson,
+  })
+
+  const packages = [...workspacesMap.values()]
+  // The provided project dir is a workspace package
+  const isWorkspace = packages.find((path) => projectDir === path)
+
+  // The project dir is a collection of workspaces itself
+  const isRoot = !rootDir
+
+  if (isWorkspace || isRoot) {
+    return { isRoot, packages }
+  }
+}
+
+const buildInfo = async function (context) {
+  const workspaceInfo = await getWorkspaceInfo(context)
+  const jsWorkspaces = workspaceInfo ? { jsWorkspaces: workspaceInfo } : {}
+  return { ...jsWorkspaces }
+}
+
+module.exports = { buildInfo }

src/main.js

@@ -1,7 +1,11 @@
 'use strict'
 
-const mainFunction = function () {
-  return true
+const { getContext } = require('./context')
+const { buildInfo } = require('./core')
+
+const getBuildInfo = async function (opts) {
+  const context = await getContext(opts)
+  return await buildInfo(context)
 }
 
-module.exports = { mainFunction }
+module.exports = { getBuildInfo }

test/fixtures/js-workspaces/not-in-workspace/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "not-in-workspace",
+  "version": "1.0.0"
+}

test/fixtures/js-workspaces/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "js-workspaces",
+  "version": "1.0.0",
+  "workspaces": [
+    "packages/*"
+  ]
+}

test/fixtures/js-workspaces/packages/package-1/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "package-1",
+  "version": "1.0.0"
+}

test/fixtures/js-workspaces/packages/package-2/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "simple-package-json",
+  "version": "1.0.0"
+}

test/fixtures/simple-package-json/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "simple-package-json",
+  "version": "1.0.0"
+}

test/main.js

@@ -1,5 +1,69 @@
+const { resolve } = require('path')
+
 const test = require('ava')
 
-test('Template test', (t) => {
-  t.pass()
+const { getBuildInfo } = require('../src/main')
+
+const FIXTURES_RELATIVE_PATH = `${__dirname}/fixtures`
+const FIXTURES_ABSOLUTE_PATH = resolve(FIXTURES_RELATIVE_PATH)
+
+test('js-workspaces: project without package.json does not return workspaces info', async (t) => {
+  const { jsWorkspaces } = await getBuildInfo({
+    projectDir: `${FIXTURES_RELATIVE_PATH}/empty`,
+  })
+  t.is(jsWorkspaces, undefined)
+})
+
+test('js-workspaces: project without workspaces in package.json does not return workspaces info', async (t) => {
+  const { jsWorkspaces } = await getBuildInfo({
+    projectDir: `${FIXTURES_RELATIVE_PATH}/simple-package-json`,
+  })
+  t.is(jsWorkspaces, undefined)
+})
+
+test('js-workspaces: projectDir set to workspaces root returns workspace info and isRoot flag set to true', async (t) => {
+  const { jsWorkspaces } = await getBuildInfo({
+    projectDir: `${FIXTURES_RELATIVE_PATH}/js-workspaces`,
+  })
+  t.not(jsWorkspaces, undefined)
+  t.true(jsWorkspaces.isRoot)
+  t.is(jsWorkspaces.packages.length, 2)
+})
+
+test('js-workspaces: detects rootDir is the same as the projectDir and sets the isRoot flag to true', async (t) => {
+  const { jsWorkspaces } = await getBuildInfo({
+    rootDir: `${FIXTURES_ABSOLUTE_PATH}/js-workspaces`,
+    projectDir: `${FIXTURES_RELATIVE_PATH}/js-workspaces`,
+  })
+  t.not(jsWorkspaces, undefined)
+  t.true(jsWorkspaces.isRoot)
+  t.is(jsWorkspaces.packages.length, 2)
+})
+
+test('js-workspaces: projectDir set to workspace dir returns workspace info and isRoot flag set to false', async (t) => {
+  const { jsWorkspaces } = await getBuildInfo({
+    rootDir: `${FIXTURES_RELATIVE_PATH}/js-workspaces`,
+    projectDir: `${FIXTURES_RELATIVE_PATH}/js-workspaces/packages/package-1`,
+  })
+  t.not(jsWorkspaces, undefined)
+  t.false(jsWorkspaces.isRoot)
+  t.is(jsWorkspaces.packages.length, 2)
+})
+
+test('js-workspaces: if project is not part of a workspace return no workspace info', async (t) => {
+  const { jsWorkspaces } = await getBuildInfo({
+    rootDir: `${FIXTURES_RELATIVE_PATH}/js-workspaces`,
+    projectDir: `${FIXTURES_RELATIVE_PATH}/js-workspaces/not-in-workspace`,
+  })
+  t.is(jsWorkspaces, undefined)
+})
+
+test('js-workspaces: handles absolute paths correctly', async (t) => {
+  const { jsWorkspaces } = await getBuildInfo({
+    rootDir: `${FIXTURES_ABSOLUTE_PATH}/js-workspaces`,
+    projectDir: `${FIXTURES_ABSOLUTE_PATH}/js-workspaces/packages/package-1`,
+  })
+  t.not(jsWorkspaces, undefined)
+  t.false(jsWorkspaces.isRoot)
+  t.is(jsWorkspaces.packages.length, 2)
 })