5htp 0.0.6 → 0.0.8

package/src/app/index.ts

@@ -0,0 +1,75 @@
+/*----------------------------------
+- DEPENDANCES
+----------------------------------*/
+
+// npm
+import TsAlias from 'ts-alias';
+
+// Cre
+import cli from '..';
+
+// Specific
+import ConfigParser from './config';
+
+/*----------------------------------
+- TYPES
+----------------------------------*/
+
+export type TAppSide = 'server' | 'client'
+
+/*----------------------------------
+- SERVICE
+----------------------------------*/
+export default class App {
+
+    // config
+    // WARNING: High level config files (env and services) shouldn't be loaded from the CLI
+    //  The CLI will be run on CircleCI, and no env file should be sent to this service
+    public identity!: Core.Config.Identity;
+
+    public paths = {
+        root: cli.paths.appRoot,
+        src: cli.paths.appRoot + '/src',
+        bin: cli.paths.appRoot + '/bin',
+        data: cli.paths.appRoot + '/var/data',
+        public: cli.paths.appRoot + '/public',
+        pages: cli.paths.appRoot + '/src/client/pages',
+        cache: cli.paths.appRoot + '/src/.cache',
+
+        withAlias: (filename: string, side: TAppSide) => 
+            this.aliases[side].apply(filename),
+
+        withoutAlias: (filename: string, side: TAppSide) => 
+            this.aliases[side].realpath(filename),
+    }
+
+    public constructor() {
+        
+        console.log(`[cli] Loading app config ...`);
+        const configParser = new ConfigParser( cli.paths.appRoot );
+        this.identity = configParser.identity();
+    }
+
+    /*----------------------------------
+    - ALIAS
+    ----------------------------------*/
+
+    public aliases = {
+        client: new TsAlias({
+            rootDir: this.paths.root + '/src/client',
+            modulesDir: [ 
+                cli.paths.appRoot + '/node_modules',  
+                cli.paths.coreRoot + '/node_modules'
+            ],
+            debug: false
+        }),
+        server: new TsAlias({
+            rootDir: this.paths.root + '/src/server',
+            modulesDir: [ 
+                cli.paths.appRoot + '/node_modules',  
+                cli.paths.coreRoot + '/node_modules'
+            ],
+            debug: false
+        }),
+    }
+}

package/src/commands/build.ts

@@ -8,6 +8,9 @@ import prompts from 'prompts';
 // Configs
 import createCompilers from '../compiler';
 
+// Core
+import App from '../app';
+
 /*----------------------------------
 - TYPES
 ----------------------------------*/
@@ -17,7 +20,9 @@ import createCompilers from '../compiler';
 ----------------------------------*/
 export const run = (): Promise<void> => new Promise(async (resolve) => {
 
-    const multiCompiler = await createCompilers('prod');
+    const app = new App();
+
+    const multiCompiler = await createCompilers(app, 'prod');
 
     multiCompiler.run((error, stats) => {
 

package/src/commands/deploy/web.ts

@@ -38,11 +38,11 @@ export async function run() {
 
     const { simulate } = cli.args;
 
-    const temp = cli.paths.app.root + '/.deployment';
+    const temp = app.paths.root + '/.deployment';
     fs.emptyDirSync(temp);
 
     // Merge package.json: framework + app
-    const appPkg = fs.readJSONSync(cli.paths.app.root + '/package.json');
+    const appPkg = fs.readJSONSync(app.paths.root + '/package.json');
     const corePkg = fs.readJSONSync(cli.paths.core.root + '/package.json');
     fs.outputJSONSync(temp + '/package.json', {
         ...appPkg,
@@ -51,7 +51,7 @@ export async function run() {
     }, { spaces: 4 });
 
     // Copy config file
-    fs.copyFileSync( cli.paths.app.root + (simulate ? '/env.yaml' : '/env.server.yaml'), temp + '/env.yaml' );
+    fs.copyFileSync( app.paths.root + (simulate ? '/env.yaml' : '/env.server.yaml'), temp + '/env.yaml' );
 
     // Compile & Run Docker
     await cli.shell(`docker compose up --build`);

package/src/commands/dev.ts

@@ -7,18 +7,23 @@ import fs from 'fs-extra';
 import { spawn, ChildProcess } from 'child_process';
 
 // Cor elibs
+import cli from '../';
 import Keyboard from '../utils/keyboard';
 
 // Configs
 import createCompilers, { compiling } from '../compiler';
-import cli from '../';
+
+// Core
+import App from '../app';
 
 /*----------------------------------
 - COMMANDE
 ----------------------------------*/
 export const run = () => new Promise<void>(async () => {
+    
+    const app = new App();
 
-    const multiCompiler = await createCompilers('dev', {
+    const multiCompiler = await createCompilers(app, 'dev', {
         before: () => {
 
             console.log('before');
@@ -31,9 +36,6 @@ export const run = () => new Promise<void>(async () => {
         }
     });
 
-    // Allow the dev servet to fetch the frameworg node modules
-    //fs.createSymlinkSync( cli.paths.core.cli + '/node_modules', cli.paths.app.bin + '/node_modules', 'dir' );
-
     multiCompiler.watch({
 
         // https://webpack.js.org/configuration/watch/#watchoptions
@@ -53,7 +55,7 @@ export const run = () => new Promise<void>(async () => {
         }
 
         console.log("Watch callback. Reloading app ...");
-        startApp();
+        startApp(app);
 
     });
 
@@ -63,7 +65,7 @@ export const run = () => new Promise<void>(async () => {
         await Promise.all(Object.values(compiling));
 
         console.log(`Reloading app ...`);
-        startApp();
+        startApp(app);
 
     });
 
@@ -78,12 +80,12 @@ export const run = () => new Promise<void>(async () => {
 ----------------------------------*/
 let cp: ChildProcess | undefined = undefined;
 
-async function startApp() {
+async function startApp(app: App) {
 
     stopApp();
 
     console.info(`Launching new server ...`);
-    cp = spawn('node', ['' + cli.paths.app.bin + '/server.js', '--preserve-symlinks'], {
+    cp = spawn('node', ['' + app.paths.bin + '/server.js', '--preserve-symlinks'], {
 
         // sdin, sdout, sderr
         stdio: ['inherit', 'inherit', 'inherit']

package/src/commands/init.ts

@@ -0,0 +1,85 @@
+/*----------------------------------
+- DEPENDANCES
+----------------------------------*/
+
+// Npm
+import fs from 'fs-extra';
+import path from 'path';
+import prompts from 'prompts';
+import cmd from 'node-cmd';
+import replaceOnce from 'replace-once';
+
+// Cor elibs
+import cli from '../';
+
+// Configs
+const filesToConfig = [
+    'package.json',
+    'identity.yaml'
+]
+
+/*----------------------------------
+- COMMANDE
+----------------------------------*/
+export const run = () => new Promise<void>(async () => {
+    
+    const config = await prompts([{
+        type: 'text', name: 'name',
+        message: 'Project name ?',
+        initial: "MyProject",
+        validate: value => /[a-z0-9\-\.]/i.test(value) || "Must only include alphanumeric characters, and - . "
+    },{
+        type: 'text', name: 'dirname',
+        message: 'Folder name ?',
+        initial: value => value.toLowerCase(),
+        validate: value => /[a-z0-9\-\.]/.test(value) || "Must only include lowercase alphanumeric characters, and - . "
+    },{
+        type: 'text', name: 'description',
+        message: 'Briefly describe your project to your mom:',
+        initial: "It will revolutionnize the world",
+        validate: value => /[a-z0-9\-\. ]/i.test(value) || "Must only include alphanumeric characters, and - . "
+    },{
+        type: 'toggle', name: 'microservice',
+        message: 'Separate API from the UI servers ?'
+    }]);
+
+    const placeholders = {
+        PROJECT_NAME: config.name,
+        PACKAGE_NAME: config.name.toLowerCase(),
+        PROJECT_DESCRIPTION: config.description
+    }
+
+    const paths = {
+        skeleton: path.join( cli.paths.core.cli, 'skeleton'),
+        project: path.join( process.cwd(), config.dirname)
+    }
+
+    // Copy skeleton to cwd/<project-name>
+    console.info("Creating project skeleton ...");
+    fs.copySync( paths.skeleton, paths.project );
+    
+    // Replace placeholders
+    console.info("Configuring project ...");
+    for (const file of filesToConfig) {
+        console.log('- ' + file);
+
+        const filepath = path.join( paths.project, file )
+        const content = fs.readFileSync(filepath, 'utf-8');
+
+        const placeholders_keys = Object.keys(placeholders).map(k => '{{ ' + k + ' }}')
+        const values = Object.values(placeholders);
+
+        fs.writeFileSync(filepath, 
+            replaceOnce(content, placeholders_keys, values)    
+        );
+    }
+
+    // Npm install
+    console.info("Installing packages ...");
+    cmd.runSync(`cd "${paths.project}" && npm i`);
+
+    // Run demo app
+    /*console.info("Run demo ...");
+    await cli.shell('5htp dev');*/
+
+});

package/src/compiler/client/identite.ts

@@ -4,20 +4,22 @@ import fs from 'fs-extra';
 
 // Libs
 import cli from '../..';
-    
 
-export default async () => {
+// Type
+import type App from '../../app';
 
-    const dossierCache = cli.paths.app.root + '/public/app';
+export default async ( app: App ) => {
+
+    const dossierCache = app.paths.root + '/public/app';
 
     if (!fs.existsSync(dossierCache)) {
 
         console.info(`Generating identity assets ...`);
         fs.emptyDirSync(dossierCache);
 
-        const identity = cli.identity;
+        const identity = app.identity;
 
-        const response = await favicons( cli.paths.app.root + '/src/client/assets/identity/logo.svg', {
+        const response = await favicons( app.paths.root + '/src/client/assets/identity/logo.svg', {
 
             path: '/assets/img/identite/favicons/',
             appName: identity.name,

package/src/compiler/client/index.ts

@@ -26,32 +26,35 @@ import createCommonConfig, { TCompileMode, regex } from '../common';
 import identityAssets from './identite';
 import cli from '../..';
 
+// Type
+import type App from '../../app';
+
 /*----------------------------------
 - CONFIG
 ----------------------------------*/
-export default function createCompiler(mode: TCompileMode): webpack.Configuration {
+export default function createCompiler( app: App, mode: TCompileMode ): webpack.Configuration {
 
     console.info(`Creating compiler for client (${mode}).`);
     const dev = mode === 'dev';
 
-    const commonConfig = createCommonConfig('client', mode);
+    const commonConfig = createCommonConfig(app, 'client', mode);
 
     // Pas besoin d'attendre que les assets soient générés pour lancer la compilation
-    identityAssets();
+    identityAssets(app);
 
     // Symlinks to public
-    /*const publicDirs = fs.readdirSync(cli.paths.app.root + '/public');
+    /*const publicDirs = fs.readdirSync(app.paths.root + '/public');
     for (const publicDir of publicDirs)
         fs.symlinkSync( 
-            cli.paths.app.root + '/public/' + publicDir,  
-            cli.paths.app.public + '/' + publicDir
+            app.paths.root + '/public/' + publicDir,  
+            app.paths.public + '/' + publicDir
         );*/
 
     // Convert tsconfig cli.paths to webpack aliases
-    const { aliases } = cli.paths.aliases.client.forWebpack(cli.paths.app.root + '/node_modules');
+    const { aliases } = app.aliases.client.forWebpack(app.paths.root + '/node_modules');
     // Disable access to server-side libs from client side
     delete aliases["@server"]; 
-    delete aliases["@/server"]; 
+    delete aliases["@/server"];
 
     const config: webpack.Configuration = {
 
@@ -73,7 +76,7 @@ export default function createCompiler(mode: TCompileMode): webpack.Configuratio
         output: {
 
             pathinfo: dev,
-            path: cli.paths.app.bin + '/public',
+            path: app.paths.bin + '/public',
             filename: '[name].js', // Output client.js
             assetModuleFilename: '[hash][ext]',
 
@@ -101,21 +104,21 @@ export default function createCompiler(mode: TCompileMode): webpack.Configuratio
                     test: regex.scripts,
                     include: [
 
-                        cli.paths.app.root + '/src/client',
+                        app.paths.root + '/src/client',
                         cli.paths.core.root + '/src/client',
 
-                        cli.paths.app.root + '/src/common',
+                        app.paths.root + '/src/common',
                         cli.paths.core.root + '/src/common',
 
                     ],
-                    rules: require('../common/babel')('client', dev)
+                    rules: require('../common/babel')(app, 'client', dev)
                 },
 
                 // Les pages étan tà la fois compilées dans le bundle client et serveur
                 // On ne compile les ressources (css) qu'une seule fois
                 {
                     test: regex.style,
-                    rules: require('../common/files/style')(true, dev),
+                    rules: require('../common/files/style')(app, true, dev),
 
                     // Don't consider CSS imports dead code even if the
                     // containing package claims to have no side effects.
@@ -124,14 +127,14 @@ export default function createCompiler(mode: TCompileMode): webpack.Configuratio
                     sideEffects: true,
                 },
 
-                ...require('../common/files/images')(dev, true),
+                ...require('../common/files/images')(app, dev, true),
 
-                ...require('../common/files/autres')(dev, true),
+                ...require('../common/files/autres')(app, dev, true),
 
                 // Exclude dev modules from production build
                 /*...(dev ? [] : [
                     {
-                        test: cli.paths.app.root + '/node_modules/react-deep-force-update/lib/index.js'),
+                        test: app.paths.root + '/node_modules/react-deep-force-update/lib/index.js'),
                         loader: 'null-loader',
                     },
                 ]),*/
@@ -149,7 +152,7 @@ export default function createCompiler(mode: TCompileMode): webpack.Configuratio
             // Emit a file with assets cli.paths
             // https://github.com/webdeveric/webpack-assets-manifest#options
             new WebpackAssetsManifest({
-                output: cli.paths.app.root + `/bin/asset-manifest.json`,
+                output: app.paths.root + `/bin/asset-manifest.json`,
                 publicPath: true,
                 writeToDisk: true, // Force la copie du fichier sur e disque, au lieu d'en mémoire en mode dev
                 customize: ({ key, value }) => {
@@ -159,7 +162,7 @@ export default function createCompiler(mode: TCompileMode): webpack.Configuratio
                 },
                 done: (manifest, stats) => {
                     // Write chunk-manifest.json.json
-                    const chunkFileName = cli.paths.app.root + `/bin/chunk-manifest.json`;
+                    const chunkFileName = app.paths.root + `/bin/chunk-manifest.json`;
                     try {
                         const fileFilter = file => !file.endsWith('.map');
                         const addPath = file => manifest.getPublicPath(file);