wake-runner 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.2] - 2026-03-06
+
+### Added
+
+- `--help` / `-h` flag: prints all commands, flags, and usage examples to the terminal and exits.
+- Generic flag passthrough: any flag not consumed by `wake-runner` itself is forwarded to the underlying CLI. In specific modes (`wake storefront`, `wake tailwind`) flags go to the respective tool. In `wake` (all) mode, extra flags are forwarded to `fbits.storefront` only to avoid passing incompatible flags to `tailwindcss`.
+- `--no-minify` flag for `wake tailwind`, `wake-tailwind`, and `wake` commands. CSS output is minified by default; pass `--no-minify` to disable.
+
+### Fixed
+
+- In `wake` (all) mode, passthrough args were incorrectly forwarded to both `fbits.storefront` and `tailwindcss`. Extra flags are now sent only to `fbits.storefront`.
+
+### Changed
+
+- All CLI output messages and error messages translated to English for consistency with documentation.
+
+## [1.0.1] - 2026-03-05
+
+### Added
+
+- `--no-minify` flag for `wake tailwind`, `wake-tailwind`, and `wake` commands. CSS output is minified by default; pass `--no-minify` to disable.
+- Repository, homepage, and bugs URLs in `package.json` for correct linking on the npm package page.
+
+### Changed
+
+- Tailwind CSS version requirement documented as **3.4.18**, aligned with the [Wake template padrão](https://wakecommerce.readme.io/docs/template-padrao#tailwindcss).
+- Both standalone CLI and npm installation options for Tailwind are now documented.
+- `bin` paths in `package.json` normalized (removed leading `./`).
+
+## [1.0.0] - 2026-03-05
+
+### Added
+
+- Initial release of **wake-runner**.
+- `wake` command: starts `fbits.storefront` (using token from `Configs/settings.json`) and all Tailwind CSS watchers in parallel.
+- `wake storefront` / `wake-storefront`: starts only `fbits.storefront`.
+- `wake tailwind` / `wake-tailwind`: starts one Tailwind `--watch` process per `input*.css` file found in `Assets/CSS/`, mapping `input` → `output` in the output filename.
+- Auto-detection of Tailwind: uses local npm installation (`node_modules/.bin/tailwindcss`) when available, falls back to global `tailwindcss` in PATH.
+- Fix for alternate entry points (`wake-storefront.js`, `wake-tailwind.js`) not executing the CLI when required from `wake.js`.
+
+[Unreleased]: https://github.com/SimksS/wake-runner/compare/v1.0.2...HEAD
+[1.0.2]: https://github.com/SimksS/wake-runner/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/SimksS/wake-runner/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/SimksS/wake-runner/releases/tag/v1.0.0

package/README.md

@@ -100,6 +100,8 @@ Go to your Wake project root and run one of the commands below.
 
 If you are using a local npm Tailwind installation, run these commands from the same project root where `tailwindcss` was installed.
 
+Run `wake --help` at any time to see all commands, flags, and examples directly in the terminal.
+
 ### Start everything
 
 Starts `fbits.storefront` and all Tailwind watchers:
@@ -108,6 +110,13 @@ Starts `fbits.storefront` and all Tailwind watchers:
 wake
 ```
 
+Extra flags in `wake` (all) mode are forwarded to `fbits.storefront` only. Use `wake tailwind [flags]` to pass flags to `tailwindcss`:
+
+```bash
+wake --port 3000          # passes --port 3000 to fbits.storefront only
+wake --no-minify          # disables Tailwind minification only
+```
+
 ### Start only storefront
 
 ```bash
@@ -120,6 +129,14 @@ Or:
 wake-storefront
 ```
 
+Any extra flags are forwarded directly to `fbits.storefront`:
+
+```bash
+wake storefront --port 3000
+wake storefront --port 3000 --save
+wake-storefront --port 3000
+```
+
 ### Start only Tailwind watchers
 
 Starts one watcher for each `input*.css` file found directly inside `Assets/CSS/`.
@@ -134,6 +151,27 @@ Or:
 wake-tailwind
 ```
 
+CSS is minified by default. To disable minification:
+
+```bash
+wake tailwind --no-minify
+wake-tailwind --no-minify
+```
+
+Any other extra flags are forwarded directly to `tailwindcss`:
+
+```bash
+wake tailwind --content "./src/**/*.html"
+wake-tailwind --no-minify --content "./src/**/*.html"
+```
+
+### Help
+
+```bash
+wake --help
+wake -h
+```
+
 ## CSS file mapping
 
 Each input file is mapped to an output file by replacing the leading `input` prefix with `output`.
@@ -150,10 +188,11 @@ Examples:
 
 - Reads `Configs/settings.json`
 - Extracts `access_token`
+- Forwards any extra flags to `fbits.storefront`
 - Runs:
 
 ```bash
-fbits.storefront --token <access_token>
+fbits.storefront --token <access_token> [extra flags]
 ```
 
 ### `wake tailwind`
@@ -161,10 +200,12 @@ fbits.storefront --token <access_token>
 - Reads files directly from `Assets/CSS/`
 - Finds files that start with `input` and end with `.css`
 - Starts one process per file
+- Minification enabled by default; pass `--no-minify` to disable
+- Forwards any extra flags (other than `--no-minify`) to `tailwindcss`
 - Uses local npm Tailwind when available, otherwise uses the global `tailwindcss` command:
 
 ```bash
-tailwindcss -i ./Assets/CSS/input.css -o ./Assets/CSS/output.css --watch
+tailwindcss -i ./Assets/CSS/input.css -o ./Assets/CSS/output.css --watch --minify [extra flags]
 ```
 
 ## Errors
@@ -184,6 +225,7 @@ The CLI exits with code `1` when:
 - The CLI uses only Node.js built-in modules
 - Tailwind 3.4.18 can be installed via the standalone CLI (add to PATH) or via npm (global or local in the Wake project)
 - On Windows, separate commands are exposed as `wake-storefront` and `wake-tailwind` instead of names containing `:`
+- Any flag not recognized by `wake-runner` (`--help`, `--no-minify`) is forwarded to the underlying CLI
 
 ## License
 

package/bin/wake-storefront.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 process.env.WAKE_MODE = 'storefront';
 require('./wake');

package/bin/wake-tailwind.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 process.env.WAKE_MODE = 'tailwind';
 require('./wake');

package/bin/wake.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const fs = require('fs');
 const path = require('path');
@@ -15,7 +15,7 @@ function parseJsonFile(filePath, fileLabel) {
   try {
     return JSON.parse(fs.readFileSync(filePath, 'utf8').replace(/^\uFEFF/, ''));
   } catch (error) {
-    exitWithError(`Erro: ${fileLabel} inválido.`);
+    exitWithError(`Error: invalid ${fileLabel}.`);
   }
 }
 
@@ -23,14 +23,14 @@ function getToken() {
   const settingsPath = path.join(cwd, 'Configs', 'settings.json');
 
   if (!fs.existsSync(settingsPath)) {
-    exitWithError('Erro: Configs/settings.json não encontrado. Execute dentro de um projeto Wake.');
+    exitWithError('Error: Configs/settings.json not found. Run this command from a Wake project root.');
   }
 
   const settings = parseJsonFile(settingsPath, 'Configs/settings.json');
   const token = settings.access_token;
 
   if (!token) {
-    exitWithError('Erro: access_token não encontrado no settings.json.');
+    exitWithError('Error: access_token not found in settings.json.');
   }
 
   return token;
@@ -40,7 +40,7 @@ function getInputFiles() {
   const cssDir = path.join(cwd, 'Assets', 'CSS');
 
   if (!fs.existsSync(cssDir)) {
-    exitWithError('Erro: pasta Assets/CSS não encontrada.');
+    exitWithError('Error: Assets/CSS directory not found.');
   }
 
   const inputFiles = fs.readdirSync(cssDir, { withFileTypes: true })
@@ -50,7 +50,7 @@ function getInputFiles() {
     .map(entry => entry.name);
 
   if (inputFiles.length === 0) {
-    exitWithError('Erro: nenhum arquivo input*.css encontrado em Assets/CSS.');
+    exitWithError('Error: no input*.css files found in Assets/CSS.');
   }
 
   return inputFiles;
@@ -79,39 +79,42 @@ function getTailwindCommand() {
     return {
       command: 'npm',
       argsPrefix: ['exec', 'tailwindcss', '--'],
-      sourceLabel: 'npm local',
+      sourceLabel: 'local npm',
     };
   }
 
   return {
     command: 'tailwindcss',
     argsPrefix: [],
-    sourceLabel: 'PATH global',
+    sourceLabel: 'global PATH',
   };
 }
 
-function runStorefront() {
+function runStorefront(passthroughArgs) {
   const token = getToken();
 
-  console.log(`Token carregado: ${token.slice(0, 10)}...`);
-  console.log('Iniciando fbits.storefront...');
+  console.log(`Token loaded: ${token.slice(0, 10)}...`);
+  console.log('Starting fbits.storefront...');
 
-  spawnCommand('fbits.storefront', ['--token', token]);
+  spawnCommand('fbits.storefront', ['--token', token, ...passthroughArgs]);
 }
 
-function runTailwind() {
+function runTailwind(minify, passthroughArgs) {
   const inputFiles = getInputFiles();
   const tailwind = getTailwindCommand();
 
-  console.log(`Arquivos CSS encontrados: ${inputFiles.join(', ')}\n`);
-  console.log(`Usando Tailwind via ${tailwind.sourceLabel}.`);
+  console.log(`CSS files found: ${inputFiles.join(', ')}\n`);
+  console.log(`Minification: ${minify ? 'enabled' : 'disabled'}.`);
+
 
   for (const inputFile of inputFiles) {
     const outputFile = inputFile.replace(/^input/, 'output');
     const inputPath = `./Assets/CSS/${inputFile}`;
     const outputPath = `./Assets/CSS/${outputFile}`;
 
-    console.log(`Iniciando Tailwind: ${inputFile} -> ${outputFile}`);
+    const minifyFlag = minify ? ['--minify'] : [];
+
+    console.log(`Starting Tailwind: ${inputFile} -> ${outputFile}`);
     spawnCommand(tailwind.command, [
       ...tailwind.argsPrefix,
       '-i',
@@ -119,30 +122,114 @@ function runTailwind() {
       '-o',
       outputPath,
       '--watch',
+      ...minifyFlag,
+      ...passthroughArgs,
     ]);
   }
 }
 
+function printHelp() {
+  console.log('wake-runner — starts the Wake development environment');
+  console.log('');
+  console.log('Usage:');
+  console.log('  wake                           Start fbits.storefront + all Tailwind watchers');
+  console.log('  wake storefront                Start fbits.storefront only');
+  console.log('  wake tailwind                  Start Tailwind watchers only');
+  console.log('  wake-storefront                Alias for "wake storefront"');
+  console.log('  wake-tailwind                  Alias for "wake tailwind"');
+  console.log('');
+  console.log('wake-runner flags:');
+  console.log('  --help, -h       Show this help message');
+  console.log('  --no-minify      Disable CSS minification (enabled by default)');
+  console.log('');
+  console.log('Passthrough — any other flag is forwarded directly to the underlying CLI:');
+  console.log('  wake storefront [flags]   → fbits.storefront --token <token> [flags]');
+  console.log('  wake tailwind [flags]     → tailwindcss -i ... -o ... --watch --minify [flags]');
+  console.log('  wake [flags]              → fbits.storefront only (use "wake tailwind" for tailwindcss flags)');
+  console.log('');
+  console.log('Examples:');
+  console.log('  wake                                       Start everything with default settings');
+  console.log('  wake --no-minify                           Start all, Tailwind without minification');
+  console.log('  wake --port 3000                           Start all, storefront on port 3000');
+  console.log('  wake storefront --port 3000                Start storefront on port 3000');
+  console.log('  wake storefront --port 3000 --save         Start storefront on port 3000 and save token');
+  console.log('  wake tailwind --no-minify                  Start Tailwind without minification');
+  console.log('  wake tailwind --content "./src/**/*.html"  Start Tailwind with custom content path');
+  console.log('');
+  console.log('Repository: https://github.com/SimksS/wake-runner');
+}
+
 function printUsage() {
-  console.log('Uso:');
-  console.log('  wake');
-  console.log('  wake storefront');
-  console.log('  wake tailwind');
-  console.log('  wake-storefront');
-  console.log('  wake-tailwind');
+  console.log('Invalid usage. Run "wake --help" to see all available commands.');
+}
+
+function parseArgs() {
+  const WAKE_OWN_FLAGS = new Set(['no-minify', 'help']);
+  const SHORT_FLAG_MAP = { h: 'help' };
+  const args = process.argv.slice(2);
+  const positional = [];
+  const wakeFlags = {};
+  const passthroughArgs = [];
+
+  let i = 0;
+  while (i < args.length) {
+    const arg = args[i];
+
+    if (arg.startsWith('--')) {
+      const key = arg.slice(2);
+      if (WAKE_OWN_FLAGS.has(key)) {
+        wakeFlags[key] = true;
+        i++;
+      } else {
+        passthroughArgs.push(arg);
+        const nextArg = args[i + 1];
+        if (nextArg !== undefined && !nextArg.startsWith('-')) {
+          passthroughArgs.push(nextArg);
+          i += 2;
+        } else {
+          i++;
+        }
+      }
+    } else if (arg.startsWith('-') && arg.length >= 2) {
+      const shortKey = arg.slice(1);
+      const mappedKey = SHORT_FLAG_MAP[shortKey];
+      if (mappedKey && WAKE_OWN_FLAGS.has(mappedKey)) {
+        wakeFlags[mappedKey] = true;
+        i++;
+      } else {
+        passthroughArgs.push(arg);
+        const nextArg = args[i + 1];
+        if (nextArg !== undefined && !nextArg.startsWith('-')) {
+          passthroughArgs.push(nextArg);
+          i += 2;
+        } else {
+          i++;
+        }
+      }
+    } else {
+      positional.push(arg);
+      i++;
+    }
+  }
+
+  const mode = process.env.WAKE_MODE || positional[0] || 'all';
+  const minify = !wakeFlags['no-minify'];
+  const help = !!wakeFlags['help'];
+
+  return { mode, minify, passthroughArgs, help };
 }
 
-function runCli(mode) {
+function runCli(mode, minify, passthroughArgs) {
   switch (mode) {
     case 'all':
-      runStorefront();
-      runTailwind();
+      runStorefront(passthroughArgs);
+      runTailwind(minify, []);
       break;
     case 'storefront':
-      runStorefront();
+      runStorefront(passthroughArgs);
       break;
     case 'tailwind':
-      runTailwind();
+      runTailwind(minify, passthroughArgs);
       break;
     default:
       printUsage();
@@ -169,8 +256,14 @@ function isCliEntrypoint() {
 }
 
 if (isCliEntrypoint()) {
-  const mode = process.env.WAKE_MODE || process.argv[2] || 'all';
-  runCli(mode);
+  const { mode, minify, passthroughArgs, help } = parseArgs();
+
+  if (help) {
+    printHelp();
+    process.exit(0);
+  }
+
+  runCli(mode, minify, passthroughArgs);
 }
 
 module.exports = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wake-runner",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "CLI to start Wake storefront projects",
   "repository": {
     "type": "git",
@@ -25,4 +25,4 @@
     "wake-tailwind": "bin/wake-tailwind.js"
   },
   "license": "MIT"
-}
+}