@sphido/core 2.0.15 → 2.0.17

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Roman Ožana (https://ozana.cz/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/all-pages.js

@@ -1,9 +1,8 @@
 /**
  * Page generator that flatten pages structure
  *
- * @generator
- * @param {array} pages
- * @yields {name:string, path:string} next page in pages list
+ * @param {import('get-pages.js').Pages} pages
+ * @return {import('get-pages.js').Page}
  */
 export function * allPages(pages) {
 	for (const page of pages) {

package/lib/get-pages.js

@@ -4,10 +4,10 @@ import {isPage} from './is-page.js';
 
 /**
  * Retrieve an array tree of pages from path
- * @param {string} path
- * @param {function(dirent:Dirent, path:string)} include
- * @param {Object|function(page:{name:string, path:string}, dirent:Dirent, path:string)} extenders
- * @returns {Promise<Awaited<unknown>[{name:string, path:string}]>}
+ *
+ * @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});
@@ -26,6 +26,7 @@ export async function getPages({path = 'content', include = isPage} = {}, ...ext
 
 				// Calling callbacks in the series
 				for (const cb of extenders.filter(f => typeof f === 'function')) {
+					/** @type {ExtenderCallback} */
 					await cb(page, dirent, path);
 				}
 
@@ -33,3 +34,23 @@ export async function getPages({path = 'content', include = isPage} = {}, ...ext
 				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/is-page.js

@@ -6,7 +6,7 @@
  * - skip drafts files with underscore at the beginning
  * - accept only *.html and *.md files
  *
- * @param {Dirent} dirent
+ * @param {import('node:fs').Dirent} dirent
  * @returns {boolean}
  */
 export function isPage(dirent) {

package/package.json

@@ -1,49 +1,54 @@
 {
-  "name": "@sphido/core",
-  "version": "2.0.15",
-  "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": ">=14"
-  },
-  "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.1.1",
-    "ava": "^5.0.1",
-    "marked": "^4.1.1"
-  },
-  "scripts": {
-    "test": "ava"
-  },
-  "xo": {
-    "rules": {
-      "no-await-in-loop": 0
-    }
-  },
-  "gitHead": "b94220085ab26b902780388fcfc11233fb9dcf68"
+	"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"
 }

package/types/all-pages.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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

@@ -0,0 +1,8 @@
+/**
+ * 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

@@ -0,0 +1,21 @@
+/**
+ * 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/index.d.ts

@@ -0,0 +1,5 @@
+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/types/is-page.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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

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

package/types/write-file.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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/LICENSE.md

@@ -1,24 +0,0 @@
-MIT License
------------
-
-Copyright (c) 2022 Roman Ožana (https://ozana.cz/)
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.