Skip to main content
View plugin on GitHub
See starters using this

gatsby-plugin-asset-path

Move all of your JS and CSS build files, as well as the static folder into a subdirectory of your choice.

Breaking change in v1

Use assetPrefix instead of pathPrefix

Our use case

Gatsby by default will generate all of the assets and put them directly at the root level:

public
β”‚   index.html
β”‚   component1.js
|   component1.js.map
|   component1.css
|   component2.js
|   compoennt2.js.map
|   component3.css
└───path1
β”‚   β”‚   index.html
β”‚   β”‚   other1.html
│───path2
β”‚   β”‚   index.html
β”‚   β”‚   other2.html
|___static
|   |   data.json
|   |   image.jpg

However here at MadeComfy, we host our site on AWS Cloudfront/S3. One issue that we faced was that somehow, two different builds would have some JS/CSS files with the same file names even though their content are different.

That means during deployment on S3 and object invalidation on Cloudfront, someone that is currently browsing the site, would see the experience broken whilst moving onto other pages as the loaded JS would still have asset references of the previous build.

Hence our need to make sure that each build is kept intact on Cloudfront, except the HTML that are loaded on the browser at each hard reload. That way we make sure that our site has no down time at any point of time. We’ve configured our caching configs this way.

Using this plugin, our file struture is now as followed:

public
β”‚   index.html
|___assets
|   |___1534761288
β”‚   |   |   component1.js
β”‚   |   |   component1.js.map
β”‚   |   |   component1.css
β”‚   |   |   component2.js
β”‚   |   |   compoennt2.js.map
β”‚   |   |   component3.css
β”‚   |   |___static
β”‚   |   |   |   data.json
β”‚   |   |   |   image.jpg
└───path1
β”‚   β”‚   index.html
β”‚   β”‚   other1.html
│───path2
β”‚   β”‚   index.html
β”‚   β”‚   other2.html

Our new assets folder would contain assets of every build once on S3.

Install

npm install --save-dev gatsby-plugin-asset-path
yarn install -D gatsby-plugin-asset-path

How to use

// Your gatsby-config.js
{
    assetPrefix: "custom_asset_folder",
    plugins: [
        {
            resolve: "gatsby-plugin-asset-path"
        }
    ]
}

In our use case above, we have assetPrefix set as followed:

{
  assetPrefix: `/assets/${Date.now().toString()}`,
}

Options

removeMapFiles

Default: false

Stops Webpack from generating the .js.map files

// Your gatsby-config.js
{
  plugins: [
    {
      resolve: "gatsby-plugin-asset-path",
      options: {
        removeMapFiles: true,
      },
    },
  ];
}

additionalFiles

Default: []

Additional files to move to the asset directory.

// Your gatsby-config.js
{
  plugins: [
    {
      resolve: "gatsby-plugin-asset-path",
      options: {
        additionalFiles: ['example.txt'],
      },
    },
  ];
}

Docs
Tutorials
Plugins
Blog
Showcase