Merge pull request #8 from TomerAberbach/master

Support multiple package.json paths

Author: Septh

package-lock.json

@@ -45,12 +45,15 @@
   "scripts": {
     "build": "rollup -c",
     "watch": "rollup -cw",
-    "types": "tsc src/index.ts --declaration --emitDeclarationOnly --outDir dist",
+    "types": "tsc src/index.ts --downlevelIteration --declaration --emitDeclarationOnly --outDir dist",
     "test": "ava",
     "watch-tests": "ava -w",
     "clean": "trash dist",
     "prepublishOnly": "npm run clean && npm run build && npm run types"
   },
+  "dependencies": {
+    "find-up": "^4.1.0"
+  },
   "peerDependencies": {
     "builtin-modules": "^3.1.0"
   },

package.json

@@ -5,7 +5,11 @@ import builtins from 'builtin-modules'
 import pkg from './package.json'
 const input = 'src/index.ts'
 const sourcemap = true
-const external = builtins.concat(Object.keys(pkg.devDependencies), Object.keys(pkg.peerDependencies))
+const external = builtins.concat(
+  Object.keys(pkg.devDependencies),
+  Object.keys(pkg.dependencies),
+  Object.keys(pkg.peerDependencies)
+)
 const tsOptions = {
     tsconfig: cfg => ({ ...cfg, removeComments: true })
 }

rollup.config.js

@@ -0,0 +1,66 @@
+import test from 'ava'
+import { join } from 'path'
+import { findPackagePaths, findDependencies } from './dependencies'
+
+const path = (...paths: string[]): string => join(__dirname, ...paths)
+
+test.serial('finds package paths in git monorepo', async t => {
+    const cwd = path('fixtures/monorepo/packages/package')
+    process.chdir(cwd)
+
+    const packagePaths = [
+        path('fixtures/monorepo/packages/package/package.json'),
+        path('fixtures/monorepo/package.json')
+    ]
+
+    // Should have two assertions
+    t.plan(2)
+
+    for await (const packagePath of findPackagePaths()) {
+        t.is(packagePath, packagePaths.shift())
+    }
+})
+
+test.serial('finds package paths in non-git monorepo', async t => {
+    const cwd = path('fixtures/monorepo-no-git/packages/package')
+    process.chdir(cwd)
+
+    const packagePaths = [
+        path('fixtures/monorepo-no-git/packages/package/package.json'),
+        path('fixtures/monorepo-no-git/package.json'),
+        path('../package.json')
+    ]
+
+    // Should have three assertions
+    t.plan(3)
+
+    for await (const packagePath of findPackagePaths()) {
+        t.is(packagePath, packagePaths.shift())
+    }
+})
+
+test.serial('finds dependencies in monorepo', async t => {
+    const cwd = path('fixtures/monorepo/packages/package')
+    process.chdir(cwd)
+
+    const dependencies = await findDependencies({
+        packagePaths: findPackagePaths(),
+        keys: ['dependencies'],
+        warnings: []
+    })
+
+    t.deepEqual(new Set(dependencies), new Set(['lodash', 'express', 'chalk']))
+})
+
+test.serial('finds dev dependencies in monorepo', async t => {
+    const cwd = path('fixtures/monorepo/packages/package')
+    process.chdir(cwd)
+
+    const devDependencies = await findDependencies({
+        packagePaths: findPackagePaths(),
+        keys: ['devDependencies'],
+        warnings: []
+    })
+
+    t.deepEqual(new Set(devDependencies), new Set(['typescript', 'rollup']))
+})

src/dependencies.test.ts

@@ -0,0 +1,67 @@
+import { dirname, relative, isAbsolute } from 'path'
+import { promises as fs } from 'fs'
+import findUp from 'find-up'
+
+/**
+ * Determines if the `child` path is under the `parent` path.
+ */
+function isInDirectory(parent: string, child: string): boolean {
+    const relativePath = relative(parent, child)
+    return !relativePath.startsWith('..') && !isAbsolute(relativePath)
+}
+
+/**
+ * Iterates over package.json file paths recursively found in parent directories, starting from the
+ * current working directory. If the current working directory is in a git repository, then package.json
+ * files outside of the git repository will not be yielded.
+ */
+export async function* findPackagePaths(): AsyncGenerator<string> {
+    // Find git root if in git repository
+    const gitDirectoryPath: string | undefined = await findUp('.git', { type: 'directory' })
+    const gitRootPath: string | undefined = gitDirectoryPath === undefined
+        ? undefined
+        : dirname(gitDirectoryPath)
+
+    function isInGitDirectory(path: string): boolean {
+        return gitRootPath === undefined || isInDirectory(gitRootPath, path)
+    }
+
+    let cwd: string = process.cwd()
+    let packagePath: string | undefined
+
+    while (
+        (packagePath = await findUp('package.json', { type: 'file', cwd })) &&
+        isInGitDirectory(packagePath)
+    ) {
+        yield packagePath
+        cwd = dirname(dirname(packagePath))
+    }
+}
+
+export async function findDependencies(
+    { packagePaths, keys, warnings }: {
+        packagePaths: AsyncIterable<string> | Iterable<string>,
+        keys: string[],
+        warnings: string[]
+    }
+): Promise<string[]> {
+    const dependencies: Set<string> = new Set()
+
+    for await (const packagePath of packagePaths) {
+        try {
+            const pkg: { [key in PropertyKey]: any } = JSON.parse((await fs.readFile(packagePath)).toString()) ?? {}
+
+            for (const key of keys) {
+                const dependenciesToVersions: { [key in PropertyKey]: any } = pkg[key] ?? {}
+
+                for (const dependency of Object.keys(dependenciesToVersions)) {
+                    dependencies.add(dependency)
+                }
+            }
+        } catch {
+            warnings.push(`Couldn't process '${packagePath}'. Make sure it is a valid JSON or use the 'packagePath' option`)
+        }
+    }
+
+    return Array.from(dependencies)
+}

src/dependencies.ts

@@ -0,0 +1,3 @@
+{
+
+}

src/fixtures/monorepo-no-git/package.json

@@ -0,0 +1,3 @@
+{
+
+}

src/fixtures/monorepo-no-git/packages/package/package.json

@@ -0,0 +1,10 @@
+{
+  "dependencies": {
+    "lodash": "^4.17.15",
+    "chalk": "^4.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^3.9.2",
+    "rollup": "^2.10.2"
+  }
+}

src/fixtures/monorepo/package.json

@@ -0,0 +1,9 @@
+{
+  "dependencies": {
+    "lodash": "^4.17.15",
+    "express": "4.17.1"
+  },
+  "peerDependencies": {
+    "@babel/core": "^7.0.0"
+  }
+}

src/fixtures/monorepo/packages/package/package.json

@@ -1,8 +1,9 @@
 import test from 'ava'
 import { testProp, fc } from 'ava-fast-check'
 import { Arbitrary } from 'fast-check'
-import { PluginContext, Plugin } from 'rollup'
+import { PluginContext, Plugin, InputOptions } from 'rollup'
 import externals, { ExternalsOptions } from './index'
+import { join } from "path"
 
 // Returns an arbitrary for generating externals options objects
 const externalsOptionsArbitrary = (): Arbitrary<ExternalsOptions> =>
@@ -31,10 +32,30 @@ testProp(
     }
 )
 
-test('does not mark "dependencies" dependency as external by default', t => {
+test('does not mark "dependencies" dependency as external by default', async t => {
     const source = 'example'
     const importer = 'me'
-    const plugin = externals({ packagePath: './fixtures/test.json' }) as Plugin & PluginContext
+    const plugin = externals({ packagePath: './fixtures/test.json' }) as Required<Plugin> & PluginContext
 
+    await plugin.buildStart({} as InputOptions)
     t.is(plugin.resolveId(source, importer), null)
 })
+
+const path = (...paths: string[]): string => join(__dirname, ...paths)
+
+test.serial('monorepo usage', async t => {
+    const cwd = path('fixtures/monorepo/packages/package')
+    process.chdir(cwd)
+
+    const importer = 'me'
+    const plugin = externals() as Required<Plugin> & PluginContext
+    await plugin.buildStart({} as InputOptions)
+
+    for (const source of ['@babel/core', 'typescript', 'rollup']) {
+        t.false(plugin.resolveId(source, importer))
+    }
+
+    for (const source of ['lodash', 'express', 'chalk']) {
+        t.is(plugin.resolveId(source, importer), null)
+    }
+})