Switch to astro-redirect-from (#830)

* astro-redirect-from prototype

* move out plugin

* switch to astro-redirect-from

* fixes

* new post: astro-redirect-from

* fix dependency

* test fixes

* downgrade and lock astro

* until fix for withastro/astro#8649 has been released

* mention debug json file

* fix e2e test

.config/astro.config.ts

@@ -4,8 +4,9 @@ import remarkToc from '../src/lib/remark-toc'
 import react from '@astrojs/react'
 import sitemap from '@astrojs/sitemap'
 import expressiveCode from 'astro-expressive-code'
-import redirects from './redirects.json'
+import redirectFrom from 'astro-redirect-from'
 import config from './blog.config'
+import { getSlug } from '../src/lib/astro/getSlug'
 
 // https://astro.build/config
 export default defineConfig({
@@ -22,7 +23,6 @@ export default defineConfig({
     }
   },
   server: { host: true },
-  redirects,
   vite: {
     resolve: {
       // for making content -> src/content symlink work
@@ -49,6 +49,7 @@ export default defineConfig({
         }
       }
     }),
+    redirectFrom({ contentDir: './content', getSlug }),
     sitemap({
       filter: (page) =>
         !page.includes('page/') &&

.gitignore

@@ -24,3 +24,4 @@ playwright-report/
 playwright/.cache/
 **/tmp/
 public/theme.js
+src/lib/astro-redirect-from

README.md

@@ -24,7 +24,7 @@
   - [📝 GitHub changelog rendering](#-github-changelog-rendering)
   - [🌗 Theme Switcher](#-theme-switcher)
   - [💎 SVG assets as components](#-svg-assets-as-components)
-  - [`redirect_from`](#redirect_from)
+  - [astro-redirect-from](#astro-redirect-from)
   - [RSS \& JSON feeds](#rss--json-feeds)
 - [✨ Development](#-development)
   - [🔮 Linting](#-linting)
@@ -145,15 +145,11 @@ If you want to know how this works, have a look at the respective files:
 
 - [`scripts/create-icons/`](scripts/create-icons/)
 
-### `redirect_from`
+### astro-redirect-from
 
-Still a remnant of the old [Jekyll](https://jekyllrb.com) days, which survived in [gatsby-redirect-from](/gatsby-redirect-from/) and now works in Astro. For all post slugs defined in a `redirect_from` frontmatter key, redirects will be put in place by Astro.
+Still a remnant of the old [Jekyll](https://jekyllrb.com) days, which survived in [gatsby-redirect-from](https://kremalicious.com/gatsby-redirect-from/) and now works in Astro with [astro-redirect-from](https://kremalicious.com/astro-redirect-from/).
 
-Before building the site, a script scans all markdown files and creates a json file under `.config/redirects.json`. This file is then imported into `astro.config.ts` under its `redirects` option.
-
-If you want to know how, have a look at the respective files:
-
-- [`scripts/redirect-from.ts`](scripts/redirect-from.ts)
+For all post slugs defined in a `redirect_from` frontmatter key, redirects will be put in place by Astro.
 
 ### RSS & JSON feeds
 

content/articles/2020-05-22-gatsby-redirect-from/index.md

@@ -2,7 +2,7 @@
 date: 2020-05-22T14:08:00.367Z
 updated: 2020-05-23T11:35:12+02:00
 
-title: Redirect plugin for Markdown Pages in Gatsby
+title: Redirect Plugin for Markdown Pages in Gatsby
 image: ./gatsby-redirect-from-teaser.png
 changelog: kremalicious/gatsby-redirect-from
 

content/articles/2023-09-23-astro-redirect-from/index.md

@@ -0,0 +1,168 @@
+---
+date: 2023-09-23T19:20:50.153Z
+
+title: Redirect Plugin for Markdown Pages in Astro
+image: ./astro-redirect-from-teaser.png
+
+tags:
+  - astro
+  - development
+  - goodies
+
+changelog: kremalicious/astro-redirect-from
+toc: true
+---
+
+Integration plugin for [Astro](https://astro.build) to create redirects based on a list in your Markdown frontmatter, mimicking the behavior of [jekyll-redirect-from](https://github.com/jekyll/jekyll-redirect-from) and [gatsby-redirect-from](/gatsby-redirect-from).
+
+Imagine you've just revamped your blog, and some of your old URLs have changed. You don't want to lose the SEO juice, nor do you want to leave your readers with broken links. This is where redirects come into play. But managing redirects can be cumbersome, especially if you have to do it manually or through server configurations.
+
+This plugin automates this process by reading the `redirect_from` field in the frontmatter of your Markdown files and updating Astro's configuration to handle these redirects automatically.
+
+## How it Works
+
+By adding a `redirect_from` list in your Markdown frontmatter, the plugin integrates these redirects into Astro's [`redirects`](https://docs.astro.build/en/reference/configuration-reference/#redirects) configuration automatically, whether you're running the development server or building your project.
+
+The plugin operates during the [`astro:config:setup`](https://docs.astro.build/en/reference/integrations-reference/#astroconfigsetup) lifecycle hook. It scans all Markdown files for the `redirect_from` key and updates Astro's configuration using [`updateConfig()`](https://docs.astro.build/en/reference/integrations-reference/#updateconfig-option). This ensures that any existing redirects are merged with new ones generated by the plugin.
+
+Astro takes over from there, handling the redirects based on your site's build mode and in combination with any other integrations you might be using:
+
+> For statically-generated sites with no adapter installed, this will produce a client redirect using a `<meta http-equiv="refresh">` tag and does not support status codes.
+>
+> When using SSR or with a static adapter in `output: static` mode, status codes are supported. Astro will serve redirected `GET` requests with a status of `301` and use a status of `308` for any other request method.
+> [Astro Configuration Reference: redirects](https://docs.astro.build/en/reference/configuration-reference/#redirects)
+
+This plugin works with various Astro hosting integrations, most of them generate further redirect files in the places they require so this plugin works in combination with them:
+
+| Provider   | Plugin                                                                                   |
+| ---------- | ---------------------------------------------------------------------------------------- |
+| Netlify    | [@astrojs/netlify](https://docs.astro.build/en/guides/integrations-guide/netlify/)       |
+| Vercel     | [@astrojs/vercel](https://docs.astro.build/en/guides/integrations-guide/vercel/)         |
+| Cloudflare | [@astrojs/cloudflare](https://docs.astro.build/en/guides/integrations-guide/cloudflare/) |
+
+Because Astro integrations are run in the order they are defined in the `integrations` array, this plugin should come before any other integrations which make use of the `redirects` config.
+
+## Prerequisites
+
+The plugin is designed to work without configuration, especially if your project aligns with Astro's default settings.
+
+- Astro v3 (v2 probably works too, but is not tested)
+- Markdown files should be in a directory (default is `src/pages/`)
+- Slugs are extracted either from the frontmatter or the file/folder path
+
+## Installation
+
+```bash
+cd yourproject/
+
+# Using NPM
+npx astro add astro-redirect-from
+# Using Yarn
+yarn astro add astro-redirect-from
+# Using PNPM
+pnpm astro add astro-redirect-from
+```
+
+If installing manually:
+
+```bash
+npm i astro-redirect-from
+```
+
+Then load the plugin in your Astro config file, making sure this plugin comes before any other integrations which make use of the `redirects` config:
+
+```js title="astro.config.mjs"
+import { defineConfig } from 'astro/config'
+import redirectFrom from 'astro-redirect-from'
+
+export default defineConfig({
+  // ...
+  integrations: [
+    // make sure this is listed before any hosting integration
+    redirectFrom()
+  ]
+  // ...
+)}
+```
+
+That's it. Your redirects will be automatically added the next time you run `astro dev` or `astro build`. If any of them have a `redirect_from` field, that is.
+
+For easy debugging, a `redirect_from.json` is written out into Astro's `cacheDir` setting, which by default is under `node_modules/.astro`.
+
+[See Usage](#usage)
+
+### Options
+
+All options are optional and can be passed in Astro's config file:
+
+```js title="astro.config.mjs"
+import { defineConfig } from 'astro/config'
+import redirectFrom from 'astro-redirect-from'
+import { getMySlug } from './your-slug-function'
+
+export default defineConfig({
+  // ...
+  integrations: [
+    redirectFrom({
+      contentDir: './content',
+      getSlug: getMySlug
+    })
+  ]
+  // ...
+)}
+```
+
+#### `contentDir: string`
+
+_Default: `src/pages/`_
+
+Specify a different directory for your Markdown files, relative to the project root.
+
+#### `getSlug: (filePath: string) => string`
+
+_Default: `getSlugFromFilePath()`, see below_
+
+If you need a custom slug structure, pass a function to construct your slug from the file path. The file path should be relative to the content directory.
+
+If you use a `slug` field in your frontmatter, this will be preferred by the plugin and passing any `getSlug` function will have no effect in that case.
+
+The default function is a great starting point:
+
+```typescript
+function getSlugFromFilePath(filePath: string) {
+  const parsedPath = path.parse(filePath)
+  let slug
+
+  // construct slug as full path from either:
+  // - folder name if file name is index.md, or
+  // - file name
+  if (parsedPath.base === 'index.md' || parsedPath.base === 'index.mdx') {
+    slug = `/${parsedPath.dir}`
+  } else {
+    slug = `/${parsedPath.dir}/${parsedPath.name}`
+  }
+
+  return slug
+}
+```
+
+## Usage
+
+In your Markdown file's frontmatter, use the key `redirect_from` followed by a list.
+
+```yaml
+---
+redirect_from:
+  - /old-url-1
+  - /old-url-2
+  - /old-url-3.html
+---
+```
+
+## Check out & contribute
+
+Head over to GitHub to take a peek into the code, or to report some bugs.
+
+<p class="content-download">
+    <a class="icon-github btn btn-primary" href="https://github.com/kremalicious/astro-redirect-from">GitHub</a>
+</p>