Merge pull request #5 from dansanderson/master

"copyfiles" block allows documents to request files to copy

Author: akabekobeko

CHANGELOG.md

@@ -1,5 +1,11 @@
 # ChangeLog
 
+## v1.0.3
+
+### Features
+
+- A new `copyfiles` code fence allows a Markdown file to declare files to be copied without linking to them directly. This is useful when linking to an HTML file that itself links to additional files that must be copied.
+
 ## v1.0.2
 
 ### Fixes

README.md

@@ -7,7 +7,7 @@
 
 Copies local files relative linked to/from markdown to your `public` folder with preserve directory structure.
 
-This will copy the files linked relative to all Markdowns like [gatsby-remark-copy-linked-files](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-remark-copy-linked-files) into a public directory structure like [gatsby-remark-copy-images](https://github.com/mojodna/gatsby-remark-copy-images) as it is.
+This will copy the files linked relative to all Markdowns like [gatsby-remark-copy-linked-files](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-remark-copy-linked-files) into a public directory structure like [gatsby-remark-copy-images](https://github.com/mojodna/gatsby-remark-copy-images) as it is. It can also copy additional files requested by the document.
 
 ## Install
 
@@ -29,27 +29,37 @@ plugins: [
 ]
 ```
 
+*Note:* When using the `copyfiles` code fence (see below), `gatsby-remark-copy-relative-linked-files` must appear before general purpose code fence processors like `gatsby-remark-prismjs`.
+
 Then in your Markdown files, simply reference the files.
 
 ### E.g.
 
 ```markdown
----
-title: My awesome blog post
----
-
-Hey everyone, I just made a sweet files with lots of interesting stuff in
-it.
-
-- ![](image.gif)
-- [archive.zip](archive.zip)
-- [sample.pdf](sample.pdf)
-- [not-copy.rar](https://example.com/not-copy.rar)
+    ---
+    title: My awesome blog post
+    ---
+
+    Hey everyone, I just made a sweet files with lots of interesting stuff in
+    it.
+
+    - ![](image.gif)
+    - [archive.zip](archive.zip)
+    - [sample.pdf](sample.pdf)
+    - [report.html](report.html)
+    - [not-copy.rar](https://example.com/not-copy.rar)
+
+    ```copyfiles
+    report.css
+    diagram.png
+    ```
 ```
 
-`image.gif`, `archive.zip` and `sample.pdf` should be in the same directory as the markdown file. When you build your site, the file will be copied to the public folder and the markdown HTML will be modified to point to it.
+`image.gif`, `archive.zip`, `sample.pdf` and `report.html` should be in the same directory as the Markdown file. When you build your site, the file will be copied to the public folder and the markdown HTML will be modified to point to it.
+
+Similarly, `report.css` and `diagram.png` should be in the same directory as the Markdown file. In this example, `report.html` has its own internal relative links to these files. `report.html` is not changed in any way. The relative links to the copied files work from the copied location.
 
-The copy target is a relative link. Therefore, links starting with `XXXX://` or `//` are ignore. In this example `not-copy.rar` is not copied.
+The copy target is a relative link. Therefore, links starting with `XXXX://` or `//` are ignored. In this example `not-copy.rar` is not copied.
 
 ## Options
 

src/index.js

@@ -47,25 +47,16 @@ module.exports = (
   { files, linkPrefix, markdownNode, markdownAST, getNode },
   pluginOptions = {}
 ) => {
-  // Copy linked files to the public directory and modify the AST to point to new location of the files.
-  const visitor = (link) => {
-    if (
-      isAbsoluteURL(link.url) ||
-      isIgnore(
-        link.url,
-        checkIgnoreFileExtensions(pluginOptions.ignoreFileExtensions)
-      )
-    ) {
-      return
-    }
 
-    const linkPath = Path.join(getNode(markdownNode.parent).dir, link.url)
+  // Copy a file, then return its new link URL
+  const copyFile = (relativePath) => {
+    const linkPath = Path.join(getNode(markdownNode.parent).dir, relativePath)
     const linkNode = files.find((file) => {
       return file && file.absolutePath ? file.absolutePath === linkPath : false
     })
 
     if (!(linkNode && linkNode.absolutePath)) {
-      return
+      return relativePath
     }
 
     const newPath = Path.join(
@@ -74,18 +65,45 @@ module.exports = (
       `${linkNode.relativePath}`
     )
 
-    link.url = Path.join(linkPrefix || '/', linkNode.relativePath)
-    if (FsExtra.existsSync(newPath)) {
+    const newLinkUrl = Path.join(linkPrefix || '/', linkNode.relativePath)
+    if (!FsExtra.existsSync(newPath)) {
+      FsExtra.copy(linkPath, newPath, (err) => {
+        if (err) {
+          console.error(`error copying file`, err)
+        }
+      })
+    }
+
+    return newLinkUrl
+  }
+
+  // Copy linked files to the public directory and modify the AST to point to new location of the files.
+  const visitor = (link) => {
+    if (
+      isAbsoluteURL(link.url) ||
+      isIgnore(
+        link.url,
+        checkIgnoreFileExtensions(pluginOptions.ignoreFileExtensions)
+      )
+    ) {
       return
     }
 
-    FsExtra.copy(linkPath, newPath, (err) => {
-      if (err) {
-        console.error(`error copying file`, err)
-      }
-    })
+    link.url = copyFile(link.url)
   }
 
   Visit(markdownAST, `image`, (image) => visitor(image))
   Visit(markdownAST, `link`, (link) => visitor(link))
+
+  // Copy additional files requested by a copyfiles manifest.
+  const manifestIndex = markdownAST.children.findIndex(
+    node => node.type === "code" && node.lang === "copyfiles"
+  );
+  if (manifestIndex != -1) {
+    const filesToCopy = markdownAST.children[manifestIndex].value.split('\n').map(s => s.trim());
+    filesToCopy.forEach(filename => copyFile(filename))
+    markdownAST.children = [].concat(
+      markdownAST.children.slice(0, manifestIndex),
+      markdownAST.children.slice(manifestIndex + 1))
+  }
 }

src/index.test.js

@@ -240,6 +240,57 @@ describe('gatsby-remark-copy-relative-linked-files', () => {
         expect(FsExtra.copy).not.toHaveBeenCalled()
       })
     })
+
+    describe('manifest', () => {
+      test('One file', async () => {
+        const path = 'sample.thumb.jpg'
+        const markdownAST = remark.parse(`\`\`\`copyfiles\n${path}\n\`\`\``)
+
+        await Plugin({
+          files: getFiles(path),
+          markdownAST,
+          markdownNode,
+          getNode
+        })
+
+        expect(FsExtra.copy).toHaveBeenCalled()
+        expect(markdownAST.children.findIndex(
+          node => node.type === "code" && node.lang === "copyfiles"
+        )).toEqual(-1);
+      })
+
+      test('Two files', async () => {
+        const path1 = 'report.css'
+        const path2 = 'diagram.png'
+        const markdownAST = remark.parse(`\`\`\`copyfiles\n${path1}\n${path2}\n\`\`\``)
+
+        await Plugin({
+          files: getFiles(path1).concat(getFiles(path2)),
+          markdownAST,
+          markdownNode,
+          getNode
+        })
+
+        expect(FsExtra.copy).toHaveBeenNthCalledWith(1, path1, expect.anything(), expect.anything())
+        expect(FsExtra.copy).toHaveBeenNthCalledWith(2, path2, expect.anything(), expect.anything())
+      })
+
+      test('Tolerates whitespace', async () => {
+        const path1 = 'report.css'
+        const path2 = 'diagram.png'
+        const markdownAST = remark.parse(`\`\`\`copyfiles\n   ${path1}\n${path2}   \n\`\`\``)
+
+        await Plugin({
+          files: getFiles(path1).concat(getFiles(path2)),
+          markdownAST,
+          markdownNode,
+          getNode
+        })
+
+        expect(FsExtra.copy).toHaveBeenNthCalledWith(1, path1, expect.anything(), expect.anything())
+        expect(FsExtra.copy).toHaveBeenNthCalledWith(2, path2, expect.anything(), expect.anything())
+      })
+    })
   })
 
   // For private API