Registry / web-framework / gatsby-plugin-meta-redirect

gatsby-plugin-meta-redirect

library1.1.1jsnpmunverified

gatsby-plugin-meta-redirect is a Gatsby plugin designed to generate static HTML files containing a `<meta http-equiv="refresh">` tag. This enables client-side redirects on any static file host, such as S3 or Netlify, without requiring server-side redirect rules or `.htaccess` configurations. The plugin processes `createRedirect` actions called within Gatsby's Node API (e.g., in `gatsby-node.js`) and outputs an `index.html` file at the `fromPath` containing the meta refresh tag pointing to the `toPath`. Currently at version 1.1.1, the package has not seen updates in over seven years, indicating an abandoned maintenance schedule. Its primary differentiator is the universal compatibility across static hosts, but this comes with SEO and user experience trade-offs compared to server-side 301 redirects.

web-framework devops

npm install gatsby-plugin-meta-redirect

github ↗package ↗

INSTALL

IMPORT

SIG · GATSBY-PLUGIN-META

gatsby-plugin-meta-redirect

web-frameworkjavascriptv1.1.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

gatsby-plugin-meta-redirect

✓ // in gatsby-config.js plugins: [ // other plugins... `gatsby-plugin-meta-redirect` // must be last ];

✗ import gatsbyPluginMetaRedirect from 'gatsby-plugin-meta-redirect';

This plugin does not export any JavaScript symbols for direct import. Its functionality is enabled by adding it to the `plugins` array in `gatsby-config.js`. The configuration must be the last entry in the plugins array for proper operation.

createRedirect

✓ // in gatsby-node.js exports.createPages = async ({ actions }) => { const { createRedirect } = actions; createRedirect({ fromPath: '/old-url/', toPath: '/new-url/', isPermanent: true, redirectInBrowser: true }); // ... other createPage calls };

✗ import { createRedirect } from 'gatsby-plugin-meta-redirect';

`createRedirect` is a Gatsby Node API action (provided via `actions` object), not an export of `gatsby-plugin-meta-redirect`. The plugin *consumes* these actions to generate the HTML redirect files.

This quickstart demonstrates how to configure `gatsby-plugin-meta-redirect` in `gatsby-config.js` and how to define redirects using Gatsby's `createRedirect` action within `gatsby-node.js` for both static and data-driven redirect scenarios. It illustrates basic permanent redirects, language-specific redirects, and iterating over markdown frontmatter to generate redirects programmatically.

// gatsby-config.js module.exports = { plugins: [ // Ensure this plugin is the last one in your array `gatsby-plugin-meta-redirect` ] }; // gatsby-node.js const path = require('path'); exports.createPages = async ({ actions, graphql }) => { const { createRedirect, createPage } = actions; // Example 1: Basic permanent redirect createRedirect({ fromPath: '/legacy-page/', toPath: '/new-destination/', isPermanent: true, redirectInBrowser: true }); // Example 2: Redirect with a language preference createRedirect({ fromPath: '/global-content/', toPath: '/en-US/global-content/', Language: 'en' }); // Example 3: Programmatic redirect based on data (e.g., old blog post slugs) const result = await graphql(` { allMarkdownRemark { edges { node { frontmatter { slug oldPaths } } } } } `); if (result.errors) { throw result.errors; } const posts = result.data.allMarkdownRemark.edges; posts.forEach(({ node }) => { if (node.frontmatter.oldPaths) { node.frontmatter.oldPaths.forEach(oldPath => { createRedirect({ fromPath: oldPath, toPath: node.frontmatter.slug, isPermanent: true, redirectInBrowser: true }); }); } createPage({ path: node.frontmatter.slug, component: path.resolve('./src/templates/blog-post.js'), context: { slug: node.frontmatter.slug, }, }); }); };

Debug

Known issues

gotchaThe `gatsby-plugin-meta-redirect` plugin *must* be the last entry in the `plugins` array within your `gatsby-config.js` file. Failure to do so can result in redirects not being generated or working incorrectly, as other plugins might interfere with the build output or path generation.

fix

Ensure `gatsby-plugin-meta-redirect` is the final plugin listed in `gatsby-config.js`.

affects: >=1.0.0

gotchaThis plugin generates redirects using client-side `<meta http-equiv="refresh">` tags, not server-side 301 HTTP redirects. While functional for static hosting, meta refresh redirects are generally less favorable for Search Engine Optimization (SEO) as they are treated as temporary (302-like) redirects by search engines and may not pass full link equity. They can also lead to a poorer user experience due to a slight delay.

fix

For SEO-critical permanent redirects, prefer hosting-provider-specific 301 redirect solutions (e.g., Netlify `_redirects` file, Vercel redirects in `vercel.json`, or server-side configurations) if your host supports them. Use this plugin when server-side control is not available or for non-SEO-critical temporary redirects.

affects: >=1.0.0

deprecatedThe `gatsby-plugin-meta-redirect` package has not been updated in over seven years (last published in November 2018) and is considered unmaintained. This raises concerns about compatibility with newer Gatsby versions, Node.js environments, and potential security vulnerabilities that will not be addressed.

fix

Evaluate alternatives like `gatsby-plugin-client-side-redirect` (though also old) or server-side redirect solutions provided by your hosting provider. For new projects, consider Gatsby versions that have native redirect capabilities or more actively maintained plugins.

affects: >=1.0.0

Errors

Common errors & fixes

Redirect not working or generating correctly.

The `gatsby-plugin-meta-redirect` plugin is not placed last in the `plugins` array in `gatsby-config.js`, allowing other plugins to override or interfere with its output.

fix

Move `gatsby-plugin-meta-redirect` to the very end of the `plugins` array in your `gatsby-config.js` file.

Low SEO ranking for pages with redirects, or 'soft 404' warnings in search console.

The plugin uses `<meta http-equiv="refresh">` which is interpreted by search engines as a soft redirect (similar to a 302 'Found' status), not a permanent 301 'Moved Permanently'. This can impact page authority transfer and SEO.

fix

For critical redirects, implement true 301 server-side redirects via your hosting provider's configuration (e.g., `_redirects` file for Netlify/Vercel, NGINX rules for custom servers) instead of relying solely on meta refresh. Update internal links and sitemaps to point to the final URLs.

Upgrade

Version history

1.1.1latest on npm

Audit

Dependencies

gatsbyrequiredThis is a plugin for the Gatsby framework and relies on its build process and Node APIs.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/getchalk/gatsby-plugin-meta-redirect ↗

packagehttps://www.npmjs.com/package/gatsby-plugin-meta-redirect ↗