@griddo/cx 10.4.2 → 10.4.3

package/exporter/utils/store.ts

@@ -12,8 +12,8 @@ import { removeProperties, walk } from "./shared";
 import { Site } from "../types/sites";
 
 /**
- * Read all pages stored in `store` Griddo folder and return one by one with a
- * generator.
+ * Read all pages stored in `store` Griddo directory and return one by one with
+ * a generator.
  */
 async function* getBuildPages<PageType extends GriddoPageObject>(
 	basePath: string
@@ -56,12 +56,12 @@ function getBuildMetadata(basePath: string): BuildMetaData {
 }
 
 /**
- * Creates an `store` folder to store pages transformed by createStore
+ * Creates an `store` dir to store pages transformed by createStore
  */
-function createStoreFolder(storeFolder: string) {
-	if (!fs.existsSync(storeFolder)) {
-		fs.mkdirSync(storeFolder);
-		fs.mkdirSync(path.resolve(storeFolder, "metadata"));
+function createStoreDir(storeDir: string) {
+	if (!fs.existsSync(storeDir)) {
+		fs.mkdirSync(storeDir);
+		fs.mkdirSync(path.resolve(storeDir, "metadata"));
 	}
 
 	console.info("Store initialized");
@@ -69,7 +69,7 @@ function createStoreFolder(storeFolder: string) {
 
 /**
  * Write render info into a file.
- * @param basePath - Absolute path of the folder from which files will be saved.
+ * @param basePath - Absolute path of the dir from which files will be saved.
  * @param renderInfo - Data that will be saved related to the render process.
  */
 function saveRenderInfoInStore(basePath: string, renderInfo: RenderInfo) {
@@ -80,26 +80,26 @@ function saveRenderInfoInStore(basePath: string, renderInfo: RenderInfo) {
 }
 
 /**
- * Return an array of ids only from `.json` files (no dirs) in the `basePath` folder based in the file name and filtered by the pages ids in a concrete site.
- * @param basePath - Absolute path of the folder from which files will be read.
- * @returns A Array<number> of pages ids in `basePath` folder filtered by pages ids in a concrete site.
+ * Return an array of ids only from `.json` files (no dirs) in the `basePath` dir based in the file name and filtered by the pages ids in a concrete site.
+ * @param basePath - Absolute path of the dir from which files will be read.
+ * @returns A Array<number> of pages ids in `basePath` dir filtered by pages ids in a concrete site.
  */
-function getPagesInStoreFolderBySitePages(
+function getPagesInStoreDirBySitePages(
 	basePath: string,
 	pages: Array<number>
 ): Array<number> {
-	const allPagesInStore = getPageInStoreFolder(basePath);
+	const allPagesInStore = getPageInStoreDir(basePath);
 	const pagesBySite = allPagesInStore.filter((page) => pages.includes(page));
 
 	return pagesBySite;
 }
 
 /**
- * Return an array of ids only from `.json` files (no dirs) in the `basePath` folder based in the file name.
- * @param basePath - Absolute path of the folder from which files will be read.
- * @returns A Array<number> of pages ids in `basePath` folder.
+ * Return an array of ids only from `.json` files (no dirs) in the `basePath` dir based in the file name.
+ * @param basePath - Absolute path of the dir from which files will be read.
+ * @returns A Array<number> of pages ids in `basePath` dir.
  */
-function getPageInStoreFolder(basePath: string): Array<number> {
+function getPageInStoreDir(basePath: string): Array<number> {
 	const filesInStore = fs.readdirSync(basePath);
 
 	return (
@@ -134,7 +134,7 @@ function getPageInStoreFolder(basePath: string): Array<number> {
 
 /**
  * Save the pages into the file system.
- * @param basePath - Absolute path of the folder from which files will be saved.
+ * @param basePath - Absolute path of the dir from which files will be saved.
  * @param pages - An array of Griddo page objects to be saved.
  */
 function savePagesInStore(basePath: string, pages: Array<GriddoPageObject>) {
@@ -147,8 +147,8 @@ function savePagesInStore(basePath: string, pages: Array<GriddoPageObject>) {
 }
 
 /**
- * Remove files from folder.
- * @param basePath - Absolute path of the folder from which files will be removed.
+ * Remove files from dir.
+ * @param basePath - Absolute path of the dir from which files will be removed.
  * @param filenames - An array of ids representing file page names.
  */
 function removePagesFromStore(basePath: string, filenames: Array<number>) {
@@ -169,14 +169,14 @@ function removePagesFromStore(basePath: string, filenames: Array<number>) {
 /**
  * Returns pages that need to be created or deleted for a site in the store based on the provided arguments.
  * @param sitePages - Properties for page retrieval.
- * @param props.storeFolder - Absolute path of the Griddo store.
+ * @param props.storeDir - Absolute path of the Griddo store.
  * @param props.pages - Exhaustive array of all pages in the site.
  * @param props.validPagesIds - Array of valid pages in the site.
  * @param props.changedPages - Array of pages that have been modified in the site.
  * @returns - An object containing the pages to be created and deleted in the site.
  */
 async function getPagesToCreateOrDelete(
-	storeFolder: string,
+	storeDir: string,
 	sitePages: {
 		sitesToPublish: Array<Site>;
 		pages: Array<number>;
@@ -187,7 +187,7 @@ async function getPagesToCreateOrDelete(
 	const { changedPages, pages, validPagesIds, sitesToPublish } = sitePages;
 	// Array<ids> de las páginas que están físicamente en el store en el
 	// site actual del bucle.
-	const pagesInStore = getPagesInStoreFolderBySitePages(storeFolder, pages);
+	const pagesInStore = getPagesInStoreDirBySitePages(storeDir, pages);
 
 	// Array<ids> que están el `validPagesIds` pero no están por algún
 	// motivo en el store. Se incluyen porque deben ser creadas.
@@ -240,7 +240,7 @@ async function getPagesToCreateOrDelete(
 }
 
 export {
-	createStoreFolder,
+	createStoreDir,
 	getBuildMetadata,
 	getBuildPages,
 	getPagesToCreateOrDelete,

package/gatsby-node.ts

@@ -8,14 +8,14 @@ import { generateBuildReport, generateSitemaps } from "./exporter/utils/sites";
 import { getBuildMetadata, getBuildPages } from "./exporter/utils/store";
 import {
 	getMatchPath,
-	prepareStaticFolder,
+	prepareStaticDir,
 	updateDist,
 } from "./src/gatsby-node-utils";
 import { GatsbyPageObject } from "./src/types";
 
-const publicFolderPath = path.resolve(__dirname, "./public");
-const storeFolderPath = path.resolve(__dirname, "./store/");
-const reportFilePath = path.resolve(publicFolderPath, "__build-report__.json");
+const publicDirPath = path.resolve(__dirname, "./public");
+const storeDirPath = path.resolve(__dirname, "./store/");
+const reportFilePath = path.resolve(publicDirPath, "__build-report__.json");
 const gatsbyTemplateFile = path.resolve(
 	__dirname,
 	"./src/components/template.tsx"
@@ -23,14 +23,14 @@ const gatsbyTemplateFile = path.resolve(
 
 // onPreInit
 const onPreInit = async () => {
-	prepareStaticFolder();
+	prepareStaticDir();
 };
 
 // createPages
 const createPages: GatsbyNode["createPages"] = async ({
 	actions: { createPage },
 }) => {
-	const pages = getBuildPages<GatsbyPageObject>(storeFolderPath);
+	const pages = getBuildPages<GatsbyPageObject>(storeDirPath);
 
 	for await (const page of pages) {
 		// SECURITY
@@ -55,12 +55,10 @@ const createPages: GatsbyNode["createPages"] = async ({
 
 // onPostBuild
 const onPostBuild = async () => {
-	const { buildProcessData, sitesToPublish } = getBuildMetadata(
-		storeFolderPath
-	);
+	const { buildProcessData, sitesToPublish } = getBuildMetadata(storeDirPath);
 
 	await generateBuildReport(reportFilePath, buildProcessData);
-	await RobotsService.writeFiles(publicFolderPath);
+	await RobotsService.writeFiles(publicDirPath);
 	await generateSitemaps(sitesToPublish);
 	await updateDist();
 };

package/index.js

@@ -3,5 +3,5 @@
 
 // This is the griddo-cx package entry point.
 // `./build/index.js` is for the Griddo Exporter, where everything start.
-// The source code (TypeScript) is in ./exporter folder
+// The source code (TypeScript) is in ./exporter dir
 require("./build/index.js");

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@griddo/cx",
 	"description": "Griddo SSG based on Gatsby",
-	"version": "10.4.2",
+	"version": "10.4.3",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -70,7 +70,7 @@
 		"react-helmet": "^6.0.0"
 	},
 	"devDependencies": {
-		"@griddo/eslint-config-back": "^10.4.2",
+		"@griddo/eslint-config-back": "^10.4.3",
 		"@types/babel__core": "^7.20.0",
 		"@types/babel__preset-env": "^7.9.2",
 		"@types/csvtojson": "^2.0.0",
@@ -117,5 +117,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "f278d83131c144600de8ea769c466991f41311c4"
+	"gitHead": "e75e4dc2c9fbc163ccbf9050792be04591530b6a"
 }

package/src/README.md

@@ -1,7 +1,7 @@
 # Griddo CX + Gatsby
 
-The `/src` folder and almost every file in the root folder is now 100% Gatsby related code along with the historical `/public`, `/dist`, `/apiCache`, `/store`, etc.. render folders.
+The `/src` dir and almost every file in the root dir is now 100% Gatsby related code along with the historical `/public`, `/dist`, `/apiCache`, `/store`, etc.. render dirs.
 
-Griddo CX code (the business logic) is now in `/exporter` folder.
+Griddo CX code (the business logic) is now in `/exporter` dir.
 
-In the future, Griddo CX and Gatsby will split int their own packages folders inside the mono-repo.
+In the future, Griddo CX and Gatsby will split int their own packages dirs inside the mono-repo.

package/src/gatsby-node-utils.ts

@@ -11,9 +11,9 @@ import {
 } from "../exporter/utils/instance";
 
 /**
- * Copy the instance's `/static` folder into the Gatsby's to include it in the render assets.
+ * Copy the instance's `/static` dir into the Gatsby's to include it in the render assets.
  */
-function prepareStaticFolder() {
+function prepareStaticDir() {
 	const src = resolveComponentsPath("static");
 	const dest = "./static";
 
@@ -26,14 +26,14 @@ function prepareStaticFolder() {
 			fs.copySync(fileSrc, fileDest);
 		});
 
-		console.info("Components static folder copied");
+		console.info("Components `static` dir copied");
 	} catch (err) {
 		console.error(err);
 	}
 }
 
 /**
- * Update the Griddo's `/dist` folder with the contents from `/public` only with files of type:
+ * Update the Griddo's `/dist` dir with the contents from `/public` only with files of type:
  * - js
  * - json
  * - css
@@ -148,7 +148,7 @@ function getMatchPath(domain: string, compose: string) {
 export {
 	getMatchPath,
 	onCreateWebpackConfig,
-	prepareStaticFolder,
+	prepareStaticDir,
 	updateDist,
 	getGatsbyAssetPrefixSlug,
 };

package/src/types.ts

@@ -10,7 +10,7 @@ import type { Site } from "../exporter/types/sites";
 import type { Core } from "@griddo/core";
 import type { HeadProps } from "gatsby";
 
-export interface CustomHeadProps extends HeadProps {
+interface CustomHeadProps extends HeadProps {
 	pageContext: GriddoPageObject["context"] & {
 		page: Core.Page & {
 			defaultLang: { id: number };
@@ -20,7 +20,7 @@ export interface CustomHeadProps extends HeadProps {
 	};
 }
 
-export interface TemplateProps extends Omit<GriddoPageObject, "context"> {
+interface TemplateProps extends Omit<GriddoPageObject, "context"> {
 	pageContext: GriddoPageObject["context"] & {
 		page: Core.Page;
 	};
@@ -31,7 +31,7 @@ export interface TemplateProps extends Omit<GriddoPageObject, "context"> {
 	};
 }
 
-export interface HtmlProps {
+interface HtmlProps {
 	body: string;
 	bodyAttributes: React.HtmlHTMLAttributes<HTMLBodyElement>;
 	headComponents: React.ReactNode;
@@ -40,7 +40,7 @@ export interface HtmlProps {
 	preBodyComponents: React.ReactNode;
 }
 
-export interface Dimensions {
+interface Dimensions {
 	values: Record<string, string> | null;
 	contentSelect?: "group" | "individual" | null;
 	groupSelect?: string;
@@ -48,7 +48,7 @@ export interface Dimensions {
 }
 
 // TODO: JSDoc
-export type GatsbyPageObject = {
+type GatsbyPageObject = {
 	matchPath?: string;
 	path: string;
 	component: string;
@@ -95,3 +95,11 @@ export type GatsbyPageObject = {
 		page: GriddoSinglePage | GriddoListPage | GriddoMultiPage;
 	};
 };
+
+export {
+	CustomHeadProps,
+	Dimensions,
+	GatsbyPageObject,
+	HtmlProps,
+	TemplateProps,
+};

package/static/robots.txt

@@ -1,3 +1,3 @@
-# This file comes from the /static folder
+# This file comes from the /static dir
 User-agent: *
 Disallow: /