Package detail

gatsby-transformer-remote-filesystem

mjmaurer298MIT1.0.0

Adds a localURL field to any File node created with gatsby-source-filesystem's createRemoteFileNode

gatsby, gatsby-plugin, gatsby-transformer-plugin, remote

readme

gatsby-transformer-remote-filesystem

A Gatsby transformer plugin for copying remote File node content to the /static/ folder and exposing the path via localURL.

This is useful when you all your content is sourced through a remote source (i.e. gatsby-source-contentful, gatsby-source-wordpress).

With this plugin, you no longer have to install gatsby-source-filesystem if all of your data is remote. Bye-bye unneccesary dependencies and gatsby-node logic! See https://github.com/gatsbyjs/gatsby/issues/4993 for a discussion of this issue.

This plugin also includes extra options for fingerprinting the parent directory instead of the file name, as well as a mime-type filter.

Install

npm install --save gatsby-transformer-remote-filesystem

How to use

// In your gatsby-config.js
module.exports = {
  plugins: [
    // By default, this mimics the behavior of gatsby-source-filesystem
    // with the exception of exposing the path via `localURL` instead of
    // `publicURL`.
    `gatsby-plugin-remote-filesystem`
  ],
}

Options

// In your gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: `gatsby-transformer-remote-filesystem`,
      options: {
        // If true, fingerprint the directory instead of the filename
        // (as `gatsby-transformer-sharp` does).
        // For example, /static/my_file-1234asdf.pdf will become
        // /static/1324asdf/my_file.pdf.
        // Consider the SEO implications if your site is already published.
        fingerprintDirectory : true,

        // If included, only copies `File`s where `internal.mediaType` matches.
        // If option is not included, will copy all `File`s.
        // If you only need images, consider using `gatsy-transformer-sharp`
        // instead of this plugin.
        mediaTypes: ['application/pdf'],
      }
    }
  ],
}

How to query

You can query file nodes like the following:

{
  allFile {
    edges {
      node {
        localURL
      }
    }
  }
}

Contributing

This plugin only implements a single gatsby-node function so its pretty easy to grok. Feel free to send a PR!

The logic is from gatsby-source-filesystem, I just added some options.

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.1.48 (2020-02-01)

Bug Fixes

gatsby-source-filesystem: Retry stalled remote file downloads (#20843) (536686b)

2.1.47 (2020-01-29)

Note: Version bump only for package gatsby-source-filesystem

2.1.46 (2020-01-09)

Note: Version bump only for package gatsby-source-filesystem

2.1.45 (2020-01-09)

Note: Version bump only for package gatsby-source-filesystem

2.1.44 (2020-01-09)

Note: Version bump only for package gatsby-source-filesystem

2.1.43 (2019-12-20)

Bug Fixes

gatsby-source-filesystem: fix add/change text (#20188) (0fda1e6)

2.1.42 (2019-12-10)

Note: Version bump only for package gatsby-source-filesystem

2.1.41 (2019-12-10)

Note: Version bump only for package gatsby-source-filesystem

2.1.40 (2019-12-02)

Note: Version bump only for package gatsby-source-filesystem

2.1.39 (2019-11-26)

Note: Version bump only for package gatsby-source-filesystem

2.1.38 (2019-11-18)

Bug Fixes

gatsby: Handle special characters in windows paths (#19600) (9929cf0)

2.1.37 (2019-11-15)

Bug Fixes

update dependency pretty-bytes to v5 (#19485) (29735ea)

2.1.36 (2019-11-10)

Note: Version bump only for package gatsby-source-filesystem

2.1.35 (2019-10-28)

Note: Version bump only for package gatsby-source-filesystem

2.1.34 (2019-10-28)

Bug Fixes

update minor updates in packages (#18875) (b692879)
update minor updates in packages (#19080) (95e908e)

2.1.33 (2019-10-14)

Note: Version bump only for package gatsby-source-filesystem

2.1.32 (2019-10-14)

Note: Version bump only for package gatsby-source-filesystem

2.1.31 (2019-10-09)

Note: Version bump only for package gatsby-source-filesystem

2.1.30 (2019-10-08)

Note: Version bump only for package gatsby-source-filesystem

2.1.29 (2019-10-04)

Bug Fixes

update dependency bluebird to ^3.7.0 (#18029) (bd235a8)
update dependency chokidar to v3.2.1 (#18009) (4df0306)

2.1.28 (2019-09-26)

Note: Version bump only for package gatsby-source-filesystem

2.1.27 (2019-09-26)

Note: Version bump only for package gatsby-source-filesystem

2.1.26 (2019-09-20)

Note: Version bump only for package gatsby-source-filesystem

2.1.25 (2019-09-20)

Note: Version bump only for package gatsby-source-filesystem

2.1.24 (2019-09-18)

Note: Version bump only for package gatsby-source-filesystem

2.1.23 (2019-09-18)

Note: Version bump only for package gatsby-source-filesystem

2.1.22 (2019-09-09)

Bug Fixes

gatsby-source-filesystem: Queue all operations which happ… (#17404) (ad74957)

2.1.21 (2019-09-04)

Note: Version bump only for package gatsby-source-filesystem

2.1.20 (2019-09-04)

Note: Version bump only for package gatsby-source-filesystem

2.1.19 (2019-09-01)

Bug Fixes

update minor updates in packages except react, babel and eslint (#17254) (252d867)

2.1.18 (2019-08-24)

Bug Fixes

gatsby-source-filesystem: Use forward slashes on relative… (#17048) (799f657)

2.1.17 (2019-08-24)

Bug Fixes

update dependency file-type to v12 (#17030) (f538563)
update dependency fs-extra to v8 (#17031) (d891a19)

2.1.16 (2019-08-23)

Bug Fixes

update dependency chokidar to v3 (#16975) (816d475)

2.1.15 (2019-08-23)

Note: Version bump only for package gatsby-source-filesystem

2.1.14 (2019-08-22)

Note: Version bump only for package gatsby-source-filesystem

2.1.13 (2019-08-22)

Note: Version bump only for package gatsby-source-filesystem

2.1.12 (2019-08-21)

Bug Fixes

update dependency bluebird to ^3.5.5 (#16825) (ec0be83)

2.1.11 (2019-08-21)

Bug Fixes

update dependency better-queue to ^3.8.10 (#16824) (6834344)
update dependency chokidar to v2.1.6 (#16832) (dbcf65f)

2.1.10 (2019-08-20)

Note: Version bump only for package gatsby-source-filesystem

2.1.9 (2019-08-06)

Note: Version bump only for package gatsby-source-filesystem

2.1.8 (2019-08-01)

Note: Version bump only for package gatsby-source-filesystem

2.1.7 (2019-07-30)

Bug Fixes

gatsby-source-filesystem: Move GraphQL definition for Fil… (#16041) (36eae6b)

2.1.6 (2019-07-22)

Note: Version bump only for package gatsby-source-filesystem

2.1.5 (2019-07-12)

Bug Fixes

correct links in package changelogs (#15630) (d07b9dd)

2.1.4 (2019-07-11)

Note: Version bump only for package gatsby-source-filesystem

2.1.3 (2019-07-10)

Note: Version bump only for package gatsby-source-filesystem

2.1.2 (2019-07-02)

Bug Fixes

gatsby: various TypeScript definitions (#15268) (b8f3ed5)

2.1.1 (2019-06-25)

Features

gatsby-source-filesystem: add createFileNodeFromBuffer (#14576) (aa21755)

2.1.0 (2019-06-20)

Note: Version bump only for package gatsby-source-filesystem

2.0.43 (2019-06-19)

Bug Fixes

fix gatsby-cli dep in source-filesystem & plugin-sharp (#14881) (2594623)

2.0.42 (2019-06-19)

Bug Fixes

fix gatsby-cli dep in source-filesystem & plugin-sharp (#14881) (2594623)

2.0.41 (2019-06-18)

Note: Version bump only for package gatsby-source-filesystem

2.0.40 (2019-06-18)

Features

gatsby-cli: move progressbar into ink (#14220) (967597c)

2.0.39 (2019-06-10)

Features

gatsby-source-filesystem: remove slash (#14372) (1d9ba86)

2.0.38 (2019-05-31)

Features

gatsby-source-filesystem: add an environment variable to control concurrent queue size (#13110) (90aa247)

2.0.37 (2019-05-20)

Bug Fixes

gatsby-source-filesystem: fix unhandled rejection by returning promise chain (#14180) (53c91b5)

2.0.36 (2019-05-16)

Bug Fixes

gatsby-source-filesystem: fix createRemoteFileNode ts types (#14086) (e47da77)

2.0.35 (2019-05-15)

Bug Fixes

gatsby-source-filesystem: createRemoteFileNode rejects promise instead resolving on failure (#12348) (c2c5cea)

2.0.34 (2019-05-14)

Features

gatsby: allow awaiting API run triggered by createNode action (#12748) (17a67a5)

2.0.33 (2019-04-30)

Note: Version bump only for package gatsby-source-filesystem

2.0.32 (2019-04-24)

Bug Fixes

Add fallback for createContentDigest (#13584) (093f1f2)

2.0.31 (2019-04-23)

Note: Version bump only for package gatsby-source-filesystem

2.0.30 (2019-04-23)

Note: Version bump only for package gatsby-source-filesystem

2.0.29 (2019-04-08)

Features

createRemoteFileNode: allow passing headers to request (#11682) (7a8e41a)

2.0.28 (2019-03-22)

Bug Fixes

gatsby-source-filesystem: pin chokidar@2.1.2 to fix unix issues (#12759) (0ea1505)

2.0.27 (2019-03-15)

Note: Version bump only for package gatsby-source-filesystem

2.0.26 (2019-03-14)

Features

create-remote-file-node: add url field to downloaded file nodes (#12582) (cac37a9), closes #1234 #1234 #1234

2.0.25 (2019-03-13)

Note: Version bump only for package gatsby-source-filesystem

2.0.24 (2019-03-11)

Note: Version bump only for package gatsby-source-filesystem

2.0.23 (2019-02-25)

Bug Fixes

gatsby-source-filesystem: Do not re-download cached files from createRemoteFileNode (#12054) (a358239)

2.0.22 (2019-02-22)

Note: Version bump only for package gatsby-source-filesystem

2.0.21 (2019-02-20)

Bug Fixes

gatsby-source-filesystem: Let plugins set parent when creating File nodes with createRemoteFileNode (#11795) (5a3c1fc)

2.0.20 (2019-02-01)

Note: Version bump only for package gatsby-source-filesystem

2.0.19 (2019-01-31)

Bug Fixes

gatsby-source-filesystem: report when downloading fails (#10980) (eff2cf4)

2.0.18 (2019-01-28)

Note: Version bump only for package gatsby-source-filesystem

2.0.17 (2019-01-23)

Features

gatsby-source-filesystem: add optional name parameter to createRemoteFileNode (#11054) (8105be6), closes #11037 #1234 #1234 #1234

2.0.16 (2019-01-11)

Note: Version bump only for package gatsby-source-filesystem

2.0.14 (2019-01-11)

Note: Version bump only for package gatsby-source-filesystem

2.0.13 (2019-01-08)

Note: Version bump only for package gatsby-source-filesystem

2.0.12 (2018-12-11)

Features

gatsby-source-filesystem: keep original name of remote files (#9777) (dfc069d)

2.0.11 (2018-12-06)

Bug Fixes

gatsby-source-filesystem: allow empty password for basic auth in createRemoteFileNode (#10280) (1d4e057)

2.0.10 (2018-11-29)

Note: Version bump only for package gatsby-source-filesystem

2.0.9 (2018-11-26)

Bug Fixes

gatsby-plugin-filesystem: throw meaningful errors on bad inputs (#10123) (21ebf2c), closes #6643

2.0.8 (2018-11-08)

Note: Version bump only for package gatsby-source-filesystem

2.0.7 (2018-11-01)

Note: Version bump only for package gatsby-source-filesystem

2.0.6 (2018-10-29)

Note: Version bump only for package gatsby-source-filesystem

2.0.5 (2018-10-19)

Note: Version bump only for package gatsby-source-filesystem

2.0.4 (2018-10-15)

Bug Fixes

first parse url and then path to retrieve extension (#9011) (eb7648c)

2.0.3 (2018-10-09)

Bug Fixes

more work to prevent queries from running when there's in-progress node processing (#8859) (00eeef0)

2.0.2 (2018-10-05)

Note: Version bump only for package gatsby-source-filesystem

2.0.1 (2018-09-17)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-rc.6 (2018-09-11)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-rc.5 (2018-09-11)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-rc.4 (2018-09-11)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-rc.3 (2018-09-11)

Features

gatsby-source-filesystem: Added an 'ignore' property to the options to ignore more files. (#8016) (3f67a2f)

2.0.1-rc.2 (2018-09-07)

Bug Fixes

remove some warnings on promises (#7922) (e069f27)

2.0.1-rc.1 (2018-08-29)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-rc.0 (2018-08-21)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.11 (2018-08-21)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.10 (2018-07-24)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.9 (2018-07-21)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.8 (2018-07-19)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.7 (2018-07-19)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.6 (2018-07-18)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.5 (2018-07-14)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.4 (2018-07-13)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.3 (2018-06-21)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.2 (2018-06-20)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.1 (2018-06-17)

Note: Version bump only for package gatsby-source-filesystem

2.0.1-beta.0 (2018-06-17)

Note: Version bump only for package gatsby-source-filesystem