feat: include doc files in dist output (mikeal#4)

Ref: multiformats/js-multiformats#55

Author: rvagg

src/package/index.js

@@ -7,10 +7,12 @@ import { fileURLToPath } from 'url'
 import { join } from 'path'
 import rmtree from '@tgrajewski/rmtree'
 
+const docFileRegex = /^(readme|license)/i
+
 const copy = o => JSON.parse(JSON.stringify(o))
 const vals = Object.values
 
-const { writeFile, mkdir, unlink, readdir, readFile } = fs
+const { writeFile, mkdir, unlink, readdir, readFile, copyFile } = fs
 
 class Package {
   constructor ({ cwd, hooks, tests }) {
@@ -69,6 +71,7 @@ class Package {
     }
     this.exports = exports
     let promises = [...this.files.values()]
+    this.docFiles = new Map((await this.getDocFiles()).map(f => [f, toURL(f)]))
     if (this.includeTests) {
       const testFiles = await this.getTestFiles()
       this.tests = new Map(testFiles.map(k => [k, this.testFile(toURL(k))]))
@@ -101,6 +104,10 @@ class Package {
     return this.pkgjson.exports[key]
   }
 
+  async getDocFiles () {
+    return (await readdir(this.cwd)).filter(f => docFileRegex.test(f))
+  }
+
   async getTestFiles () {
     const files = await readdir(this.cwd)
     const testFiles = []
@@ -156,11 +163,13 @@ class Package {
   async deflate (dist) {
     if (!(dist instanceof URL)) dist = path(dist)
     rmtree(fileURLToPath(dist))
-    await mkdir(dist)
-    await mkdir(new URL(dist + '/cjs'))
+    await mkdir(new URL(dist + '/cjs'), { recursive: true })
     await mkdir(new URL(dist + '/esm'))
 
     const pending = [...this.files.values()].map(p => p.then(f => f.deflate(dist)))
+    for (const [f, url] of this.docFiles) {
+      pending.push(copyFile(url, new URL(`${dist}/${f}`)))
+    }
     if (this.includeTests) {
       pending.push(...[...this.testFiles.values()].map(p => p.then(f => f.deflate(dist))))
     }