Fixes #278

package.json

@@ -95,6 +95,7 @@
   "dependencies": {
     "@11ty/dependency-tree": "^2.0.0",
     "@iarna/toml": "^2.2.5",
+    "@sindresorhus/slugify": "^1.1.2",
     "browser-sync": "^2.26.14",
     "chalk": "^4.1.0",
     "chokidar": "^3.5.1",

src/Filters/Slug.js

@@ -1,8 +1,8 @@
 const slugify = require("slugify");
 
-module.exports = function(str) {
-  return slugify(str, {
+module.exports = function(str, options = {}) {
+  return slugify(str, Object.assign({
     replacement: "-",
     lower: true
-  });
+  }, options));
 };

src/Filters/Slugify.js

@@ -0,0 +1,5 @@
+const slugify = require("@sindresorhus/slugify");
+
+module.exports = function(str, options = {}) {
+  return slugify(str, options);
+};

src/defaultConfig.js

@@ -1,11 +1,15 @@
 const urlFilter = require("./Filters/Url");
 const serverlessUrlFilter = require("./Filters/ServerlessUrl");
 const slugFilter = require("./Filters/Slug");
+const slugifyFilter = require("./Filters/Slugify");
 const getCollectionItem = require("./Filters/GetCollectionItem");
 
 module.exports = function (config) {
   let eleventyConfig = this;
+
   config.addFilter("slug", slugFilter);
+  config.addFilter("slugify", slugifyFilter);
+
   config.addFilter("url", function (url, pathPrefixOverride) {
     let pathPrefix =
       pathPrefixOverride || eleventyConfig.getConfig().pathPrefix;

test/TemplateTest_Permalink.js

@@ -190,3 +190,22 @@ test("Reuse permalink in directory specific data file", async (t) => {
   t.is(await tmpl.getOutputPath(), "./dist/2016/01/01/index.html");
 });
 
+test("Using slugify filter!", async (t) => {
+  let tmpl = getNewTemplate(
+    "./test/slugify-filter/test.njk",
+    "./test/slugify-filter/",
+    "./dist"
+  );
+
+  t.is(await tmpl.getOutputPath(), "./dist/subdir/slug-love-candidate-lyublyu/index.html");
+});
+
+test("Using slugify filter with apostrophe", async (t) => {
+  let tmpl = getNewTemplate(
+    "./test/slugify-filter/apostrophe.njk",
+    "./test/slugify-filter/",
+    "./dist"
+  );
+
+  t.is(await tmpl.getOutputPath(), "./dist/subdir/hi-i-m-zach/index.html");
+});

test/slugify-filter/apostrophe.njk

@@ -0,0 +1,5 @@
+---
+title: "Hi I'm Zach"
+permalink: subdir/{{ title | slugify }}/index.html
+---
+Slugged.

test/slugify-filter/test.njk

@@ -0,0 +1,5 @@
+---
+title: _Slug ♥ CANDIDATE люблю $#%-
+permalink: subdir/{{ title | slugify }}/index.html
+---
+Slugged.