frontfire 0.1.4 → 0.2.3

package/.github/workflows/publish-npm.yml

@@ -0,0 +1,27 @@
+name: Publish to NPM
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ 16.x ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies 🔧
+        run: npm install
+
+      - name: Publish package on NPM 📦
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 InfrontJS
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 InfrontJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "frontfire",
-  "version": "0.1.4",
+  "version": "0.2.3",
   "description": "",
   "main": "src/index.js",
+  "type": "module",
   "scripts": {
     "start": "node src/index.js",
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -22,9 +23,13 @@
     "chalk": "^5.2.0",
     "commander": "^10.0.0",
     "conf": "^11.0.1",
-    "esbuild": "^0.17.4",
+    "esbuild": "^0.17.8",
     "esbuild-copy-static-files": "^0.1.0",
-    "esbuild-plugin-copy": "^2.0.2"
+    "esbuild-plugin-copy": "^2.0.2",
+    "fs-extra": "^11.1.1",
+    "lodash": "^4.17.21",
+    "php-server": "^1.0.0",
+    "prettier": "^2.8.4"
   },
   "bin": {
     "frontfire": "src/index.js"

package/src/DefaultConfig.js

@@ -0,0 +1,112 @@
+// Core
+import fs from "node:fs";
+import path from "node:path";
+
+// Plugins
+import { copy } from "esbuild-plugin-copy";
+import copyStaticFiles from "esbuild-copy-static-files";
+
+
+const rootFiles = fs.readdirSync( `src${path.sep}`, { withFileTypes : true } );
+const rootFilesToCopy = [];
+for ( let ri = 0; ri < rootFiles.length; ri++ )
+{
+    if ( rootFiles[ ri ].isDirectory() )
+    {
+        continue;
+    }
+
+    // Note
+    // It seems that the copy plugin requires normal slashes no matter what OS we are on
+    rootFilesToCopy.push( `src/` + rootFiles[ ri ].name );
+}
+
+const buildDir = 'build';
+const entryPoints = [
+    `src${path.sep}app${path.sep}main.js`,
+    `src${path.sep}app${path.sep}app.css`
+];
+
+const outDirDebug = `${buildDir}${path.sep}debug${path.sep}app${path.sep}`
+const outDirRelease = `${buildDir}${path.sep}release${path.sep}app${path.sep}`;
+
+const staticAssetsDestDebug = `${buildDir}${path.sep}debug${path.sep}assets`;
+const staticAssetsDestRelease = `${buildDir}${path.sep}release${path.sep}assets`;
+
+export default {
+  "buildDir" : buildDir,
+  "debug" : {
+      "server" : {
+          "indexType" : "html",
+          "port" : 3000
+      },
+      "esbuild" : {
+          bundle: true,
+          sourcemap: true,
+          minify: false,
+          logLevel: "info",
+          entryPoints : entryPoints,
+          outdir : outDirDebug,
+          loader: {
+              ".html" : "text",
+              ".png" : "file"
+          },
+          banner : {
+              js: "(() => { (new EventSource(\"/esbuild\")).addEventListener('change', () => location.reload() ); })();"
+          },
+          plugins: [
+              copy({
+                  resolveFrom : 'cwd',
+                  assets: [
+                      {
+                          from: rootFilesToCopy,
+                          to: [`${buildDir}${path.sep}debug` ]
+                      }
+                  ]
+              }),
+              copyStaticFiles({
+                  src: 'src/assets',
+                  dest: staticAssetsDestDebug,
+                  dereference: true,
+                  errorOnExist: false,
+                  preserveTimestamps: true,
+                  recursive: true
+              })
+          ]
+      },
+  },
+  "release" : {
+      "esbuild" : {
+          bundle: true,
+          sourcemap: true,
+          minify: true,
+          logLevel: "error",
+          entryPoints : entryPoints,
+          outdir : outDirRelease,
+          loader: {
+              ".html" : "text",
+              ".png" : "file"
+          },
+          plugins: [
+              copy({
+                  resolveFrom : 'cwd',
+                  assets: [
+                      {
+                          from: rootFilesToCopy,
+                          to: [`${buildDir}${path.sep}release` ]
+                      }
+                  ]
+              }),
+              copyStaticFiles({
+                  src: 'src/assets',
+                  dest: staticAssetsDestRelease,
+                  dereference: true,
+                  errorOnExist: false,
+                  preserveTimestamps: true,
+                  recursive: true
+              })
+          ]
+
+      }
+  }
+};

package/src/FrontFire.js

@@ -1,93 +1,64 @@
-const esbuild = require( "esbuild" );
-const { copy } = require( "esbuild-plugin-copy" );
-const copyStaticFiles = require( "esbuild-copy-static-files" );
-const http = require( "node:http" );
-const fs = require( 'node:fs' );
-const path = require( 'node:path' );
+import _ from "lodash";
+import esbuild from "esbuild";
+import http from "node:http";
+import fs from "node:fs";
+import fse from "fs-extra";
+import path from "node:path";
+import * as child from "child_process";
 
-const rootBuildDir = 'build';
+import DEFAULT_CONFIG from "./DefaultConfig.js";
 
-try
+export default async function frontFire( isWatch, cfg = {} )
 {
-    if ( fs.statSync( rootBuildDir ) )
+    const config = _.merge( DEFAULT_CONFIG, cfg );
+
+    const indexType = _.get( config, 'debug.server.indexType', 'html' );
+
+    const rootBuildDir = _.get( config, 'buildDir', null );
+    if ( null === rootBuildDir )
     {
-        console.log( "Cleaning build directory: " + rootBuildDir );
-        fs.rmSync( rootBuildDir, { recursive: true, force: true } );
+        throw new Error( 'No valid buildDir.' );
     }
-}
-catch( ie )
-{
-    // Fail silently
-    console.error( ie );
-}
 
-const rootFiles = fs.readdirSync( `src${path.sep}`, { withFileTypes : true } );
-const rootFilesToCopy = [];
-for ( let ri = 0; ri < rootFiles.length; ri++ )
-{
-    if ( rootFiles[ ri ].isDirectory() )
+    fse.ensureDirSync( rootBuildDir );
+    fse.ensureDirSync( `${rootBuildDir}${path.sep}debug` );
+    fse.ensureDirSync( `${rootBuildDir}${path.sep}release` );
+
+    try
     {
-        continue;
-    }
+        let dirToDelete = isWatch ? 'debug' : 'release';
+        dirToDelete = `${rootBuildDir}${path.sep}${dirToDelete}`;
 
-    // Note
-    // It seems that the copy plugin requires normal slashes no matter what OS we are on
-    rootFilesToCopy.push( `src/` + rootFiles[ ri ].name );
-}
+        if ( fs.statSync( dirToDelete ) )
+        {
+            console.log( "Cleaning build directory: " + dirToDelete );
+            fs.rmSync( dirToDelete, { recursive: true, force: true } );
+        }
+    }
+    catch( ie )
+    {
+        // Fail silently
+        console.error( ie );
+    }
 
-async function frontFire( isWatch )
-{
-    let opts = {
-        // esbuild options
-        bundle: true,
-        sourcemap: true,
-        minify: isWatch ? false : true,
-        logLevel: isWatch ? "info" : "error",
-        entryPoints : [ `src${path.sep}app${path.sep}main.js`, `src${path.sep}app${path.sep}app.css` ],
-        outdir : isWatch ? `${rootBuildDir}${path.sep}debug${path.sep}app${path.sep}` : `${rootBuildDir}${path.sep}release${path.sep}app${path.sep}`,
-        loader: {
-            ".html" : "text",
-            ".png" : "file"
-        },
-        plugins: [
-            copy({
-                resolveFrom : 'cwd',
-                assets: [
-                    {
-                        from: rootFilesToCopy,
-                        to: [ isWatch ? `${rootBuildDir}${path.sep}debug` : `${rootBuildDir}${path.sep}release` ]
-                    }
-                ]
-            }),
-            copyStaticFiles({
-                src: 'src/assets',
-                dest: isWatch ? `${rootBuildDir}${path.sep}debug${path.sep}assets` : `${rootBuildDir}${path.sep}release${path.sep}assets`,
-                dereference: true,
-                errorOnExist: false,
-                preserveTimestamps: true,
-                recursive: true
-            })
-        ]
-
-    };
+    let esbuildOpts = null;
 
     if ( true === isWatch )
     {
-        opts[ "banner" ] = {
-            js: "(() => { (new EventSource(\"/esbuild\")).addEventListener('change', () => location.reload() ); })();"
-        };
+        esbuildOpts = _.get( config, 'debug.esbuild' );
+    }
+    else
+    {
+        esbuildOpts = _.get( config, 'release.esbuild' );
     }
 
-    let ctx = await esbuild.context( opts );
+    let ctx = await esbuild.context( esbuildOpts );
 
     if ( true === isWatch )
     {
-        console.log( "Adding additional watcher..." );
         fs.watchFile( `src${path.sep}index.html`, async ( curr, prev ) =>
         {
-            console.log( "Index.html changed..." );
             const result = await ctx.rebuild();
-            console.log( result );
         });
         await ctx.watch();
         let { host, port } = await ctx.serve(
@@ -96,17 +67,6 @@ async function frontFire( isWatch )
             }
         );
 
-
-        let sseResponse = null;
-        /*
-        // DOES NOT WORK
-        setInterval( () =>
-        {
-            console.log( "Sending sse..." );
-            sseResponse.write( 'data: esbuild' );
-        }, 5000 );
-         */
-
         // Then start a proxy server on port 3000
         http.createServer((req, res) => {
 
@@ -116,8 +76,15 @@ async function frontFire( isWatch )
                 path: req.url,
                 method: req.method,
                 headers: req.headers,
-            }
+            };
 
+            if ( 'php' === indexType && req.url === "/" && req.method.toLowerCase() === 'get' )
+            {
+                const indexHtml = child.execSync( `php src${path.sep}index.php`);
+                res.writeHead( 200, { 'Content-Type': 'text/html' });
+                res.end( indexHtml.toString() );
+                return;
+            }
 
             // Check if path is a valid state route
             // then pass it as "index.html" to the server
@@ -127,17 +94,12 @@ async function frontFire( isWatch )
                 // If esbuild returns "not found", send a custom 404 page
                 if (proxyRes.statusCode === 404) {
                     res.writeHead(404, { 'Content-Type': 'text/html' })
-                    res.end('<h1>A custom 404 page</h1>')
-                    return
+                    res.end('<h1>A custom 404 page</h1>');
+                    return;
                 }
 
                 // Otherwise, forward the response from esbuild to the client
-                res.writeHead(proxyRes.statusCode, proxyRes.headers)
-
-                if ( req.url === '/esbuild' )
-                {
-                    sseResponse = res;
-                }
+                res.writeHead(proxyRes.statusCode, proxyRes.headers);
 
                 proxyRes.pipe(res, { end: true })
             });
@@ -154,6 +116,4 @@ async function frontFire( isWatch )
         await ctx.rebuild();
         ctx.dispose();
     }
-}
-
-module.exports = frontFire;
+};

package/src/index.js

@@ -1,16 +1,71 @@
 #! /usr/bin/env node
-const { program } = require( 'commander' );
-const frontFire = require( "./FrontFire.js" );
-
-program
-    .command( 'run-dev' )
-    .description( 'Running development server.' )
-    .action( function() {frontFire( true ); } );
-
-program
-    .command( 'build' )
-    .description( 'Building for production.' )
-    .action( function() {frontFire( false ); } );
-
-
-program.parse();
+
+import fs from "node:fs";
+
+import _ from "lodash";
+import prettier from "prettier";
+import { program } from "commander";
+
+import frontFire from "./FrontFire.js";
+import defaultConfig from "./DefaultConfig.js";
+
+async function performInit()
+{
+    // Deep Copy
+    const initConfig = JSON.parse( JSON.stringify( defaultConfig ) );
+
+    _.unset( initConfig, 'debug.esbuild.plugins' );
+    _.unset( initConfig, 'release.esbuild.plugins' );
+
+    fs.writeFileSync(
+        'frontfire.json',
+        prettier.format(
+            JSON.stringify( initConfig ),
+            {
+                semi: false,
+                parser: "json"
+            }
+        )
+    );
+
+
+}
+
+// Try to load custom config
+let customConfig = null;
+
+if ( fs.statSync( 'frontfire.json', { "throwIfNoEntry": false } ) )
+{
+    customConfig = fs.readFileSync( 'frontfire.json' );
+    if ( customConfig )
+    {
+        try
+        {
+            customConfig = JSON.parse( customConfig );
+        }
+        catch( e )
+        {
+            console.warn( 'Cannot read frontfire.json' );
+            customConfig = null;
+        }
+    }
+}
+
+program
+    .command( 'run-dev' )
+    .description( 'Running development server.' )
+    .action( function() { frontFire( true, customConfig ); } );
+
+program
+    .command( 'init' )
+    .description( 'Creates frontfire default configuration file in current directory.' )
+    .action( function() { performInit(); } );
+
+
+program
+    .command( 'build' )
+    .description( 'Building for production.' )
+    .action( function() { frontFire( false, customConfig ); } );
+
+
+program.parse();