poops 1.0.20 → 1.2.0

package/poops.js

@@ -1,193 +1,168 @@
 #!/usr/bin/env node
 
-const chokidar = require('chokidar')
-const connect = require('connect')
-const Copy = require('./lib/copy.js')
-const helpers = require('./lib/utils/helpers.js')
-const http = require('node:http')
-const livereload = require('livereload')
-const Markups = require('./lib/markups.js')
-const path = require('node:path')
-const serveStatic = require('serve-static')
-const Scripts = require('./lib/scripts.js')
-const PrintStyle = require('./lib/utils/print-style.js')
-const Styles = require('./lib/styles.js')
-const portscanner = require('portscanner')
-
-const { pathExists, doesFileBelongToPath } = helpers
+import chokidar from 'chokidar'
+import connect from 'connect'
+import Copy from './lib/copy.js'
+import { pathExists, doesFileBelongToPath } from './lib/utils/helpers.js'
+import http from 'node:http'
+import os from 'node:os'
+import fs from 'node:fs'
+import livereload from 'livereload'
+import Markups from './lib/markups.js'
+import path from 'node:path'
+import serveStatic from 'serve-static'
+import Reactor from './lib/reactor.js'
+import Scripts from './lib/scripts.js'
+import log, { styledLog } from './lib/utils/log.js'
+import Styles from './lib/styles.js'
+import PostCSS from './lib/postcss.js'
+import Argoyle from 'argoyle'
+import portscanner from 'portscanner'
 
 const cwd = process.cwd() // Current Working Directory
-const pkg = require('./package.json')
-const args = process.argv.slice(2)
-const pstyle = new PrintStyle()
-
-let build = false
-let defaultConfigPath = 'poops.json'
-let overridePort = null
-let overrideLivereloadPort = null
-
-for (let i = 0; i < args.length; i++) {
-  const arg = args[i]
-  switch (arg) {
-    case '-b':
-    case '--build':
-      build = true
-      break
-    case '-c':
-    case '--config':
-      if (args.length === i + 1 || args[i + 1].startsWith('-')) {
-        console.log(`${pstyle.redBright + pstyle.bold}[error]${pstyle.reset} Missing config file path`)
-        process.exit(1)
-      }
-      defaultConfigPath = args[i + 1]
-      i++
-      break
-    case '-p':
-    case '--port':
-      if (args.length === i + 1 || args[i + 1].startsWith('-') || isNaN(args[i + 1])) {
-        console.log(`${pstyle.redBright + pstyle.bold}[error]${pstyle.reset} Missing port number`)
-        process.exit(1)
-      }
-      overridePort = args[i + 1]
-      i++
-      break
-    case '-l':
-    case '--livereload':
-      if (args.length === i + 1 || args[i + 1].startsWith('-') || isNaN(args[i + 1])) {
-        console.log(`${pstyle.redBright + pstyle.bold}[error]${pstyle.reset} Missing livereload port number`)
-        process.exit(1)
-      }
-      overrideLivereloadPort = args[i + 1]
-      i++
-      break
-    case '-v':
-    case '--version':
-      console.log(pkg.version)
-      process.exit(0)
-      break
-    case '-h':
-    case '--help':
-      console.log(`Usage: ${pkg.name} [config-file] [options]
-      -b, --build\t\tBuild the project and exit
-      -c, --config\t\tSpecify the config file
-      -h, --help\t\tShow this help message
-      -l, --livereload\t\tSpecify the port to use for the livereload server, overrides the config file
-      -p, --port\t\tSpecify the port to use for the server, overrides the config file
-      -v, --version\t\tShow version number`)
-      process.exit(0)
-      break
-    default:
-      if (arg.startsWith('-')) {
-        console.log(`Unknown option: ${arg}`)
-        process.exit(1)
-      } else {
-        defaultConfigPath = arg
-      }
-  }
+const pkg = JSON.parse(fs.readFileSync(new URL('./package.json', import.meta.url), 'utf-8'))
+
+const cli = new Argoyle(pkg.version)
+  .line(`Usage: ${pkg.name} [config-file] [options]\n`)
+  .option('build', { short: 'b', description: 'Build the project and exit' })
+  .option('config', { short: 'c', value: '<path>', description: 'Specify the config file' })
+  .option('port', { short: 'p', value: '<number>', description: 'Specify the port for the server, overrides the config file' })
+  .option('livereload-port', { short: 'l', value: '<number>', description: 'Specify the port for the livereload server, overrides the config file' })
+
+let flags, positionals
+try {
+  ({ flags, positionals } = cli.parse())
+} catch (err) {
+  log({ tag: 'error', text: err.message })
+  process.exit(1)
 }
 
+const build = flags.build
+const defaultConfigPath = flags.config || positionals[0] || 'poops.json'
+const overridePort = flags.port
+const overrideLivereloadPort = flags['livereload-port']
+
 let configPath = path.join(cwd, defaultConfigPath)
 if (!pathExists(configPath)) configPath = path.join(cwd, '💩.json') // TODO: Ok dude, I know it's late, but you can do better than this.
 
-// Main function 💩
-async function poops() {
-  let lport
-  if (config.livereload) {
-    lport = overrideLivereloadPort || config.livereload.port || 35729
-    if (!overrideLivereloadPort) lport = await getAvailablePort(lport, lport + 10)
-    config.livereload_port = lport
+async function resolveLiveReloadPort(config) {
+  if (!config.livereload) return null
+  let liveReloadPort = overrideLivereloadPort || config.livereload.port || 35729
+  if (!overrideLivereloadPort) liveReloadPort = await getAvailablePort(liveReloadPort, liveReloadPort + 10)
+  config.livereload_port = liveReloadPort
+}
+
+function setupLiveReloadServer(config) {
+  if (!config.livereload) return null
+  const liveReloadExcludes = ['.git', '.svn', '.hg']
+
+  if (config.watch) {
+    liveReloadExcludes.push(...config.watch)
   }
 
-  const styles = new Styles(config)
-  const scripts = new Scripts(config)
-  const markups = new Markups(config)
-  const copy = new Copy(config)
+  if (config.includePaths) {
+    liveReloadExcludes.push(...config.includePaths)
+  }
 
-  if (build || (!config.watch && !config.livereload && !config.serve)) {
-    await styles.compile()
-    await scripts.compile()
-    await markups.compile()
-    await copy.execute()
-    process.exit(0)
+  if (config.livereload.exclude) {
+    liveReloadExcludes.push(...config.livereload.exclude)
   }
 
-  if (config.livereload) {
-    const lrExcludes = ['.git', '.svn', '.hg']
+  const liveReloadServer = livereload.createServer({
+    exclusions: [...new Set(liveReloadExcludes)],
+    port: config.livereload_port
+  })
+  styledLog(`🔃 {dim}LiveReload  :{/} ${liveReloadServer.config.port}`)
+  console.log()
+  liveReloadServer.watch(cwd)
+}
 
-    if (config.watch) {
-      lrExcludes.push(...config.watch)
+function setupWatchers(config, modules) {
+  if (!config.watch) return
+
+  // TODO: think about watching the updates of the config file itself, we can reload the config and recompile everything.
+  // TODO: ability to automatically create a watch list of directories if watch is set to true. The list will be generated from the `in` property of each task.
+  chokidar.watch(config.watch, { ignoreInitial: true }).on('change', (file) => {
+    if (/(\.m?jsx?|\.tsx?)$/i.test(file)) {
+      modules.scripts.compile().catch(err => console.error(err))
+
+      if (modules.reactor.belongsToReactor(file)) {
+        modules.reactor.compile().then(() => {
+          if (modules.reactor.renderedChanged) {
+            config.reactorData = modules.reactor.getRendered()
+            modules.markups.compile().then(() => modules.postcss.compile()).catch(err => console.error(err))
+          }
+        }).catch(err => console.error(err))
+      }
     }
-
-    if (config.includePaths) {
-      lrExcludes.push(...config.includePaths)
+    if (/(\.sass|\.scss|\.css)$/i.test(file)) {
+      modules.styles.compile().then(() => modules.postcss.compile()).catch(err => console.error(err))
+    }
+    if (/(\.html|\.xml|\.rss|\.atom|\.njk|\.liquid|\.md)$/i.test(file)) {
+      modules.markups.compile().then(() => modules.postcss.compile()).catch(err => console.error(err))
     }
 
-    if (config.livereload.exclude) {
-      lrExcludes.push(...config.livereload.exclude)
+    // TODO: We can actually reload the page only if the data file from data has changed.
+    if (/(\.json|\.ya?ml)$/i.test(file)) {
+      modules.markups.reloadDataFiles().then(() => modules.markups.compile()).catch(err => console.error(err))
     }
 
-    const lrserver = livereload.createServer({
-      exclusions: [...new Set(lrExcludes)],
-      port: lport
-    })
-    console.log(`${pstyle.blue + pstyle.bold}[info]${pstyle.reset} 🔃${pstyle.dim} LiveReload server:${pstyle.reset} ${pstyle.italic + pstyle.underline}http://localhost:${lrserver.config.port}${pstyle.reset}\n`)
-    lrserver.watch(cwd)
-  }
+    doesFileBelongToPath(file, config.copy) && modules.copy.execute().catch(err => console.error(err))
+  }).on('unlink', (file) => {
+    if (/(\.html|\.xml|\.rss|\.atom|\.njk|\.liquid|\.md)$/i.test(file)) {
+      modules.markups.compile().catch(err => console.error(err))
+    }
+    modules.copy.unlink(file, doesFileBelongToPath(file, config.copy))
+  }).on('unlinkDir', (dirPath) => {
+    doesFileBelongToPath(dirPath, config.markup) && modules.markups.compile().catch(err => console.error(err))
+    modules.copy.unlink(dirPath, doesFileBelongToPath(dirPath, config.copy))
+  }).on('add', (file) => {
+    if (/(\.json|\.ya?ml)$/i.test(file)) {
+      modules.markups.reloadDataFiles().then(() => modules.markups.compile()).catch(err => console.error(err))
+    }
+    doesFileBelongToPath(file, config.copy) && modules.copy.execute().catch(err => console.error(err))
+  })
+}
 
-  await styles.compile()
-  await scripts.compile()
-  await markups.compile()
-  await copy.execute()
+// Main function 💩
+async function poops() {
+  const styles = new Styles(config)
+  const postcss = new PostCSS(config)
+  const reactor = new Reactor(config)
+  const scripts = new Scripts(config)
+  const markups = new Markups(config)
+  const copy = new Copy(config)
 
-  if (config.watch) {
-    // TODO: think about watching the updates of the config file itself, we can reload the config and recompile everything.
-    // TODO: ability to automatically create a watch list of directories if watch is set to true. The list will be generated from the `in` property of each task.
-    chokidar.watch(config.watch, { ignoreInitial: true }).on('change', (file) => {
-      if (/(\.m?js|\.ts)$/i.test(file)) scripts.compile()
-      if (/(\.sass|\.scss|\.css)$/i.test(file)) styles.compile()
-      if (/(\.html|\.xml|\.rss|\.atom|\.njk|\.md)$/i.test(file)) markups.compile()
-
-      // TODO: We can actually reload the page only if the data file from data has changed.
-      if (/(\.json|\.ya?ml)$/i.test(file)) {
-        markups.reloadDataFiles().then(() => {
-          markups.compile()
-        })
-      }
+  try { await styles.compile() } catch (err) { console.error(err) }
+  try { await reactor.compile() } catch (err) { console.error(err) }
+  config.reactorData = reactor.getRendered()
+  try { await scripts.compile() } catch (err) { console.error(err) }
+  try { await markups.compile() } catch (err) { console.error(err) }
+  try { await postcss.compile() } catch (err) { console.error(err) }
+  try { await copy.execute() } catch (err) { console.error(err) }
 
-      doesFileBelongToPath(file, config.copy) && copy.execute()
-    }).on('unlink', (file) => {
-      if (/(\.html|\.xml|\.rss|\.atom|\.njk|\.md)$/i.test(file)) markups.compile()
-      copy.unlink(file, doesFileBelongToPath(file, config.copy))
-    }).on('unlinkDir', (path) => {
-      doesFileBelongToPath(path, config.markup) && markups.compile()
-      copy.unlink(path, doesFileBelongToPath(path, config.copy))
-    }).on('add', (file) => {
-      if (/(\.json|\.ya?ml)$/i.test(file)) {
-        markups.reloadDataFiles().then(() => {
-          markups.compile()
-        })
-      }
-      doesFileBelongToPath(file, config.copy) && copy.execute()
-    })
+  if (build || (!config.watch && !config.livereload && !config.serve)) {
+    process.exit(0)
   }
+
+  setupWatchers(config, { styles, postcss, reactor, scripts, markups, copy })
 }
 
 // CLI Header
 const title = `💩 Poops — v${pkg.version}`
-console.log(`\n${pstyle.color('#8b4513')}${title}
-${title.replace(/./g, '-')}${pstyle.reset + pstyle.bell}\n`)
+styledLog(`\n{#8b4513}${title}\n${title.replace(/./g, '-')}{/}{bell}\n`)
 
 // Check if poops.json exists
 if (!pathExists(configPath)) {
-  console.log(`${pstyle.redBright + pstyle.bold}[error]${pstyle.reset} \`${pstyle.underline}${defaultConfigPath}${pstyle.reset}\` or \`${pstyle.underline}💩.json${pstyle.reset}\` not found.
-${pstyle.dim}Configuration file \`${defaultConfigPath}\` or \`💩.json\` not found in your working directory: ${pstyle.underline}${cwd}${pstyle.reset}\n
-${pstyle.dim}Please specify another file path or create a \`poops.json\` or \`💩.json\` file in your working directory and try again.\n
-${pstyle.dim}For information on the structure of the configuration file, please visit: \n${pstyle.underline}https://stamat.github.io/poops${pstyle.reset}\n`)
+  styledLog(`{bold.redBright|[error]} \`{underline|${defaultConfigPath}}\` or \`{underline|💩.json}\` not found.
+{dim}Configuration file \`${defaultConfigPath}\` or \`💩.json\` not found in your working directory: {underline}${cwd}{/}{dim}\n
+{/}{dim}Please specify another file path or create a \`poops.json\` or \`💩.json\` file in your working directory and try again.\n
+{/}{dim}For information on the structure of the configuration file, please visit: \n{underline}https://stamat.github.io/poops{/}\n`)
   process.exit(1)
 }
 
 // Load poops.json
-const config = require(configPath)
+const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'))
 
 if (config.watch) {
   config.watch = Array.isArray(config.watch) ? config.watch : [config.watch]
@@ -199,6 +174,11 @@ if (config.includePaths) {
   config.includePaths = ['node_modules']
 }
 
+// Backwards compatibility: support "ssg" as alias for "reactor"
+if (!config.reactor && config.ssg) {
+  config.reactor = config.ssg
+}
+
 async function getAvailablePort(port, max) {
   while (port < max) {
     const status = await portscanner.checkPortStatus(port, 'localhost')
@@ -211,7 +191,19 @@ async function getAvailablePort(port, max) {
   return port
 }
 
+function getLocalIP() {
+  const interfaces = os.networkInterfaces()
+  for (const iface of Object.values(interfaces)) {
+    for (const info of iface) {
+      if (info.family === 'IPv4' && !info.internal) return info.address
+    }
+  }
+  return 'localhost'
+}
+
 async function startServer() {
+  await resolveLiveReloadPort(config)
+  await poops() // Initial compilation before starting the server
   const app = connect()
 
   if (config.serve.base && pathExists(cwd, config.serve.base)) {
@@ -223,9 +215,12 @@ async function startServer() {
   let port = overridePort || config.serve.port || 4040
   if (!overridePort) port = await getAvailablePort(port, port + 10)
 
-  http.createServer(app).listen(parseInt(port), () => {
-    console.log(`${pstyle.blue + pstyle.bold}[info]${pstyle.reset} 🌍${pstyle.dim} Local server:${pstyle.reset} ${pstyle.italic + pstyle.underline}http://localhost:${port}${pstyle.reset}`)
-    poops()
+  // eslint-disable-next-line @stylistic/space-before-function-paren
+  http.createServer(app).listen(parseInt(port), '0.0.0.0', async () => {
+    console.log()
+    styledLog(`🏠 {dim}Local server:{/} {underline|http://localhost:${port}}`)
+    styledLog(`🛜 {dim} Network     :{/} {underline|http://${getLocalIP()}:${port}}`)
+    setupLiveReloadServer(config)
   })
 }
 

package/lib/utils/print-style.js

@@ -1,72 +0,0 @@
-module.exports = class PrintStyle {
-  reset = '\x1b[0m'
-  bold = '\x1b[1m'
-  dim = '\x1b[2m'
-  italic = '\x1b[3m'
-  underline = '\x1b[4m'
-  blink = '\x1b[5m'
-  inverse = '\x1b[7m'
-  hidden = '\x1b[8m'
-  strikethrough = '\x1b[9m'
-  black = '\x1b[30m'
-  red = '\x1b[31m'
-  redBright = '\x1b[91m'
-  green = '\x1b[32m'
-  greenBright = '\x1b[92m'
-  yellow = '\x1b[33m'
-  yellowBright = '\x1b[93m'
-  blue = '\x1b[34m'
-  blueBright = '\x1b[94m'
-  magenta = '\x1b[35m'
-  magentaBright = '\x1b[95m'
-  cyan = '\x1b[36m'
-  cyanBright = '\x1b[96m'
-  white = '\x1b[37m'
-  whiteBright = '\x1b[97m'
-  gray = '\x1b[90m'
-  bgBlack = '\x1b[40m'
-  bgRed = '\x1b[41m'
-  bgRedBright = '\x1b[101m'
-  bgGreen = '\x1b[42m'
-  bgGreenBright = '\x1b[102m'
-  bgYellow = '\x1b[43m'
-  bgYellowBright = '\x1b[103m'
-  bgBlue = '\x1b[44m'
-  bgBlueBright = '\x1b[104m'
-  bgMagenta = '\x1b[45m'
-  bgMagentaBright = '\x1b[105m'
-  bgCyan = '\x1b[46m'
-  bgCyanBright = '\x1b[106m'
-  bgWhite = '\x1b[47m'
-  bgWhiteBright = '\x1b[107m'
-  bgGray = '\x1b[100m'
-  bell = '\x07'
-
-  hexToRgb(hex) {
-    const sanitizedHex = hex.replace('#', '')
-    const red = parseInt(sanitizedHex.substring(0, 2), 16)
-    const green = parseInt(sanitizedHex.substring(2, 4), 16)
-    const blue = parseInt(sanitizedHex.substring(4, 6), 16)
-
-    return [red, green, blue]
-  }
-
-  terminalColorIndex(red, green, blue) {
-    return 16 +
-      Math.round(red / 255 * 5) * 36 +
-      Math.round(green / 255 * 5) * 6 +
-      Math.round(blue / 255 * 5)
-  }
-
-  color(hex) {
-    const [red, green, blue] = this.hexToRgb(hex)
-
-    return `\x1b[38;5;${this.terminalColorIndex(red, green, blue)}m`
-  }
-
-  background(hex) {
-    const [red, green, blue] = this.hexToRgb(hex)
-
-    return `\x1b[48;5;${this.terminalColorIndex(red, green, blue)}m`
-  }
-}