@sphido/core 2.0.30 → 3.0.0

package/dist/all-pages.d.ts

@@ -0,0 +1,6 @@
+import type { Page, Pages } from "./index.js";
+/**
+ * Page generator that flatten pages structure
+ */
+export declare function allPages(pages: Pages): Generator<Page>;
+//# sourceMappingURL=all-pages.d.ts.map

package/dist/all-pages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"all-pages.d.ts","sourceRoot":"","sources":["../lib/all-pages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAE9C;;GAEG;AACH,wBAAiB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAQvD"}

package/dist/all-pages.js

@@ -0,0 +1,13 @@
+/**
+ * Page generator that flatten pages structure
+ */
+export function* allPages(pages) {
+    for (const page of pages) {
+        if (page?.children) {
+            yield* allPages(page.children);
+        }
+        else {
+            yield page;
+        }
+    }
+}

package/dist/copy-file.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Write content to the file and create directory if not exists
+ */
+export declare function copyFile(src: string, dest: string): Promise<void>;
+//# sourceMappingURL=copy-file.d.ts.map

package/dist/copy-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copy-file.d.ts","sourceRoot":"","sources":["../lib/copy-file.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,wBAAsB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGvE"}

package/dist/copy-file.js

@@ -0,0 +1,9 @@
+import { copyFile as copyFileAsync, mkdir } from "node:fs/promises";
+import { dirname } from "node:path";
+/**
+ * Write content to the file and create directory if not exists
+ */
+export async function copyFile(src, dest) {
+    await mkdir(dirname(dest), { recursive: true });
+    return copyFileAsync(src, dest);
+}

package/dist/get-pages.d.ts

@@ -0,0 +1,6 @@
+import type { Extenders, Options, Pages } from "./index.js";
+/**
+ * Retrieve an array tree of pages from path
+ */
+export declare function getPages({ path, include }?: Options, ...extenders: Extenders): Promise<Pages>;
+//# sourceMappingURL=get-pages.d.ts.map

package/dist/get-pages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-pages.d.ts","sourceRoot":"","sources":["../lib/get-pages.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAoB,SAAS,EAAE,OAAO,EAAQ,KAAK,EAAE,MAAM,YAAY,CAAC;AAGpF;;GAEG;AACH,wBAAsB,QAAQ,CAC7B,EAAE,IAAgB,EAAE,OAAgB,EAAE,GAAE,OAAY,EACpD,GAAG,SAAS,EAAE,SAAS,GACrB,OAAO,CAAC,KAAK,CAAC,CA2BhB"}

package/dist/get-pages.js

@@ -0,0 +1,28 @@
+import { readdir } from "node:fs/promises";
+import { join, parse } from "node:path";
+import { isPage } from "./is-page.js";
+/**
+ * Retrieve an array tree of pages from path
+ */
+export async function getPages({ path = "content", include = isPage } = {}, ...extenders) {
+    const dir = await readdir(path, { withFileTypes: true });
+    return Promise.all(dir
+        .filter((dirent) => include(dirent, path.toString()))
+        .map(async (dirent) => {
+        // Page object
+        const page = {
+            name: parse(dirent.name).name,
+            path: join(path.toString(), dirent.name),
+        };
+        // Read subdirectory recursively
+        if (dirent.isDirectory()) {
+            page.children = await getPages({ path: page.path, include }, ...extenders);
+        }
+        // Calling callbacks in the series
+        for (const cb of extenders.filter((f) => typeof f === "function")) {
+            await cb(page, dirent, path.toString());
+        }
+        // Assign objects with page
+        return Object.assign(page, ...extenders.filter((o) => typeof o === "object"));
+    }));
+}

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import type { Dirent, PathLike } from "node:fs";
+export { allPages } from "./all-pages.js";
+export { copyFile } from "./copy-file.js";
+export { getPages } from "./get-pages.js";
+export { readFile } from "./read-file.js";
+export { writeFile } from "./write-file.js";
+export type Extenders = Array<ExtenderCallback>;
+export type Page = {
+    name: string;
+    path: string;
+    content?: string;
+    children?: Pages;
+    [key: string]: any;
+};
+export type Pages = Array<Page>;
+export type Options = {
+    path?: PathLike;
+    include?: IncludePage;
+};
+export type ExtenderCallback = (page: Page, dirent: Dirent, path?: string) => Promise<void>;
+export type IncludePage = (dirent: Dirent, path?: string) => void;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAEhD,MAAM,MAAM,IAAI,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,KAAK,CAAC;IAEjB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;AAEhC,MAAM,MAAM,OAAO,GAAG;IAAE,IAAI,CAAC,EAAE,QAAQ,CAAC;IAAC,OAAO,CAAC,EAAE,WAAW,CAAA;CAAE,CAAC;AAEjE,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5F,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC"}

package/dist/is-page.d.ts

@@ -0,0 +1,11 @@
+import type { Dirent } from "node:fs";
+/**
+ * Default page filter
+ *
+ * - skip hidden files (starts with .)
+ * - skip hidden directories (starts with .)
+ * - skip drafts files with underscore (_) at the beginning
+ * - accept only *.html and *.md files
+ */
+export declare function isPage(dirent: Dirent): boolean;
+//# sourceMappingURL=is-page.d.ts.map

package/dist/is-page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-page.d.ts","sourceRoot":"","sources":["../lib/is-page.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAQ9C"}

package/dist/is-page.js

@@ -0,0 +1,16 @@
+/**
+ * Default page filter
+ *
+ * - skip hidden files (starts with .)
+ * - skip hidden directories (starts with .)
+ * - skip drafts files with underscore (_) at the beginning
+ * - accept only *.html and *.md files
+ */
+export function isPage(dirent) {
+    // Accept only *.md, *.html files
+    if (dirent.isFile() && !dirent.name.startsWith("_") && !dirent.name.startsWith(".")) {
+        return dirent.name.endsWith(".md") || dirent.name.endsWith(".html");
+    }
+    // Or not hidden directory
+    return dirent.isDirectory() && !dirent.name.startsWith(".");
+}

package/dist/read-file.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Read file content as string
+ */
+export declare function readFile(path: string): Promise<string>;
+//# sourceMappingURL=read-file.d.ts.map

package/dist/read-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-file.d.ts","sourceRoot":"","sources":["../lib/read-file.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAE5D"}

package/dist/read-file.js

@@ -0,0 +1,7 @@
+import { readFile as readFileAsync } from "node:fs/promises";
+/**
+ * Read file content as string
+ */
+export async function readFile(path) {
+    return readFileAsync(path, "utf8");
+}

package/dist/write-file.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Write content to the file and create directory if not exists
+ */
+export declare function writeFile(file: string, content: string): Promise<void>;
+//# sourceMappingURL=write-file.d.ts.map

package/dist/write-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"write-file.d.ts","sourceRoot":"","sources":["../lib/write-file.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG5E"}

package/dist/write-file.js

@@ -0,0 +1,9 @@
+import { mkdir, writeFile as writeFileAsync } from "node:fs/promises";
+import { dirname } from "node:path";
+/**
+ * Write content to the file and create directory if not exists
+ */
+export async function writeFile(file, content) {
+    await mkdir(dirname(file), { recursive: true });
+    return writeFileAsync(file, content);
+}

package/package.json

@@ -1,17 +1,21 @@
 {
   "name": "@sphido/core",
-  "version": "2.0.30",
+  "version": "3.0.0",
   "author": "Roman Ožana <roman@ozana.cz> (https://ozana.cz)",
   "homepage": "https://sphido.cz",
   "repository": "sphido/sphido",
   "license": "MIT",
   "description": "A rocket 🚀 fast, lightweight, static site generator",
   "type": "module",
-  "exports": "./lib/index.js",
   "engines": {
-    "node": ">=16"
+    "node": ">=22"
   },
-  "types": "types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": "./dist/index.js",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.js",
   "keywords": [
     "markdown",
     "markup",
@@ -26,21 +30,13 @@
   ],
   "bugs": "https://github.com/sphido/sphido/issues",
   "devDependencies": {
-    "@sindresorhus/slugify": "^2.2.1",
-    "ava": "^6.1.2",
-    "marked": "^13.0.2"
+    "@sindresorhus/slugify": "^3.0.0",
+    "marked": "^16.4.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.17"
   },
   "scripts": {
-    "test": "ava",
-    "types": "tsc lib/*.js --declaration --allowJs --emitDeclarationOnly --outDir types"
-  },
-  "xo": {
-    "ignores": [
-      "types/**"
-    ],
-    "rules": {
-      "no-await-in-loop": 0
-    }
-  },
-  "gitHead": "7868b45b174ec545fd47df09e57a41df9786dfe5"
-}
+    "test": "vitest run --passWithNoTests",
+    "build": "rm -rf dist/* && tsc"
+  }
+}

package/readme.md

@@ -1,59 +1,59 @@
 # @sphido/core
 
-Sphido core package contains two most important function `getPages()` and `allPages()`.
-The `getPages()` function scans directories for all `*.md` and `*.html` files.
-Second function `allPages()` is [generator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator)
-that allow to iterate over all pages.
+Sphido core package contains the two most important functions `getPages()` and `allPages()`. The `getPages()` function scans
+directories for all `*.md` and `*.html` files. The second function, `allPages()`,
+is a [generator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator)
+that allows you to iterate over all pages.
 
 ```javascript
-const pages = await getPages({path: 'content'}, /* ...exteners */);
+const pages = await getPages({path: 'content'}, /* ...extenders */);
 ```
 
-Returned structure is very simple and looks like follow:
+The returned structure is very simple and looks as follows:
 
 ```json
 [
-  {
-    "name": "Main page",
-    "path": "content/Main page.md"
-  },
-  {
-    "name": "Directory",
-    "children": [
-      {
-        "name": "Subpage one",
-        "path": "content/Directory/Subpage one.md"
-      },
-      {
-        "name": "Subpage two",
-        "path": "content/Directory/Subpage two.md"
-      }
-    ]
-  }
+	{
+		"name": "Main page",
+		"path": "content/Main page.md"
+	},
+	{
+		"name": "Directory",
+		"children": [
+			{
+				"name": "Subpage one",
+				"path": "content/Directory/Subpage one.md"
+			},
+			{
+				"name": "Subpage two",
+				"path": "content/Directory/Subpage two.md"
+			}
+		]
+	}
 ]
 ```
 
-Then iterate over pages like follow:
+Then iterate over the pages like this:
 
 ```javascript
 for (const page of allPages(pages)) {
-  console.log(page);
+	console.log(page);
 }
 ```
 
 ## Extending `page` object
 
-Every single `page` object inside structure can be modified with extender. Extenders are set as additional parameters of the `getPages()` function.
-There are two types of extenders:
+Every single `page` object inside structure can be modified with extender. Extenders are set as additional parameters of
+the `getPages()` function. There are two types of extenders:
 
 ### *Callback* extenders
 
-Callback extender is a function that is called during recursion over each page with three
-parameters passed to the function `page`, `path` and [`dirent`](https://nodejs.org/api/fs.html#class-fsdirent).
+Callback extender is a function that is called during recursion over each page with three parameters passed to the
+function `page`, `path` and [`dirent`](https://nodejs.org/api/fs.html#class-fsdirent).
 
 ```javascript
 const callbackExtender = (page, path, dirent) => {
-  // do anything with page object
+	// do anything with page object
 }
 
 const pages = await getPages({path: 'content'}, callbackExtender);
@@ -61,23 +61,24 @@ const pages = await getPages({path: 'content'}, callbackExtender);
 
 ### *Object* extenders
 
-This extender is just a simple JavaScript object that is combined with the `page` object using the  [Object.assign()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) function.
+This extender is just a simple JavaScript object that is combined with the `page` object using
+the  [Object.assign()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)
+function.
 
 ```javascript
 const objectExtender = {
-  author: 'Roman Ožana'
+	author: 'Roman Ožana'
 }
 
 const pages = await getPages({path: 'content'}, objectExtender);
 ```
 
-There is no limit to the number of extenders, you can combine as many as you want.
-Let's have the following code:
+There is no limit to the number of extenders, you can combine as many as you want. Let's have the following code:
 
 ```javascript
 const extenders = [
 
-	// callback extenders will be called during iteration ony by one
+	// callback extenders will be called during iteration one by one
 
 	(page) => {
 		// add property
@@ -91,13 +92,13 @@ const extenders = [
 	},
 
 	// callback extenders are called in the series
-  
+
 	(page) => {
 		page.counter++;
 	},
 
 	// object extender will be merged with page object
-  
+
 	{
 		"author": "Roman Ožana",
 		"getLink": function () {
@@ -113,47 +114,50 @@ then you get this structure:
 
 ```json
 [
-  {
-    "name": "Main page",
-    "path": "content/Main page.md",
-    "title": "Main page | my best website",
-    "counter": 2,
-    "author": "Roman Ožana",
-    "getDate": "[Function: getDate]",
-    "getLink": "[Function: getLink]"
-  }
+	{
+		"name": "Main page",
+		"path": "content/Main page.md",
+		"title": "Main page | my best website",
+		"counter": 2,
+		"author": "Roman Ožana",
+		"getDate": "[Function: getDate]",
+		"getLink": "[Function: getLink]"
+	}
 ]
 ```
 
 ## Installation
 
+Requires [Node.js](https://nodejs.org/) 22 or newer.
+
 ```bash
-yarn add @sphido/core
+pnpm add @sphido/core
 ```
 
 ## Example
 
-Following example read all `*.md` files in `content` directory and process them with [marked](https://github.com/markedjs/marked) to HTML files
+The following example reads all `*.md` files in the `content` directory and processes them
+with [marked](https://github.com/markedjs/marked) into HTML files.
 
 ```javascript
 #!/usr/bin/env node
 
-import {dirname, relative, join} from 'node:path';
-import {getPages, allPages, readFile, writeFile} from '@sphido/core';
+import { dirname, relative, join } from 'node:path';
+import { getPages, allPages, readFile, writeFile } from '@sphido/core';
 import slugify from '@sindresorhus/slugify';
-import {marked} from 'marked';
+import { marked } from 'marked';
 
 const pages = await getPages({path: 'content'}, // ... extenders
-  (page) => {
-    page.slug = slugify(page.name) + '.html';
-    page.dir = dirname(page.path);
-  });
+	(page) => {
+		page.slug = slugify(page.name) + '.html';
+		page.dir = dirname(page.path);
+	});
 
 for (const page of allPages(pages)) {
-  page.output = join('public', relative('content', page.dir), page.slug);
-  page.content = marked(await readFile(page.path));
+	page.output = join('public', relative('content', page.dir), page.slug);
+	page.content = marked(await readFile(page.path));
 
-  await writeFile(page.output, `<!DOCTYPE html>
+	await writeFile(page.output, `<!DOCTYPE html>
 		<html lang="en" dir="ltr">
 		<head>
 			<meta charset="UTF-8">
@@ -167,6 +171,6 @@ for (const page of allPages(pages)) {
 }
 ```
 
-## Source codes
+## Source code
 
 [@sphido/core](https://github.com/sphido/sphido/tree/main/packages/sphido-core)

package/lib/all-pages.js

@@ -1,15 +0,0 @@
-/**
- * Page generator that flatten pages structure
- *
- * @param {import('get-pages.js').Pages} pages
- * @return {import('get-pages.js').Page}
- */
-export function * allPages(pages) {
-	for (const page of pages) {
-		if (page?.children) {
-			yield * allPages(page.children);
-		} else {
-			yield page;
-		}
-	}
-}

package/lib/copy-file.js

@@ -1,15 +0,0 @@
-import {copyFile as copyFileAsync} from 'node:fs/promises';
-import {dirname} from 'node:path';
-import {mkdir} from 'node:fs/promises';
-
-/**
- * Write content to the file and create directory if not exists
- *
- * @param {string} src
- * @param {string} dest
- * @returns {Promise<*>}
- */
-export async function copyFile(src, dest) {
-	await mkdir(dirname(dest), {recursive: true});
-	return copyFileAsync(src, dest);
-}

package/lib/get-pages.js

@@ -1,56 +0,0 @@
-import {join, parse} from 'node:path';
-import {readdir} from 'node:fs/promises';
-import {isPage} from './is-page.js';
-
-/**
- * Retrieve an array tree of pages from path
- *
- * @param {Options}
- * @param {Extenders} extenders
- * @return {Promise<Awaited<Pages>[]>}
- */
-export async function getPages({path = 'content', include = isPage} = {}, ...extenders) {
-  const dir = await readdir(path, {withFileTypes: true});
-
-  return Promise.all(
-    dir
-      .filter(dirent => include(dirent, path))
-      .map(async dirent => {
-        // Page object
-        const page = {name: parse(dirent.name).name, path: join(path, dirent.name)};
-
-        // Read subdirectory recursively
-        if (dirent.isDirectory()) {
-          page.children = await getPages({path: page.path, include}, ...extenders);
-        }
-
-        // Calling callbacks in the series
-        for (const cb of extenders.filter(f => typeof f === 'function')) {
-          /** @type {ExtenderCallback} */
-          await cb(page, dirent, path);
-        }
-
-        // Assign objects with page
-        return Object.assign(page, ...extenders.filter(o => typeof o === 'object'));
-      }));
-}
-
-/**
- * @typedef {Array.<Object|ExtenderCallback>} Extenders
- * @typedef {Array.<Page>} Pages
- * @typedef {{name: string, path: string, children?: Pages}} Page
- * @typedef {{path: string, include?: IncludePage}} Options
- */
-
-/**
- * @callback ExtenderCallback
- * @param {Page} page
- * @param {import('node:fs').Dirent} dirent
- * @param {string=} path
- */
-
-/**
- * @callback IncludePage
- * @param {import('node:fs').Dirent} dirent
- * @param {string=} path
- */

package/lib/index.js

@@ -1,5 +0,0 @@
-export {getPages} from './get-pages.js';
-export {allPages} from './all-pages.js';
-export {readFile} from './read-file.js';
-export {writeFile} from './write-file.js';
-export {copyFile} from './copy-file.js';

package/lib/is-page.js

@@ -1,20 +0,0 @@
-/**
- * Default page filter
- *
- * - skip hidden files (starts with .)
- * - skip and directories (starts with .)
- * - skip drafts files with underscore (_) at the beginning
- * - accept only *.html and *.md files
- *
- * @param {import('node:fs').Dirent} dirent
- * @returns {boolean}
- */
-export function isPage(dirent) {
-  // Accept only *.md, *.html files
-  if (dirent.isFile() && !dirent.name.startsWith('_') && !dirent.name.startsWith('.')) {
-    return dirent.name.endsWith('.md') || dirent.name.endsWith('.html');
-  }
-
-  // Or not hidden directory
-  return dirent.isDirectory() && !dirent.name.startsWith('.');
-}

package/lib/read-file.js

@@ -1,10 +0,0 @@
-import {readFile as readFileAsync} from 'node:fs/promises';
-
-/**
- * Read file content as string
- * @param {string} path
- * @returns {Promise<*>}
- */
-export async function readFile(path) {
-	return readFileAsync(path, 'utf8');
-}

package/lib/write-file.js

@@ -1,15 +0,0 @@
-import {writeFile as writeFileAsync} from 'node:fs/promises';
-import {dirname} from 'node:path';
-import {mkdir} from 'node:fs/promises';
-
-/**
- * Write content to the file and create directory if not exists
- *
- * @param {string} file
- * @param {string} content
- * @returns {Promise<*>}
- */
-export async function writeFile(file, content) {
-  await mkdir(dirname(file), {recursive: true});
-  return writeFileAsync(file, content);
-}

package/types/all-pages.d.ts

@@ -1,7 +0,0 @@
-/**
- * Page generator that flatten pages structure
- *
- * @param {import('get-pages.js').Pages} pages
- * @return {import('get-pages.js').Page}
- */
-export function allPages(pages: any): any;

package/types/copy-file.d.ts

@@ -1,8 +0,0 @@
-/**
- * Write content to the file and create directory if not exists
- *
- * @param {string} src
- * @param {string} dest
- * @returns {Promise<*>}
- */
-export function copyFile(src: string, dest: string): Promise<any>;

package/types/get-pages.d.ts

@@ -1,21 +0,0 @@
-/**
- * Retrieve an array tree of pages from path
- *
- * @param {Options}
- * @param {Extenders} extenders
- * @return {Promise<Awaited<Pages>[]>}
- */
-export function getPages({ path, include }?: Options, ...extenders: Extenders): Promise<Awaited<Pages>[]>;
-export type Extenders = Array<any | ExtenderCallback>;
-export type Pages = Array<Page>;
-export type Page = {
-    name: string;
-    path: string;
-    children?: Page[];
-};
-export type Options = {
-    path: string;
-    include?: IncludePage;
-};
-export type ExtenderCallback = (page: Page, dirent: import('node:fs').Dirent, path?: string | undefined) => any;
-export type IncludePage = (dirent: import('node:fs').Dirent, path?: string | undefined) => any;

package/types/is-page.d.ts

@@ -1,12 +0,0 @@
-/**
- * Default page filter
- *
- * - skip hidden files (starts with .)
- * - skip and directories (starts with .)
- * - skip drafts files with underscore (_) at the beginning
- * - accept only *.html and *.md files
- *
- * @param {import('node:fs').Dirent} dirent
- * @returns {boolean}
- */
-export function isPage(dirent: import('node:fs').Dirent): boolean;

package/types/read-file.d.ts

@@ -1,6 +0,0 @@
-/**
- * Read file content as string
- * @param {string} path
- * @returns {Promise<*>}
- */
-export function readFile(path: string): Promise<any>;

package/types/write-file.d.ts

@@ -1,8 +0,0 @@
-/**
- * Write content to the file and create directory if not exists
- *
- * @param {string} file
- * @param {string} content
- * @returns {Promise<*>}
- */
-export function writeFile(file: string, content: string): Promise<any>;

package/{types/index.d.ts → dist/index.js}

@@ -1,5 +1,5 @@
-export { getPages } from "./get-pages.js";
 export { allPages } from "./all-pages.js";
+export { copyFile } from "./copy-file.js";
+export { getPages } from "./get-pages.js";
 export { readFile } from "./read-file.js";
 export { writeFile } from "./write-file.js";
-export { copyFile } from "./copy-file.js";