@static-pages/core 3.0.1 → 3.0.4

package/README.md

@@ -46,11 +46,11 @@ staticPages([{
         viewsDir: "path/to/views/folder",
         outDir: "path/to/output/folder",
     }),
-    controller: function(data) {
+    controller(data) {
         data.timestamp = new Date().toJSON(); // adds a "timestamp" variable
         return data; // returning the data is required if you want to send it to the renderer
     }
-},{
+}, {
     from: yamlReader({ // assume we have the home page data in yaml format.
         pattern: "home/*.yaml" // <-- reads home/en.yaml, home/de.yaml, home/fr.yaml etc.
     }),
@@ -59,27 +59,33 @@ staticPages([{
         viewsDir: "path/to/views/folder",
         outDir: "path/to/output/folder",
     }),
-    controller: function(data) {
+    controller(data) {
         data.commitHash = yourGetCommitHashFn();
         return data;
     }
-}]).catch(console.error);
+}])
+.catch(error => {
+    console.error('Error:', error);
+    console.error(error.stack);
+});
 ```
 
-## `staticPages(options: Options)`
-The `staticPages()` function expects one parameter which must be an array.
-Each item should contain `from`, `to` and optionally a `controller` property matching the definition below.
+## `staticPages(routes: Route | Route[])`
+The function expects the `routes` parameter to be an array. It is wrapped into an array automatically when other type is provided.
+Each item in this array should be an object containing a `from`, `to` and optionally a `controller` property matching the definition below.
 
 ```ts
 type Data = Record<string, unknown>;
-type Options = {
+type Route = {
     from: Iterable<Data> | AsyncIterable<Data>;
     to: (data: Data) => void | Promise<void>;
     controller?: (data: Data) => undefined | Data | Data[] | Promise<undefined | Data | Data[]>;
-}[];
+};
 ```
 
-> Additionally, when `Options` is not passed as an array, it is wrapped into an array.
+> Tip: Controllers may return an array of `Data` objects. Each data object will be rendered as a separate page.
+
+> Tip: Controllers may return `undefined` to prevent the rendering of the current data object.
 
 ## Missing a feature?
 Create an issue describing your needs. If it fits the scope of the project I will implement it or you can implement it your own and submit a pull request.

package/cjs/package.json

@@ -1,3 +1 @@
-{
-  "type": "commonjs"
-}
+{ "type": "commonjs" }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@static-pages/core",
-  "version": "3.0.1",
+  "version": "3.0.4",
   "description": "General purpose static pages renderer.",
   "type": "module",
-  "main": "./cjs/index.js",
-  "module": "./esm/index.js",
-  "browser": "./esm/index.js",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "types": "esm/index.d.ts",
   "exports": {
     ".": {
       "require": "./cjs/index.js",
@@ -13,15 +13,15 @@
     }
   },
   "scripts": {
-    "prepack": "npm run build",
+    "prepack": "npm run test",
     "build": "npm run build:esm && npm run build:cjs",
     "build:esm": "tsc",
-    "build:cjs": "tsc --outDir cjs --module commonjs",
     "watch:esm": "tsc --watch",
-    "watch:cjs": "tsc --watch --outDir cjs --module commonjs",
-    "test": "eslint src && npm run build && jest",
-    "coverage": "jest --coverage && cat ./coverage/lcov.info | coveralls",
-    "clean": "rimraf esm cjs/*.?s"
+    "build:cjs": "tsc --project tsconfig.cjs.json && echo { \"type\": \"commonjs\" }>cjs/package.json",
+    "watch:cjs": "npm run build:cjs && tsc --project tsconfig.cjs.json --watch",
+    "test": "eslint src && npm run build && cross-env NODE_OPTIONS=--experimental-vm-modules jest",
+    "coverage": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage && cat ./coverage/lcov.info | coveralls",
+    "clean": "rimraf esm cjs coverage"
   },
   "repository": {
     "type": "git",
@@ -45,12 +45,15 @@
   },
   "homepage": "https://staticpagesjs.github.io/",
   "devDependencies": {
+    "@types/jest": "^28.1.6",
     "@types/node": "^14.18.9",
     "@typescript-eslint/eslint-plugin": "^5.3.0",
     "@typescript-eslint/parser": "^5.3.0",
     "coveralls": "^3.1.1",
+    "cross-env": "^7.0.3",
     "eslint": "^8.1.0",
-    "jest": "^27.2.5",
+    "eslint-plugin-jest": "^26.6.0",
+    "jest": "^28.1.3",
     "rimraf": "^3.0.2",
     "typescript": "^4.4.4"
   }