@static-pages/core 7.0.0-alpha.2 → 7.0.0-alpha.4

package/README.md

@@ -128,66 +128,35 @@ interface CreateWriterOptions<T> {
     onError?(error: unknown): MaybePromise<void>;
 }
 
-interface Stats {
-	isFile(): boolean;
-	isDirectory(): boolean;
-}
-
-interface Dirent {
-	name: string;
-	path: string;
-	isFile(): boolean;
-	isDirectory(): boolean;
-}
-
 interface Filesystem {
-	readdir(
+	stat(
 		path: string | URL,
-		options: {
-			encoding: 'utf8';
-			withFileTypes: false;
-			recursive: boolean;
-		},
-		callback: (err: Error | null, files: string[]) => void,
+		callback: (err: Error | null, stats: { isFile(): boolean; isDirectory(): boolean; }) => void
 	): void;
 
 	readdir(
 		path: string | URL,
 		options: {
 			encoding: 'utf8';
-			withFileTypes: true;
+			withFileTypes: false;
 			recursive: boolean;
 		},
-		callback: (err: Error | null, files: Dirent[]) => void,
+		callback: (err: Error | null, files: string[]) => void,
 	): void;
 
-	readFile(
+	mkdir(
 		path: string | URL,
 		options: {
-			encoding: 'utf8';
+			recursive: true;
 		},
-		callback: (err: Error | null, data: string) => void
+		callback: (err: Error | null, path?: string) => void
 	): void;
 
 	readFile(
 		path: string | URL,
-		options: null,
 		callback: (err: Error | null, data: Uint8Array) => void
 	): void;
 
-	stat(
-		path: string | URL,
-		callback: (err: Error | null, stats: Stats) => void
-	): void;
-
-	mkdir(
-		path: string | URL,
-		options: {
-			recursive: true;
-		},
-		callback: (err: Error | null, path?: string) => void
-	): void;
-
 	writeFile(
 		path: string | URL,
 		data: string | Uint8Array,
@@ -203,7 +172,7 @@ When you use the `createReader` and `createWriter` interfaces to read and write
 ### `CreateReaderOptions` default parameters
 - `fs`: the nodejs `fs` module
 - `cwd`: `'pages'`
-- `parse`: automatically parse `json`, `yaml`, `yml`, `md` or `markdown` extensions with `yaml` and `gray-matter` packages.
+- `parse`: *see About the default `parse` function*
 - `onError`: `(err) => { throw err; }`
 
 ### `CreateWriterOptions` default parameters
@@ -213,6 +182,16 @@ When you use the `createReader` and `createWriter` interfaces to read and write
 - `render`: `(data) => data.content`
 - `onError`: `(err) => { throw err; }`
 
+### About the default `parse` function
+
+When using the default parser, a file type will be guessed by the file extension.
+These could be `json`, `yaml`, `yml`, `md` or `markdown`.
+- `json` will be parsed with `JSON.parse`
+- `yaml` and `yml` will be parsed with the `yaml` package
+- `md` and `markdown` will be parsed with the `gray-matter` package
+
+When the document does not contain an `url` property, this function will create one containing the filename without extension.
+
 
 ## `staticPages.with(defaults: Partial<Route>): { (...routes: Partial<Route>[]): Promise<void>; }`
 

package/cjs/create-reader.js

@@ -7,7 +7,6 @@ exports.createReader = void 0;
 const picomatch_1 = __importDefault(require("picomatch"));
 const autoparse_js_1 = require("./autoparse.js");
 const helpers_js_1 = require("./helpers.js");
-const node_path_1 = require("node:path");
 const node_fs_1 = __importDefault(require("node:fs"));
 async function* createReader({ fs = node_fs_1.default, cwd = 'pages', pattern, ignore, parse = autoparse_js_1.autoparse, onError = (error) => { throw error; }, } = {}) {
     if (!(0, helpers_js_1.isFilesystem)(fs))
@@ -25,13 +24,23 @@ async function* createReader({ fs = node_fs_1.default, cwd = 'pages', pattern, i
     if (typeof onError !== 'function')
         throw new TypeError(`Expected 'function', recieved '${(0, helpers_js_1.getType)(onError)}' at 'onError' property.`);
     let filenames = await new Promise((resolve, reject) => {
-        fs.readdir(cwd, { encoding: 'utf8', recursive: true, withFileTypes: true }, (err, files) => {
+        fs.readdir(cwd, { recursive: true, withFileTypes: false, encoding: 'utf8' }, (err, entries) => {
             if (err)
-                reject(err);
-            else
-                resolve(files
-                    .filter(x => x.isFile())
-                    .map(x => (0, node_path_1.join)((0, node_path_1.relative)(cwd, x.path), x.name)));
+                return reject(err);
+            let filtered = [];
+            let processed = 0;
+            for (const entry of entries) {
+                fs.stat(cwd + '/' + entry, (err, stats) => {
+                    if (err)
+                        return reject(err);
+                    if (stats.isFile()) {
+                        filtered.push(entry);
+                    }
+                    if (++processed === entries.length) {
+                        return resolve(filtered);
+                    }
+                });
+            }
         });
     });
     if (typeof pattern !== 'undefined' || typeof ignore !== 'undefined') {
@@ -47,7 +56,7 @@ async function* createReader({ fs = node_fs_1.default, cwd = 'pages', pattern, i
     for (const filename of filenames) {
         try {
             const content = await new Promise((resolve, reject) => {
-                fs.readFile((0, node_path_1.join)(cwd, filename), (err, data) => {
+                fs.readFile(cwd + '/' + filename, (err, data) => {
                     if (err)
                         reject(err);
                     else

package/cjs/create-writer.js

@@ -25,8 +25,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createWriter = void 0;
 const helpers_js_1 = require("./helpers.js");
-const node_path_1 = require("node:path");
 const nodeFs = __importStar(require("node:fs"));
+const node_path_1 = require("node:path");
 const defaultNamer = (data) => {
     if (!!data && typeof data === 'object' && 'url' in data && typeof data.url === 'string') {
         return data.url.concat('.html');

package/cjs/helpers.d.ts

@@ -1,26 +1,14 @@
 export type MaybePromise<T> = T | Promise<T>;
-interface Stats {
-    isFile(): boolean;
-    isDirectory(): boolean;
-}
-interface Dirent {
-    name: string;
-    path: string;
-    isFile(): boolean;
-    isDirectory(): boolean;
-}
 export interface Filesystem {
+    stat(path: string | URL, callback: (err: Error | null, stats: {
+        isFile(): boolean;
+        isDirectory(): boolean;
+    }) => void): void;
     readdir(path: string | URL, options: {
         encoding: 'utf8';
         withFileTypes: false;
         recursive: boolean;
     }, callback: (err: Error | null, files: string[]) => void): void;
-    readdir(path: string | URL, options: {
-        encoding: 'utf8';
-        withFileTypes: true;
-        recursive: boolean;
-    }, callback: (err: Error | null, files: Dirent[]) => void): void;
-    stat(path: string | URL, callback: (err: Error | null, stats: Stats) => void): void;
     mkdir(path: string | URL, options: {
         recursive: true;
     }, callback: (err: Error | null, path?: string) => void): void;
@@ -31,4 +19,3 @@ export declare const isFilesystem: (x: unknown) => x is Filesystem;
 export declare const isIterable: <T>(x: unknown) => x is Iterable<T>;
 export declare const isAsyncIterable: <T>(x: unknown) => x is AsyncIterable<T>;
 export declare const getType: (x: unknown) => string;
-export {};

package/esm/create-reader.js

@@ -1,7 +1,6 @@
 import picomatch from 'picomatch';
 import { autoparse } from './autoparse.js';
 import { getType, isIterable, isAsyncIterable, isFilesystem } from './helpers.js';
-import { join, relative } from 'node:path';
 import nodeFs from 'node:fs';
 export async function* createReader({ fs = nodeFs, cwd = 'pages', pattern, ignore, parse = autoparse, onError = (error) => { throw error; }, } = {}) {
     if (!isFilesystem(fs))
@@ -19,13 +18,23 @@ export async function* createReader({ fs = nodeFs, cwd = 'pages', pattern, ignor
     if (typeof onError !== 'function')
         throw new TypeError(`Expected 'function', recieved '${getType(onError)}' at 'onError' property.`);
     let filenames = await new Promise((resolve, reject) => {
-        fs.readdir(cwd, { encoding: 'utf8', recursive: true, withFileTypes: true }, (err, files) => {
+        fs.readdir(cwd, { recursive: true, withFileTypes: false, encoding: 'utf8' }, (err, entries) => {
             if (err)
-                reject(err);
-            else
-                resolve(files
-                    .filter(x => x.isFile())
-                    .map(x => join(relative(cwd, x.path), x.name)));
+                return reject(err);
+            let filtered = [];
+            let processed = 0;
+            for (const entry of entries) {
+                fs.stat(cwd + '/' + entry, (err, stats) => {
+                    if (err)
+                        return reject(err);
+                    if (stats.isFile()) {
+                        filtered.push(entry);
+                    }
+                    if (++processed === entries.length) {
+                        return resolve(filtered);
+                    }
+                });
+            }
         });
     });
     if (typeof pattern !== 'undefined' || typeof ignore !== 'undefined') {
@@ -41,7 +50,7 @@ export async function* createReader({ fs = nodeFs, cwd = 'pages', pattern, ignor
     for (const filename of filenames) {
         try {
             const content = await new Promise((resolve, reject) => {
-                fs.readFile(join(cwd, filename), (err, data) => {
+                fs.readFile(cwd + '/' + filename, (err, data) => {
                     if (err)
                         reject(err);
                     else

package/esm/create-writer.js

@@ -1,6 +1,6 @@
 import { getType, isIterable, isAsyncIterable, isFilesystem } from './helpers.js';
-import { dirname } from 'node:path';
 import * as nodeFs from 'node:fs';
+import { dirname } from 'node:path';
 const defaultNamer = (data) => {
     if (!!data && typeof data === 'object' && 'url' in data && typeof data.url === 'string') {
         return data.url.concat('.html');

package/esm/helpers.d.ts

@@ -1,26 +1,14 @@
 export type MaybePromise<T> = T | Promise<T>;
-interface Stats {
-    isFile(): boolean;
-    isDirectory(): boolean;
-}
-interface Dirent {
-    name: string;
-    path: string;
-    isFile(): boolean;
-    isDirectory(): boolean;
-}
 export interface Filesystem {
+    stat(path: string | URL, callback: (err: Error | null, stats: {
+        isFile(): boolean;
+        isDirectory(): boolean;
+    }) => void): void;
     readdir(path: string | URL, options: {
         encoding: 'utf8';
         withFileTypes: false;
         recursive: boolean;
     }, callback: (err: Error | null, files: string[]) => void): void;
-    readdir(path: string | URL, options: {
-        encoding: 'utf8';
-        withFileTypes: true;
-        recursive: boolean;
-    }, callback: (err: Error | null, files: Dirent[]) => void): void;
-    stat(path: string | URL, callback: (err: Error | null, stats: Stats) => void): void;
     mkdir(path: string | URL, options: {
         recursive: true;
     }, callback: (err: Error | null, path?: string) => void): void;
@@ -31,4 +19,3 @@ export declare const isFilesystem: (x: unknown) => x is Filesystem;
 export declare const isIterable: <T>(x: unknown) => x is Iterable<T>;
 export declare const isAsyncIterable: <T>(x: unknown) => x is AsyncIterable<T>;
 export declare const getType: (x: unknown) => string;
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@static-pages/core",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0-alpha.4",
   "description": "General purpose static pages renderer.",
   "type": "module",
   "main": "cjs/index.js",