@sphido/core 2.0.17 → 2.0.21

package/lib/copy-file.js

@@ -1,6 +1,6 @@
-import {mkdir, copyFile as copyFileSync} from 'node:fs/promises';
-import {existsSync} from 'node:fs';
+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
@@ -10,9 +10,6 @@ import {dirname} from 'node:path';
  * @returns {Promise<*>}
  */
 export async function copyFile(src, dest) {
-	if (!existsSync(dirname(dest))) {
-		await mkdir(dirname(dest), {recursive: true});
-	}
-
-	return copyFileSync(src, dest);
+	await mkdir(dirname(dest), {recursive: true});
+	return copyFileAsync(src, dest);
 }

package/lib/get-pages.js

@@ -10,29 +10,29 @@ import {isPage} from './is-page.js';
  * @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
-				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'));
-			}));
+  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'));
+      }));
 }
 
 /**

package/lib/is-page.js

@@ -3,18 +3,18 @@
  *
  * - skip hidden files (starts with .)
  * - skip and directories (starts with .)
- * - skip drafts files with underscore at the beginning
+ * - 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');
-	}
+  // 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('.');
+  // Or not hidden directory
+  return dirent.isDirectory() && !dirent.name.startsWith('.');
 }

package/lib/write-file.js

@@ -1,6 +1,6 @@
-import {mkdir, writeFile as writeFileAsync} from 'node:fs/promises';
-import {existsSync} from 'node:fs';
+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
@@ -10,9 +10,6 @@ import {dirname} from 'node:path';
  * @returns {Promise<*>}
  */
 export async function writeFile(file, content) {
-	if (!existsSync(dirname(file))) {
-		await mkdir(dirname(file), {recursive: true});
-	}
-
-	return writeFileAsync(file, content);
+  await mkdir(dirname(file), {recursive: true});
+  return writeFileAsync(file, content);
 }

package/package.json

@@ -1,54 +1,53 @@
 {
-	"name": "@sphido/core",
-	"version": "2.0.17",
-	"author": {
-		"name": "Roman Ožana",
-		"email": "roman@ozana.cz",
-		"url": "https://ozana.cz"
-	},
-	"license": "MIT",
-	"description": "A rocket 🚀 fast, lightweight, static site generator",
-	"type": "module",
-	"exports": "./lib/index.js",
-	"engines": {
-		"node": ">=16"
-	},
-	"types": "types/index.d.ts",
-	"keywords": [
-		"markdown",
-		"markup",
-		"content management system",
-		"cms",
-		"static",
-		"static site generator",
-		"generator",
-		"framework",
-		"numjucks",
-		"blog",
-		"scaffold"
-	],
-	"homepage": "https://sphido.org",
-	"bugs": "https://github.com/sphido/sphido/issues",
-	"repository": {
-		"type": "git",
-		"url": "git@github.com:sphido/sphido.git"
-	},
-	"devDependencies": {
-		"@sindresorhus/slugify": "^2.2.0",
-		"ava": "^5.2.0",
-		"marked": "^4.2.12"
-	},
-	"scripts": {
-		"test": "ava",
-		"types": "tsc lib/*.js --declaration --allowJs --emitDeclarationOnly --outDir types"
-	},
-	"xo": {
-		"ignores": [
-			"types/**"
-		],
-		"rules": {
-			"no-await-in-loop": 0
-		}
-	},
-	"gitHead": "6d977aa261aecb80b4221c9af8ff61e8756a9456"
+  "name": "@sphido/core",
+  "version": "2.0.21",
+  "author": {
+    "name": "Roman Ožana",
+    "email": "roman@ozana.cz",
+    "url": "https://ozana.cz"
+  },
+  "license": "MIT",
+  "description": "A rocket 🚀 fast, lightweight, static site generator",
+  "type": "module",
+  "exports": "./lib/index.js",
+  "engines": {
+    "node": ">=16"
+  },
+  "types": "types/index.d.ts",
+  "keywords": [
+    "markdown",
+    "markup",
+    "content management system",
+    "cms",
+    "static",
+    "static site generator",
+    "generator",
+    "framework",
+    "blog",
+    "scaffold"
+  ],
+  "homepage": "https://sphido.org",
+  "bugs": "https://github.com/sphido/sphido/issues",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:sphido/sphido.git"
+  },
+  "devDependencies": {
+    "@sindresorhus/slugify": "^2.2.1",
+    "ava": "^5.3.1",
+    "marked": "^9.1.3"
+  },
+  "scripts": {
+    "test": "ava",
+    "types": "tsc lib/*.js --declaration --allowJs --emitDeclarationOnly --outDir types"
+  },
+  "xo": {
+    "ignores": [
+      "types/**"
+    ],
+    "rules": {
+      "no-await-in-loop": 0
+    }
+  },
+  "gitHead": "59185f7c4e4708ba554fe8efcdc7398ec0a669f9"
 }

package/readme.md

@@ -13,23 +13,23 @@ Returned structure is very simple and looks like follow:
 
 ```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"
+      }
+    ]
+  }
 ]
 ```
 
@@ -37,7 +37,7 @@ Then iterate over pages like follow:
 
 ```javascript
 for (const page of allPages(pages)) {
-	console.log(page);
+  console.log(page);
 }
 ```
 
@@ -53,7 +53,7 @@ parameters passed to the function `page`, `path` and [`dirent`](https://nodejs.o
 
 ```javascript
 const callbackExtender = (page, path, dirent) => {
-	// do anything with page object
+  // do anything with page object
 }
 
 const pages = await getPages({path: 'content'}, callbackExtender);
@@ -65,7 +65,7 @@ This extender is just a simple JavaScript object that is combined with the `page
 
 ```javascript
 const objectExtender = {
-	author: 'Roman Ožana'
+  author: 'Roman Ožana'
 }
 
 const pages = await getPages({path: 'content'}, objectExtender);
@@ -113,15 +113,15 @@ 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]"
+  }
 ]
 ```
 
@@ -144,16 +144,16 @@ import slugify from '@sindresorhus/slugify';
 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">
@@ -163,7 +163,7 @@ for (const page of allPages(pages)) {
 		<body class="prose mx-auto my-6">${page.content}</body>
 		<!-- Generated by Sphido from ${page.path} -->
 		</html>
-	`);
+  `);
 }
 ```
 

package/types/is-page.d.ts

@@ -3,7 +3,7 @@
  *
  * - skip hidden files (starts with .)
  * - skip and directories (starts with .)
- * - skip drafts files with underscore at the beginning
+ * - skip drafts files with underscore (_) at the beginning
  * - accept only *.html and *.md files
  *
  * @param {import('node:fs').Dirent} dirent