hashicorp / netlify-to-nextjs-redirect-exporter

Convert Netlify redirects into Next.js-compatible redirects

netlify-to-nextjs-redirect-exporter

A Node.js library and CLI that converts a Netlify _redirects file into compatible Next.js redirect/rewrite rules

Installation

npm i @hashicorp/netlify-to-nextjs-redirect-exporter

Usage

Node.js

// next.config.js
import { parseNetlifyRedirects } from "@hashicorp/netlify-to-nextjs-redirect-exporter";

const contents = fs.readFileSync("/path/to/_redirects/file", "utf8");

// `parseNetlifyRedirects()` will return an object with two keys:
// `rewrites` and `redirects`, each containing an array of corresponding rules
const { rewrites, redirects } = parseNetlifyRedirects(contents);

module.exports = {
    async rewrites() return rewrites
    async redirects() return redirects
}

CLI

Using the export-netlify-redirects CLI will create two files: rewrites.next.js and redirects.next.js, each containing an array of corresponding rules.

$ ./node_modules/.bin/export-netlify-redirects ./_redirects

Writing redirects file to redirects.next.js...
Writing rewrites file to rewrites.next.js...
Done.

Active Development

npm i
npm run watch

Run tests

npm t

netlify-to-nextjs-redirect-exporter's Issues

Do not assume "greedy" wildcard *

As is referenced by #4 , we cannot assume that every wildcard directly falls into a * (zero-or-more) matcher designation. We can also consider utilizing a "one-or-more" rule with a + as is referenced in the https://www.npmjs.com/package/path-to-regexp#zero-or-more docs

The solution might be to accept some sort of config or rule that we could apply per rule to determine the appropriate matcher.

GitHub Actions - deprecated warnings found - action required!

Workflow Name: C/I
Branch: master
Run URL: https://github.com/hashicorp/netlify-to-nextjs-redirect-exporter/actions/runs/3914050584

save-state deprecation warnings: 0
set-output deprecation warnings: 0
node12 deprecation warnings: 1

Please review these deprecation warnings as soon as possible and merge in the necessary updates.

GitHub will be removing support for these commands and plan to fully disable them on 31st May 2023. At this time, any workflow that still utilizes these commands will fail. See https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/.

GitHub have not finalized a date for deprecating node12 yet but have indicated that this will be summer 2023. So it is advised to switch to node16 asap. See https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/.

If you need any help, please reach out to us in #team-rel-eng.