Adds Typescript definitions

lib/index.d.ts

@@ -0,0 +1,106 @@
+import Metalsmith from "metalsmith";
+
+export default permalinks;
+/**
+ * [Slugify options](https://github.com/simov/slugify#options)
+ */
+export type SlugifyOptions = {
+    /**
+     * extend known unicode symbols with a `{'char': 'replacement'}` object
+     */
+    extend: boolean;
+    /**
+     * replace spaces with replacement character, defaults to `-`
+     */
+    replacement?: string;
+    /**
+     * remove characters that match regex
+     */
+    remove?: RegExp;
+    /**
+     * convert to lower case, defaults to `true`
+     */
+    lower?: boolean;
+    /**
+     * strip special characters except replacement, defaults to `false`
+     */
+    strict?: boolean;
+    /**
+     * language code of the locale to use
+     */
+    locale?: string;
+    /**
+     * trim leading and trailing replacement chars, defaults to `true`
+     */
+    trim: boolean;
+};
+export type slugFunction = (filepath: string) => string;
+/**
+ * Linkset definition
+ */
+export type Linkset = {
+    /**
+     * Whether this linkset should be used as the default instead
+     */
+    isDefault?: boolean;
+    /**
+     * An object whose key:value pairs will be used to match files and transform their permalinks according to the rules in this linkset
+     */
+    match: {
+        [x: string]: any;
+    };
+    /**
+     * A permalink pattern to transform file paths into, e.g. `blog/:date/:title`
+     */
+    pattern: string;
+    /**
+     * [Slugify options](https://github.com/simov/slugify) or a custom slug function of the form `(pathpart) => string`
+     */
+    slug?: SlugifyOptions | slugFunction;
+    /**
+     * [Moment.js format string](https://momentjs.com/docs/#/displaying/format/) to transform Date link parts into, defaults to `YYYY/MM/DD`.
+     */
+    date?: string;
+};
+/**
+ * `@metalsmith/permalinks` options & default linkset
+ */
+export type Options = {
+    /**
+     * A permalink pattern to transform file paths into, e.g. `blog/:date/:title`
+     */
+    pattern?: string;
+    /**
+     * [Moment.js format string](https://momentjs.com/docs/#/displaying/format/) to transform Date link parts into, defaults to `YYYY/MM/DD`.
+     */
+    date?: string;
+    /**
+     * When `true` (by default), will duplicate sibling files so relative links keep working in resulting structure. Turn off by setting `false`. Can also be set to `folder`, which uses a strategy that considers files in folder as siblings if the folder is named after the html file.
+     */
+    relative?: boolean | 'folder';
+    /**
+     * Basename of the permalinked file (default: `index.html`)
+     */
+    indexFile?: string;
+    /**
+     * Set to `true` to add a number to duplicate permalinks (default: `false`), or specify a custom duplicate handling callback of the form `(permalink, files, file, options) => string`
+     */
+    unique?: boolean | Function;
+    /**
+     * Set to `true` to throw an error if multiple file path transforms result in the same permalink. `false` by default
+     */
+    duplicatesFail?: boolean;
+    /**
+     * An array of additional linksets
+     */
+    linksets?: Linkset[];
+    /**
+     * {@link SlugifyOptions} or a custom slug function of the form `(pathpart) => string`
+     */
+    slug?: SlugifyOptions | slugFunction;
+};
+/**
+ * Metalsmith plugin that renames files so that they're permalinked properly
+ * for a static site, aka that `about.html` becomes `about/index.html`.
+ */
+declare function permalinks(options: Options): Metalsmith.Plugin;

package.json

@@ -25,6 +25,7 @@
   "main": "lib/index.cjs",
   "module": "lib/index.js",
   "type": "module",
+  "types": "lib/index.d.ts",
   "exports": {
     "import": "./lib/index.js",
     "require": "./lib/index.cjs"

src/index.js

@@ -48,7 +48,7 @@ const error = debug.extend('error')
  * @property {boolean|Function} [unique] Set to `true` to add a number to duplicate permalinks (default: `false`), or specify a custom duplicate handling callback of the form `(permalink, files, file, options) => string`
  * @property {boolean} [duplicatesFail=false] Set to `true` to throw an error if multiple file path transforms result in the same permalink. `false` by default
  * @property {Linkset[]} [linksets] An array of additional linksets
- * @property {SlugifyOptions|slugFunction} [slug] [Slugify options](https://github.com/simov/slugify) or a custom slug function of the form `(pathpart) => string`
+ * @property {SlugifyOptions|slugFunction} [slug] {@link SlugifyOptions} or a custom slug function of the form `(pathpart) => string`
  */
 
 /** @type {Options} */