@flyewi/eleventy-plugin-redirects 0.2.0 → 0.3.1

package/README.md

@@ -37,7 +37,7 @@ By default this writes an `_redirects` file into your output directory after eve
 | `defaultStatus` | `301` | Status code used when an entry doesn't specify one. |
 | `netlify` | `true` | Write a Netlify `_redirects` file. |
 | `netlifyFile` | `"_redirects"` | Filename for the Netlify output, relative to the output directory. |
-| `apache` | `false` | Write an Apache `.htaccess` with `Redirect` directives. |
+| `apache` | `false` | Write an Apache `.htaccess` with exact-match `RedirectMatch` directives. |
 | `apacheFile` | `".htaccess"` | Filename for the Apache output. |
 | `html` | `false` | Also write a static HTML fallback page at each `from` URL (meta-refresh + `rel=canonical`), for hosts (e.g. GitHub Pages) that can't act on `_redirects`/`.htaccess`. |
 | `htmlLang` | `"en"` | `lang` attribute of the HTML fallback pages. |
@@ -56,10 +56,16 @@ If your output directory already contains an `_redirects` file (e.g. copied thro
 ## Apache output
 
 ```
-Redirect 301 /old-path/ /new-path/
-Redirect 302 /legacy-page/ /new-page/
+RedirectMatch 301 ^/old-path/$ /new-path/
+RedirectMatch 302 ^/legacy-page/$ /new-page/
 ```
 
+Each rule matches its path **exactly**, the same as in Netlify's `_redirects`: `/old-path/` redirects, `/old-path/sub/` does not. Regex characters in the path (e.g. the `.` in `/old.html`) are escaped, and paths containing spaces are quoted. The query string is passed on to the target unchanged.
+
+> **Changed in 0.3.0:** earlier versions wrote `Redirect` directives, which Apache treats as a *prefix* match (`/old-path/` also redirected `/old-path/anything` to `/new-path/anything`). If you relied on that, add the deeper paths as separate entries.
+
+Requires `mod_alias`, which is enabled on practically every Apache host, and `.htaccess` overrides (`AllowOverride FileInfo`) — on shared hosting this is usually the case.
+
 ## HTML fallback pages
 
 With `html: true`, each `from` path also gets a real HTML file at that URL (e.g. `/old-path/` → `old-path/index.html` in the output directory) containing:
@@ -74,6 +80,10 @@ The script redirects immediately and keeps the URL fragment (`/old-path/#section
 
 This is a static fallback for platforms without server-side redirect support — a real `_redirects`/`.htaccess` (or your host/CDN's redirect rules) is always the better option when available, since the HTML approach is a moment slower and depends on the browser executing the refresh.
 
+## Contributing
+
+Issues and pull requests are welcome. For how releases are published, see [RELEASING.md](RELEASING.md).
+
 ## License
 
 MIT

package/lib/formats.js

@@ -4,8 +4,28 @@ function toNetlify(list) {
   return list.map(({ from, to, status }) => `${from}  ${to}  ${status}`).join("\n") + "\n";
 }
 
+function escapeRegex(str) {
+  return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+
+// Apache splits directive arguments on whitespace; quote those that contain it.
+function apacheArg(str) {
+  return /[\s"]/.test(str) ? `"${str.replace(/"/g, '\\"')}"` : str;
+}
+
+// RedirectMatch with an anchored, escaped pattern matches the path exactly,
+// like Netlify's _redirects. Plain `Redirect` would be a prefix match
+// (/old/ would also catch /old/anything), so the same config would behave
+// differently depending on the host.
 function toApache(list) {
-  return list.map(({ from, to, status }) => `Redirect ${status} ${from} ${to}`).join("\n") + "\n";
+  return (
+    list
+      .map(({ from, to, status }) => {
+        const pattern = apacheArg(`^${escapeRegex(from)}$`);
+        return `RedirectMatch ${status} ${pattern} ${apacheArg(to)}`;
+      })
+      .join("\n") + "\n"
+  );
 }
 
 function escapeAttr(str) {

package/lib/redirects.js

@@ -52,7 +52,7 @@ module.exports = function redirectsPlugin(eleventyConfig, userOptions = {}) {
       // Preserve (and prepend ahead of) any existing .htaccess content, e.g.
       // hand-maintained directives (ErrorDocument, mod_deflate, mod_expires)
       // brought in via a static passthrough copy — this plugin only owns the
-      // Redirect lines, not the whole file.
+      // RedirectMatch lines, not the whole file.
       const existing = readExisting(apachePath);
       fs.writeFileSync(apachePath, toApache(list) + existing);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyewi/eleventy-plugin-redirects",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Eleventy plugin that generates Netlify _redirects, Apache .htaccess, and static HTML fallback pages from a single redirects config.",
   "main": "lib/redirects.js",
   "type": "commonjs",