docker-react 0.0.1-alpha.0 → 0.0.1-alpha.1

package/README.md

@@ -1,16 +1,23 @@
 # Docker React
 
-Tooling to deploy React applications with docker containers.
+CLI & base image to deploy React applications with docker containers.
 
 ## Features
 
-- [ ] Lightweight nginx container
-- [ ] Runtime environment variable injection
--   [ ] Javascript
--   [ ] HTML
-- [ ] Runtime environment variable validation
+- [ ] Configuration
+  - [ ] Command-line arguments
+  - [ ] Configuration file
+- [ ] Lightweight nginx docker container
+- [ ] CLI
+  - [ ] Runtime environment variable injection & validation
+    - [ ] Javascript
+    - [ ] HTML
+    - [ ] Hash file for cache invalidation
+  - [ ] Application initialization
+    - [ ] `index.html` file modification
+    - [ ] `Dockerfile` generation
+    - [ ] Schema and types generation
 - [ ] Support for serving at a path
-- [ ] Application initialisations
 
 ## Supported Tooling
 

package/dist/index.d.ts

@@ -1 +1 @@
-export declare function cli(): void;
+export declare function cli(args: string[]): void;

package/dist/index.js

@@ -1,3 +1,7 @@
-export function cli() {
-    console.log('Hello, World!');
+import { Command } from 'commander';
+import { addPrepCommand } from './prep.js';
+export function cli(args) {
+    const program = new Command();
+    addPrepCommand(program);
+    program.parse(args);
 }

package/dist/options.d.ts

@@ -0,0 +1,6 @@
+export declare type Environment = 'local' | 'docker';
+export interface Options {
+    environment: Environment;
+    schema: string;
+    destination: string;
+}

package/dist/options.js

@@ -0,0 +1 @@
+export {};

package/dist/prep.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare function addPrepCommand(program: Command): Command;

package/dist/prep.js

@@ -0,0 +1,51 @@
+import path from 'path';
+import { promises as fs } from 'fs';
+import dotenv from 'dotenv';
+const ENVIRONMENT_DEFINITION_FILE_NAME = 'window.env.js';
+export function addPrepCommand(program) {
+    return program
+        .command('prep')
+        .description('Prepare the application for serving')
+        .option('-e, --environment [string]', 'The environment to run preparation over', 'docker')
+        .option('-s, --schema [string]', 'The path to the schema file')
+        .option('-d, --destination [string', 'The path to the destination')
+        .action((options) => {
+        const { environment, schema = './joi.schema.js', destination = './', } = options;
+        generateEnvironmentFile(environment, schema, destination);
+    });
+}
+function validateEnvironmentVariables(schema, environmentVariables) {
+    const joiResult = schema.validate(environmentVariables, {
+        allowUnknown: true,
+        abortEarly: false,
+        stripUnknown: true,
+    });
+    if (joiResult.error) {
+        throw new Error(joiResult.error.message);
+    }
+    return joiResult.value;
+}
+async function generateEnvironmentFile(environment, schemaPath, destinationPath) {
+    // For local environments attempt to load from `.env` files if available.
+    if (environment === 'local') {
+        const result = dotenv.config();
+        if (result.error) {
+            throw result.error;
+        }
+    }
+    // Perform environment variable validation.
+    const schemaLocation = path.join(process.cwd(), schemaPath);
+    console.log(`Attempting to load schema from ${schemaLocation}`);
+    const providedSchema = await import(schemaLocation);
+    // const envSchema = baseSchema.concat(providedSchema);
+    const envSchema = providedSchema.default;
+    console.log('Validating environment variables');
+    const validatedWindowVariables = validateEnvironmentVariables(envSchema, process.env);
+    // Prepare file and calculate hash
+    console.log('Attempting to generate environment file.');
+    const mappedWindowVariables = Object.entries(validatedWindowVariables).map((entry) => `${entry[0]}:'${entry[1]}'`);
+    const windowVariablesToBeWrittenToFile = `window.env={${mappedWindowVariables}};`;
+    const envFileDestination = path.join(destinationPath, ENVIRONMENT_DEFINITION_FILE_NAME);
+    console.log(`Writing window env file to ${envFileDestination}`);
+    await fs.writeFile(envFileDestination, windowVariablesToBeWrittenToFile, 'utf8');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docker-react",
-  "version": "0.0.1-alpha.0",
+  "version": "0.0.1-alpha.1",
   "description": "Tooling to deploy React applications with docker containers.",
   "main": "dist/index.js",
   "type": "module",
@@ -27,6 +27,12 @@
   "homepage": "https://github.com/danielemery/docker-react#readme",
   "devDependencies": {
     "@danielemeryau/prettier-config": "^0.0.6",
+    "@types/node": "^16.0.0",
     "typescript": "^4.5.4"
+  },
+  "dependencies": {
+    "commander": "^8.3.0",
+    "dotenv": "^10.0.0",
+    "joi": "^17.5.0"
   }
 }