@changke/staticnext-build 0.2.2 → 0.2.3

package/build.mjs

@@ -2,7 +2,7 @@
 
 import {argv} from 'node:process';
 
-import config from './lib/config.mjs';
+import Config from './lib/config.mjs';
 
 import clean from './lib/tasks/clean.mjs';
 import copy from './lib/tasks/copy.mjs';
@@ -16,14 +16,14 @@ import styles from './lib/tasks/styles.mjs';
 const taskName = argv[2]?.toLowerCase() || 'dev';
 
 // load config data
-const conf = await config.loadConfig();
+const conf = await Config.loadConfig();
 
 const taskEnded = taskName => {
   console.timeEnd(taskName);
 };
 
-const srcPaths = conf.getSourcePaths(conf.sourcePath, conf.sourceRoot);
-const tgtPaths = conf.getTargetPaths(conf.targetPath, conf.targetRoot, conf.targetAssetsRoot);
+const srcPaths = Config.getSourcePaths(conf.sourcePath, conf.sourceRoot);
+const tgtPaths = Config.getTargetPaths(conf.targetPath, conf.targetRoot, conf.targetAssetsRoot);
 
 // Set parameters of each task
 const tasks = {
@@ -45,7 +45,7 @@ const tasks = {
     conf.njkGlobals,
     tgtPaths.prototype
   ),
-  scripts: () => scripts(conf.getScriptEntries(conf.moduleEntries, conf.mainEntryFile, srcPaths), tgtPaths.assets),
+  scripts: () => scripts(Config.getScriptEntries(conf.moduleEntries, conf.mainEntryFile, srcPaths), tgtPaths.assets),
   styles: () => styles([
     `${srcPaths.css}/brands/*.css`,
     `${srcPaths.css}/index.css`,

package/lib/config.mjs

@@ -1,5 +1,6 @@
 import {cwd} from 'node:process';
 
+import './typedefs.mjs';
 import vars from './vars.mjs';
 
 class Config {
@@ -34,6 +35,49 @@ class Config {
     }
     return conf;
   }
+
+  /**
+   * Get full source paths
+   *
+   * @type {GetPathFunc}
+   */
+  getSourcePaths = (srcParts, srcRoot) => {
+    const sp = Object.assign({}, srcParts);
+    for (const [k, v] of Object.entries(sp)) {
+      sp[k] = `${srcRoot}${v}`; // extend path
+    }
+    return sp;
+  };
+
+  /**
+   * Get full target paths
+   *
+   * @type {GetPathFunc}
+   */
+  getTargetPaths = (tgtPaths, tgtRoot, tgtAssetsRoot) => {
+    return {
+      assets: `${tgtRoot}${tgtAssetsRoot}`,
+      css: `${tgtRoot}${tgtAssetsRoot}${tgtPaths.css}`,
+      js: `${tgtRoot}${tgtAssetsRoot}${tgtPaths.js}`,
+      moduleAssets: `${tgtRoot}${tgtAssetsRoot}${tgtPaths.moduleAssets}`,
+      prototype: `${tgtRoot}${tgtPaths.prototype}`,
+      markdown: `${tgtRoot}${tgtPaths.markdown}`
+    };
+  };
+
+  /**
+   * Get inputs for esbuild
+   *
+   * @type {ScriptEntryFunc}
+   */
+  getScriptEntries = (modEntries, mainEntry = 'main.ts', srcPaths) => {
+    const mainEntryPath = `${srcPaths.js}/${mainEntry}`;
+    // For code splitting, as input config for esbuild
+    const moduleEntryFiles = modEntries.map(f => {
+      return `${srcPaths.modules}/${f}`;
+    });
+    return [mainEntryPath].concat(moduleEntryFiles);
+  };
 }
 
 const config = new Config();

package/lib/typedefs.mjs

@@ -0,0 +1,53 @@
+/**
+ * Path(suffixes) for various source/target files
+ * E.g. CSS source files are located in `${basePath}/css`
+ * Built/bundled JS files are stored in `${targetAssetsBase}/js`
+ *
+ * @typedef {Object} PathPart
+ * @property {string} assets Path for general static assets
+ * @property {string=} css Path for CSS files
+ * @property {string=} js Path for JS files
+ * @property {string=} modules Path for module directories / files
+ * @property {string=} moduleAssets Path for assets of individual modules
+ * @property {string=} prototype Path for prototype (HTML) files
+ * @property {string=} test Path for unit-test related files
+ * @property {string=} markdown Path for markdown files
+ */
+
+/**
+ * Helper to create an array with input source TS files for esbuild
+ *
+ * @typedef {Function} ScriptEntryFunc
+ * @param {string[]} modEntries Array of module entry TS files
+ * @param {string} [mainEntry=main.ts] Main entry TS file, default `main.ts`
+ * @param {PathPart} srcPaths
+ * @return {string[]}
+ */
+
+/**
+ * Helper to append base path to source/target path-suffixes
+ *
+ * @typedef {Function} GetPathFunc
+ *
+ * @param {PathPart} paths Path suffixes of various types e.g. `/css`, `/js`, `/md` (starts with slash)
+ * @param {string} root Root path of source/target
+ * @param {string=} assetsRoot Only for target: assets root path e.g. `${targetRoot}/assets/_sn_`
+ * @return {PathPart}
+ */
+
+/**
+ * @typedef {Object} SNConfig
+ * @property {string} sourceRoot Root dir of source
+ * @property {string} targetRoot Root dir for output (target)
+ * @property {PathPart} sourcePath Paths of different types of source files
+ * @property {string} targetAssetsRoot
+ * @property {PathPart} targetPath Paths for different output files
+ * @property {string[]} tenants Theme-names
+ * @property {string[]} moduleEntries List of input files of modules e.g. 'mod-foo/foo.ts'
+ * @property {string} mainEntryFile The entry point of all JS e.g. main.ts
+ * @property {string} assetsUrlPath Path of assets used in URL for resource loading etc.
+ * @property {boolean} markdownEnabled Enable markdown feature or not
+ * @property {Object} njkGlobals Global variables assigned to Nunjucks compiler
+ */
+
+export {};

package/lib/vars.mjs

@@ -1,61 +1,6 @@
-/**
- * Path(suffixes) for various source/target files
- * E.g. CSS source files are located in `${basePath}/css`
- * Built JS in `${targetAssetsBase}/js`
- *
- * @typedef {Object} PathPart
- * @property {string} assets Path for general static assets
- * @property {string=} css Path for CSS files
- * @property {string=} js Path for JS files
- * @property {string=} modules Path for module directories / files
- * @property {string=} moduleAssets Path for assets of individual modules
- * @property {string=} prototype Path for prototype (HTML) files
- * @property {string=} test Path for unit-test related files
- * @property {string=} markdown Path for markdown files
- */
-
-/**
- * Helper to create an array with input source TS files for esbuild
- *
- * @typedef {Function} ScriptEntryFunc
- * @param {string[]} modEntries Array of module entry TS files
- * @param {string=} mainEntry Main entry TS file, default `main.ts`
- * @param {PathPart} srcPaths
- * @return {string[]}
- */
-
-/**
- * Helper to append base path to source/target path-suffixes
- *
- * @typedef {Function} GetPathFunc
- *
- * @param {PathPart} paths Path suffixes of various types e.g. `/css`, `/js`, `/md` (do with slash)
- * @param {string} root Root path of source/target
- * @param {string=} assetsRoot Only for target: assets root path e.g. `${targetRoot}/assets/_sn_`
- * @return {PathPart}
- */
-
-/**
- * @typedef {Object} SNConfig
- * @property {string} sourceRoot Root dir of source
- * @property {string} targetRoot Root dir for output (target)
- * @property {PathPart} sourcePath Paths of different types of source files
- * @property {GetPathFunc} getSourcePaths
- * @property {string} targetAssetsRoot
- * @property {PathPart} targetPath Paths for different output files
- * @property {GetPathFunc} getTargetPaths
- * @property {string[]} tenants Theme-names
- * @property {string[]} moduleEntries List of input files of modules e.g. 'mod-foo/foo.ts'
- * @property {string} mainEntryFile The entry point of all JS e.g. main.ts
- * @property {ScriptEntryFunc} getScriptEntries Inputs of source files for esbuild
- * @property {string} assetsUrlPath Path of assets used in URL for resource loading etc.
- * @property {boolean} markdownEnabled Enable markdown feature or not
- * @property {Record<string, string>} njkGlobals Global variables assigned to Nunjucks compiler
- */
+import './typedefs.mjs';
 
 // default config values
-const moduleEntries = [];
-
 const sourceRoot = './src/main/webapp';
 const targetRoot = './tgt/static';
 
@@ -70,21 +15,9 @@ const sourcePath = {
   markdown: '/md'
 };
 
-/**
- * Extend source paths
- *
- * @type {GetPathFunc}
- */
-const getSourcePaths = (srcParts, srcRoot) => {
-  const sp = Object.assign({}, srcParts);
-  for (const [k, v] of Object.entries(sp)) {
-    sp[k] = `${srcRoot}${v}`; // extend path
-  }
-  return sp;
-};
-
 const targetAssetsRoot = '/assets/_sn_';
 
+/** @type {PathPart} */
 const targetPath = {
   assets: '',
   css: '/css',
@@ -94,37 +27,12 @@ const targetPath = {
   markdown: '/docs'
 };
 
-/**
- * Target paths
- *
- * @type {GetPathFunc}
- */
-const getTargetPaths = (tgtPaths, tgtRoot = targetRoot, tgtAssetsRoot = targetAssetsRoot) => {
-  return {
-    assets: `${tgtRoot}${tgtAssetsRoot}`,
-    css: `${tgtRoot}${tgtAssetsRoot}${tgtPaths.css}`,
-    js: `${tgtRoot}${tgtAssetsRoot}${tgtPaths.js}`,
-    moduleAssets: `${tgtRoot}${tgtAssetsRoot}${tgtPaths.moduleAssets}`,
-    prototype: `${tgtRoot}${tgtPaths.prototype}`,
-    markdown: `${tgtRoot}${tgtPaths.markdown}`
-  };
-};
-
 // "themes", not in use, replaced with brands directory
 const tenants = ['one', 'two', 'three'];
 
-const mainEntryFile = 'main.ts';
+const moduleEntries = [];
 
-// also add the main entry file
-/** @type {ScriptEntryFunc} */
-const getScriptEntries = (modEntries, mainEntry = mainEntryFile, srcPaths) => {
-  const mainEntryPath = `${srcPaths.js}/${mainEntry}`;
-  // For code splitting, as input config for esbuild
-  const moduleEntryFiles = modEntries.map(f => {
-    return `${srcPaths.modules}/${f}`;
-  });
-  return [mainEntryPath].concat(moduleEntryFiles);
-};
+const mainEntryFile = 'main.ts';
 
 // To get relative path of assets
 const assetsUrlPath = '/assets/_sn_';
@@ -142,14 +50,11 @@ const config = {
   sourceRoot,
   targetRoot,
   sourcePath,
-  getSourcePaths,
   targetAssetsRoot,
   targetPath,
-  getTargetPaths,
   tenants,
   moduleEntries,
   mainEntryFile,
-  getScriptEntries,
   assetsUrlPath,
   markdownEnabled,
   njkGlobals

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@changke/staticnext-build",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Build scripts extracted from StaticNext seed project",
   "main": "index.js",
   "scripts": {