rw-elements-tools 1.2.1 → 1.3.1

package/bin/cli.js

@@ -37,6 +37,7 @@ function parseArgs(args) {
     watch: false,
     help: false,
     version: false,
+    minify: true, // Minify by default
   };
   
   for (let i = 0; i < args.length; i++) {
@@ -48,6 +49,8 @@ function parseArgs(args) {
       result.version = true;
     } else if (arg === '--watch' || arg === '-w') {
       result.watch = true;
+    } else if (arg === '--no-minify') {
+      result.minify = false;
     } else if (arg === '--packs') {
       result.packs = args[++i];
     } else if (arg.startsWith('--packs=')) {
@@ -78,6 +81,7 @@ Commands:
 Options:
   --packs <dir>    Override the packs directory (default: ./packs)
   --watch, -w      Watch for changes
+  --no-minify      Disable minification (output is minified by default)
   --help, -h       Show this help message
   --version, -v    Show version number
 
@@ -116,32 +120,34 @@ async function showVersion() {
 /**
  * Run the properties build
  */
-async function buildProperties(config, watch = false) {
-  console.log(`[rw-build] Building properties${watch ? ' (watch mode)' : ''}...`);
+async function buildProperties(config, watch = false, minify = true) {
+  console.log(`[rw-build] Building properties${watch ? ' (watch mode)' : ''}${minify ? '' : ' (no minify)'}...`);
   console.log(`[rw-build] Packs directory: ${config.packsDir}`);
   
+  const buildConfig = { ...config, minify };
   const buildModule = await import('../build-properties.js');
   
   if (watch) {
-    await buildModule.startWatch(config);
+    await buildModule.startWatch(buildConfig);
   } else {
-    await buildModule.buildProperties(config);
+    await buildModule.buildProperties(buildConfig);
   }
 }
 
 /**
  * Run the hooks build
  */
-async function buildHooks(config, watch = false) {
-  console.log(`[rw-build] Building hooks${watch ? ' (watch mode)' : ''}...`);
+async function buildHooks(config, watch = false, minify = true) {
+  console.log(`[rw-build] Building hooks${watch ? ' (watch mode)' : ''}${minify ? '' : ' (no minify)'}...`);
   console.log(`[rw-build] Packs directory: ${config.packsDir}`);
   
+  const buildConfig = { ...config, minify };
   const buildModule = await import('../build-shared-hooks.js');
   
   if (watch) {
-    await buildModule.startWatch(config);
+    await buildModule.startWatch(buildConfig);
   } else {
-    await buildModule.buildAll(config);
+    await buildModule.buildAll(buildConfig);
   }
 }
 
@@ -174,11 +180,11 @@ async function main() {
   try {
     switch (args.command) {
       case 'properties':
-        await buildProperties(config, args.watch);
+        await buildProperties(config, args.watch, args.minify);
         break;
         
       case 'hooks':
-        await buildHooks(config, args.watch);
+        await buildHooks(config, args.watch, args.minify);
         break;
         
       case 'all':
@@ -186,13 +192,13 @@ async function main() {
           // In watch mode, start both watchers concurrently
           // They will both run indefinitely, watching for changes
           await Promise.all([
-            buildProperties(config, true),
-            buildHooks(config, true),
+            buildProperties(config, true, args.minify),
+            buildHooks(config, true, args.minify),
           ]);
         } else {
           // One-time build: run sequentially
-          await buildProperties(config, false);
-          await buildHooks(config, false);
+          await buildProperties(config, false, args.minify);
+          await buildHooks(config, false, args.minify);
         }
         break;
         

package/build-properties.js

@@ -495,8 +495,9 @@ function setupAdvancedGroup(config) {
  * Reads and processes a properties.config.json file, generating properties.json.
  *
  * @param {string} configPath - Path to the properties.config.json file.
+ * @param {boolean} [minify=true] - Whether to minify the output JSON.
  */
-async function processConfigFile(configPath) {
+async function processConfigFile(configPath, minify = true) {
   try {
     const fileDir = path.dirname(configPath);
     const configContent = await fs.readFile(configPath, "utf8");
@@ -511,9 +512,12 @@ async function processConfigFile(configPath) {
       properties: group.properties.flatMap(processProperty),
     }));
 
-    // Write the processed config
+    // Write the processed config (minified by default)
     const outputPath = path.join(fileDir, "properties.json");
-    await fs.writeFile(outputPath, JSON.stringify(config, null, 2));
+    const jsonOutput = minify 
+      ? JSON.stringify(config) 
+      : JSON.stringify(config, null, 2);
+    await fs.writeFile(outputPath, jsonOutput);
   } catch (error) {
     console.error(`Error processing file ${configPath}:`, error);
   }
@@ -543,8 +547,9 @@ async function processDirectoryIfConfigExists(dirPath) {
  * Finds all directories matching a glob pattern and processes their configs.
  *
  * @param {string} packsDir - The packs directory to search.
+ * @param {boolean} [minify=true] - Whether to minify the output JSON.
  */
-async function processAllConfigs(packsDir) {
+async function processAllConfigs(packsDir, minify = true) {
   try {
     const pattern = path.join(packsDir, "**/*.elementsdevpack/components/com.**/**");
     const directories = globSync(pattern, { absolute: true });
@@ -556,7 +561,7 @@ async function processAllConfigs(packsDir) {
       const configPath = path.join(dir, "properties.config.json");
       try {
         await fs.access(configPath);
-        await processConfigFile(configPath);
+        await processConfigFile(configPath, minify);
         processed++;
       } catch {
         // Config file doesn't exist, skip silently
@@ -579,10 +584,12 @@ async function processAllConfigs(packsDir) {
  * 
  * @param {Object} config - Configuration object from resolveConfig()
  * @param {string} config.packsDir - Absolute path to the packs directory
+ * @param {boolean} [config.minify=true] - Whether to minify the output JSON
  */
 export async function buildProperties(config) {
+  const minify = config.minify !== false; // Default to true
   console.log(`[properties] Building properties...`);
-  await processAllConfigs(config.packsDir);
+  await processAllConfigs(config.packsDir, minify);
   console.log(`[properties] Build complete`);
 }
 
@@ -590,6 +597,7 @@ export async function buildProperties(config) {
  * Starts watch mode for continuous building of properties
  * @param {Object} config - Configuration object
  * @param {string} config.packsDir - Absolute path to the packs directory
+ * @param {boolean} [config.minify=true] - Whether to minify the output JSON
  */
 export async function startWatch(config) {
   const packsDir = config.packsDir;
@@ -635,8 +643,9 @@ export async function startWatch(config) {
 if (process.argv[1] === fileURLToPath(import.meta.url)) {
   // Direct execution: use ./packs relative to current working directory
   const WATCH = process.argv.includes('--watch') || process.argv.includes('-w');
+  const NO_MINIFY = process.argv.includes('--no-minify');
   const defaultPacksDir = path.resolve(process.cwd(), "packs");
-  const config = { packsDir: defaultPacksDir };
+  const config = { packsDir: defaultPacksDir, minify: !NO_MINIFY };
   
   (async () => {
     try {

package/build-shared-hooks.js

@@ -101,8 +101,9 @@ async function findHookSources(startDir) {
  * @param {string[]} sharedFiles - Array of shared hook file paths
  * @param {string} sourcePath - Path to the hooks.source.js file
  * @param {string} projectRoot - Project root for relative path display
+ * @param {boolean} [minify=true] - Whether to fully minify the output
  */
-async function buildOne(sharedFiles, sourcePath, projectRoot) {
+async function buildOne(sharedFiles, sourcePath, projectRoot, minify = true) {
   const componentDir = path.dirname(sourcePath);
   const outputPath = path.join(componentDir, OUTPUT_FILENAME);
 
@@ -115,41 +116,34 @@ async function buildOne(sharedFiles, sourcePath, projectRoot) {
 
   // Read the component source
   let componentContent = await fs.promises.readFile(sourcePath, 'utf8');
+  const hasExportLine = /exports\.transformHook\s*=/.test(componentContent);
 
-  // Remove any existing exports.transformHook line (we'll add our own export marker)
-  componentContent = componentContent.replace(/^\s*exports\.transformHook\s*=.*$/gm, '').trim();
+  // Ensure the expected CommonJS export is present exactly once
+  if (!hasExportLine) {
+    componentContent = `${componentContent.trim()}\nexports.transformHook = transformHook;`;
+  }
 
-  // Concatenate everything and add an ESM export marker for DCE
-  // esbuild will keep transformHook and anything it references, drop the rest
+  // Concatenate everything
   const combinedSource = `
 ${sharedPieces.join('\n\n')}
 
 ${componentContent}
-
-export { transformHook };
 `;
 
-  // Use esbuild transform with DCE
-  // minifySyntax: true enables dead code elimination
-  // We keep identifiers and whitespace for readable output
+  // Minify whitespace only (keep identifier names); enable syntax minification for small size
   const result = await transform(combinedSource, {
     loader: 'js',
     target: 'es2018',
-    minifySyntax: true,       // Enables DCE
-    minifyWhitespace: false,  // Keep formatting readable
-    minifyIdentifiers: false, // Keep variable names
-    format: 'esm',
+    minifySyntax: minify,
+    minifyWhitespace: minify,
+    minifyIdentifiers: false,
+    format: 'cjs',
     legalComments: 'none',
   });
 
-  let code = result.code;
-
-  // Replace ESM export with CommonJS-style assignment
-  code = code.replace(/export\s*\{\s*transformHook\s*(as\s+\w+)?\s*\}\s*;?\s*$/m, 'exports.transformHook = transformHook;');
-
-  const banner = `// AUTO-GENERATED: do not edit. Edit hooks.source.js instead.\n`;
+  const banner = minify ? '' : `// AUTO-GENERATED: do not edit. Edit hooks.source.js instead.\n`;
 
-  await fs.promises.writeFile(outputPath, banner + code, 'utf8');
+  await fs.promises.writeFile(outputPath, banner + result.code, 'utf8');
 
   console.log(`[hooks] Wrote ${path.relative(projectRoot, outputPath)}`);
 }
@@ -159,10 +153,12 @@ export { transformHook };
  * @param {Object} config - Configuration object
  * @param {string} config.packsDir - Absolute path to the packs directory
  * @param {string} [config.projectRoot] - Project root for display purposes
+ * @param {boolean} [config.minify=true] - Whether to fully minify the output
  */
 export async function buildAll(config) {
   const packsDir = config.packsDir;
   const projectRoot = config.projectRoot || path.dirname(packsDir);
+  const minify = config.minify !== false; // Default to true
   
   const sharedFiles = await listSharedFiles();
   const sources = await findHookSources(packsDir);
@@ -170,7 +166,7 @@ export async function buildAll(config) {
   console.log(`[hooks] Building ${sources.length} component hook(s); shared files: ${sharedFiles.length}`);
 
   for (const sourcePath of sources) {
-    await buildOne(sharedFiles, sourcePath, projectRoot);
+    await buildOne(sharedFiles, sourcePath, projectRoot, minify);
   }
   
   console.log(`[hooks] Build complete`);
@@ -181,6 +177,7 @@ export async function buildAll(config) {
  * @param {Object} config - Configuration object
  * @param {string} config.packsDir - Absolute path to the packs directory
  * @param {string} [config.projectRoot] - Project root for display purposes
+ * @param {boolean} [config.minify=true] - Whether to fully minify the output
  */
 export async function startWatch(config) {
   const packsDir = config.packsDir;
@@ -233,10 +230,12 @@ export async function startWatch(config) {
 if (process.argv[1] === __filename) {
   // Direct execution: use ./packs relative to current working directory
   const WATCH = process.argv.includes('--watch') || process.argv.includes('-w');
+  const NO_MINIFY = process.argv.includes('--no-minify');
   const defaultPacksDir = path.resolve(process.cwd(), 'packs');
   const config = { 
     packsDir: defaultPacksDir,
-    projectRoot: process.cwd()
+    projectRoot: process.cwd(),
+    minify: !NO_MINIFY
   };
   
   (async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rw-elements-tools",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Build tools for RapidWeaver Elements packs - generates properties.json and hooks.js files",
   "author": "Elements Platform",
   "license": "MIT",
@@ -50,6 +50,13 @@
     "lodash": "^4.17.21"
   },
   "scripts": {
-    "prepublishOnly": "echo 'Ready to publish rw-elements-tools'"
+    "prepublishOnly": "echo 'Ready to publish rw-elements-tools'",
+    "docs:generate": "node scripts/generate-docs.js",
+    "docs:publish": "node scripts/publish-docs.js",
+    "docs": "npm run docs:generate && npm run docs:publish"
+  },
+  "rw-elements-tools": {
+    "docsRepoPath": "/Users/ben/Developer/rapidweaver-elements-docs-api",
+    "docsTargetDir": "development-resources/build-tools"
   }
 }