@raisenow/tamaro-cli 1.1.8 → 1.2.0

package/dist/cli.js

@@ -27,6 +27,37 @@ import {
 // src/cli.ts
 import { createCommand } from "commander";
 
+// src/commands/validate.ts
+import { glob } from "glob";
+
+// src/lib/validators/validateEmailTemplates.ts
+import fs from "node:fs/promises";
+import handlebars from "handlebars";
+var { compile } = handlebars;
+var validateEmailTemplates = async (templateFiles) => {
+  const errors = [];
+  for (const templateFile of templateFiles) {
+    try {
+      const compiled = compile(await fs.readFile(templateFile, "utf-8"));
+      compiled({});
+      console.log(`${templateFile} is a valid email template`);
+    } catch (e) {
+      errors.push(`${templateFile} is invalid`);
+      errors.push(e);
+    }
+  }
+  return errors;
+};
+
+// src/commands/validate.ts
+var validate = async () => {
+  const errors = await validateEmailTemplates(await glob("email-config/templates/**/*.hbs"));
+  if (errors.length) {
+    halt(errors.map((el) => el.toString()).join("\n"));
+  }
+  logTitle("Valid. Bye.");
+};
+
 // src/lib/aws.ts
 import { execaCommandSync } from "execa";
 import prompts from "prompts";
@@ -151,6 +182,7 @@ var build = async (options) => {
     options.profile = await promptProfile();
   }
   assertOptionsValid(options);
+  await validate();
   const flags = prepareFlags2(options);
   const { ifCore } = getIfCoreFns();
   const paths = getPaths(ifCore);
@@ -228,6 +260,7 @@ var deploy = async (options) => {
     options.profile = await promptProfile();
   }
   assertOptionsValid2(options);
+  await validate();
   awsAuthenticate(options);
   const flags = prepareFlags(options);
   const { tag } = options;
@@ -335,6 +368,7 @@ var deployEmailConfig = async (options) => {
     options.bucket = options.ci ? AWS_S3_BUCKET_TAMARO_EMAIL_CONFIG_PROD : await promptBucketTamaroEmailConfig();
   }
   assertOptionsValid3(options);
+  await validate();
   awsAuthenticate(options);
   const flags = prepareFlags(options);
   const configName = getWidgetUuid();
@@ -577,7 +611,7 @@ var prepareFlags4 = async (options) => {
 // package.json
 var package_default = {
   name: "@raisenow/tamaro-cli",
-  version: "1.1.8",
+  version: "1.2.0",
   author: {
     name: "RaiseNow",
     email: "development@raisenow.com"
@@ -650,6 +684,8 @@ var package_default = {
     "file-loader": "^6.2.0",
     "fork-ts-checker-webpack-plugin": "^9.0.2",
     glob: "^11.0.0",
+    handlebars: "^4.7.8",
+    "handlebars-helpers": "^0.10.0",
     "html-loader": "^5.1.0",
     "html-webpack-plugin": "^5.6.3",
     "json-loader": "^0.5.7",
@@ -659,7 +695,9 @@ var package_default = {
     portfinder: "^1.0.32",
     postcss: "^8.4.49",
     "postcss-custom-properties": "^14.0.4",
+    "postcss-import": "^16.1.1",
     "postcss-loader": "^8.1.1",
+    "postcss-nested": "^7.0.2",
     prettier: "^3.3.3",
     prompts: "^2.4.2",
     "react-refresh": "^0.14.2",
@@ -756,6 +794,9 @@ cli.command("list-deployed").description(
 cli.command("deploy-email-config").description("Deploy a widget's email configuration to AWS S3").option("--profile <profile>", "AWS profile").option("--ci", "CI environment", false).option("--bucket <bucket>", "AWS bucket for email configs").action(async (options) => {
   await deployEmailConfig(options);
 });
+cli.command("validate").description("Validate the current Tamaro configuration to avoid common errors").action(async () => {
+  await validate();
+});
 (async () => {
   try {
     logTitle(`${package_default.name} ${package_default.version}

package/dist/webpack.config.js

@@ -83,8 +83,10 @@ var getWebpackConfig = (env) => {
   logDataTable(envVars.raw);
   const getCssLoaders = ({
     styleLoader = true,
+    sassLoader = true,
     ...cssOptions
   }) => {
+    const importLoaders = sassLoader ? 3 : 1;
     return removeEmpty([
       styleLoader ? ifMin({ loader: MiniCssExtractPlugin.loader }) : void 0,
       styleLoader ? ifNotMin({
@@ -99,7 +101,7 @@ var getWebpackConfig = (env) => {
         loader: require2.resolve("css-loader"),
         options: {
           sourceMap: ifNotMin(),
-          importLoaders: 3,
+          importLoaders,
           ...cssOptions
         }
       },
@@ -108,26 +110,28 @@ var getWebpackConfig = (env) => {
         options: {
           postcssOptions: {
             plugins: removeEmpty([
+              !sassLoader ? require2.resolve("postcss-import") : void 0,
+              !sassLoader ? require2.resolve("postcss-nested") : void 0,
               useTailwind ? [
                 require2.resolve("tailwindcss", {
                   paths: [paths.appNodeModules]
                 }),
                 paths.appTailwindConfig
               ] : void 0,
-              require2.resolve("postcss-custom-properties"),
+              // require.resolve('postcss-custom-properties'),
               require2.resolve("autoprefixer")
             ])
           }
         }
       },
-      {
+      sassLoader ? {
         loader: require2.resolve("resolve-url-loader"),
         options: { sourceMap: ifNotMin() }
-      },
-      {
+      } : void 0,
+      sassLoader ? {
         loader: require2.resolve("sass-loader"),
         options: { api: "modern-compiler", sourceMap: true }
-      }
+      } : void 0
     ]);
   };
   const config = {
@@ -206,7 +210,12 @@ var getWebpackConfig = (env) => {
                       allowDeclareFields: true
                     }
                   ],
-                  require2.resolve("@babel/preset-react")
+                  [
+                    require2.resolve("@babel/preset-react"),
+                    {
+                      runtime: "automatic"
+                    }
+                  ]
                 ],
                 plugins: removeEmpty([
                   [
@@ -238,20 +247,42 @@ var getWebpackConfig = (env) => {
             {
               test: /\.(js|mjs)$/
             },
-            // Styles (extracted)
+            // SCSS Styles (extracted)
+            {
+              test: /\.scss$/,
+              resourceQuery: { not: [/inline/] },
+              use: getCssLoaders({
+                styleLoader: true,
+                sassLoader: true
+              })
+            },
+            // CSS Styles (extracted)
             {
-              test: /\.s?css$/,
+              test: /\.css$/,
               resourceQuery: { not: [/inline/] },
               use: getCssLoaders({
-                styleLoader: true
+                styleLoader: true,
+                sassLoader: false
+              })
+            },
+            // SCSS Styles (as string)
+            {
+              test: /\.scss$/,
+              resourceQuery: /inline/,
+              use: getCssLoaders({
+                styleLoader: false,
+                sassLoader: true,
+                exportType: "string",
+                sourceMap: false
               })
             },
-            // Styles (as string)
+            // CSS Styles (as string)
             {
-              test: /\.s?css$/,
+              test: /\.css$/,
               resourceQuery: /inline/,
               use: getCssLoaders({
                 styleLoader: false,
+                sassLoader: false,
                 exportType: "string",
                 sourceMap: false
               })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raisenow/tamaro-cli",
-  "version": "1.1.8",
+  "version": "1.2.0",
   "author": {
     "name": "RaiseNow",
     "email": "development@raisenow.com"
@@ -73,6 +73,8 @@
     "file-loader": "^6.2.0",
     "fork-ts-checker-webpack-plugin": "^9.0.2",
     "glob": "^11.0.0",
+    "handlebars": "^4.7.8",
+    "handlebars-helpers": "^0.10.0",
     "html-loader": "^5.1.0",
     "html-webpack-plugin": "^5.6.3",
     "json-loader": "^0.5.7",
@@ -82,7 +84,9 @@
     "portfinder": "^1.0.32",
     "postcss": "^8.4.49",
     "postcss-custom-properties": "^14.0.4",
+    "postcss-import": "^16.1.1",
     "postcss-loader": "^8.1.1",
+    "postcss-nested": "^7.0.2",
     "prettier": "^3.3.3",
     "prompts": "^2.4.2",
     "react-refresh": "^0.14.2",

package/src/cli.ts

@@ -1,178 +0,0 @@
-#!/usr/bin/env node
-
-import {createCommand} from 'commander'
-import {build, type BuildOptions} from 'commands/build'
-import {deploy, type DeployOptions} from 'commands/deploy'
-import {
-  deployEmailConfig,
-  type DeployEmailConfigOptions,
-} from 'commands/deploy-email-config'
-import {dev, type DevOptions} from 'commands/dev'
-import {listDeployed, type ListDeployedOptions} from 'commands/list-deployed'
-import {serve, type ServeOptions} from 'commands/serve'
-import {halt} from 'lib/command'
-import {DEFAULT_PORT, DEFAULT_TAG} from 'lib/constants'
-import {logError, logTitle} from 'lib/logging'
-import pkg from '../package.json'
-
-///////////////////////////////////////////////////////////////////////////////
-
-/**
- * Makes the script crash on unhandled rejections instead of silently
- * ignoring them. In the future, promise rejections that are not handled will
- * terminate the Node.js process with a non-zero exit code.
- */
-process.on('unhandledRejection', (error) => {
-  throw error
-})
-
-// Exit on ctrl+c
-process.on('SIGINT', () => {
-  halt()
-})
-
-///////////////////////////////////////////////////////////////////////////////
-
-const cli = createCommand().name(pkg.name).version(pkg.version, '-v, --version')
-
-///////////////////////////////////////////////////////////////////////////////
-
-cli
-  .command('dev')
-  .description(
-    'Run the local development server for Tamaro Core or a particular customer configuration',
-  )
-  .option(
-    '--local-core',
-    'Load Tamaro Core from localhost:1234 instead of the CDN',
-    false,
-  )
-  .option(
-    '--https',
-    'Let local web server serve Tamaro with SSL encryption',
-    false,
-  )
-  .option('--port <port>', 'Web server port', `${DEFAULT_PORT}`)
-  .option('--env <env>', 'Environment (dev, stage, prod)')
-  .option('--nolint', 'Disable ESLint', false)
-  .action(async (options: DevOptions) => {
-    await dev(options)
-  })
-
-cli
-  .command('build')
-  .description(
-    'Build an optimised (minified) bundle of Tamaro Core or a customer configuration',
-  )
-  .option(
-    '--local-core',
-    'Load Tamaro Core from localhost:1234 instead of the CDN',
-    false,
-  )
-  .option('--analyze', 'Generate bundle statistics to "reports" folder', false)
-  .option('--serve', 'Run the generated bundle with a local web server', false)
-  .option(
-    '--https',
-    'Let local web server serve Tamaro with SSL encryption',
-    false,
-  )
-  .option('--port <port>', 'Web server port', `${DEFAULT_PORT}`)
-  .option('--env <env>', 'Environment (dev, stage, prod)')
-  .option('--profile <profile>', 'AWS profile')
-  .option('--ci', 'CI environment', false)
-  .option(
-    '--deploy',
-    'Deploy Tamaro Core or a customer configuration bundle to AWS S3',
-    false,
-  )
-  .option(
-    '--tag <tag>',
-    'Tag which should be used for the deployment of the bundle',
-    DEFAULT_TAG,
-  )
-  .option('--nolint', 'Disable ESLint', false)
-  .action(async (options: BuildOptions & ServeOptions & DeployOptions) => {
-    await build(options)
-
-    if (options.serve) {
-      await serve(options)
-    }
-
-    if (options.deploy) {
-      await deploy(options)
-    }
-  })
-
-cli
-  .command('serve')
-  .description('Run a local web server for pre-built bundle')
-  .option('--port <port>', 'Web server port', `${DEFAULT_PORT}`)
-  .option(
-    '--https',
-    'Let local web server serve Tamaro with SSL encryption',
-    false,
-  )
-  .action(async (options: ServeOptions) => {
-    await serve(options)
-  })
-
-cli
-  .command('deploy')
-  .description(
-    'Deploy a pre-built Tamaro Core or customer configuration bundle to AWS S3',
-  )
-  .option('--profile <profile>', 'AWS profile')
-  .option('--ci', 'CI environment', false)
-  .option(
-    '--tag <tag>',
-    'Tag which should be used for the deployment of the bundle',
-    DEFAULT_TAG,
-  )
-  .action(async (options: DeployOptions) => {
-    await deploy(options)
-  })
-
-cli
-  .command('list-deployed')
-  .description(
-    'List deployments of Tamaro Core or a particular customer configuration',
-  )
-  .option('--profile <profile>', 'AWS profile')
-  .option('--ci', 'CI environment', false)
-  .option(
-    '--config <config>',
-    'Configuration name (default: current customer configuration)',
-  )
-  .action(async (options: ListDeployedOptions) => {
-    await listDeployed(options)
-  })
-
-cli
-  .command('deploy-email-config')
-  .description("Deploy a widget's email configuration to AWS S3")
-  .option('--profile <profile>', 'AWS profile')
-  .option('--ci', 'CI environment', false)
-  .option('--bucket <bucket>', 'AWS bucket for email configs')
-  .action(async (options: DeployEmailConfigOptions) => {
-    await deployEmailConfig(options)
-  })
-
-///////////////////////////////////////////////////////////////////////////////
-
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
-;(async () => {
-  try {
-    logTitle(`${pkg.name} ${pkg.version}\n`)
-
-    await cli.parseAsync(process.argv)
-  } catch (error: any) {
-    if (error.signal === 'SIGINT' && error.signalDescription) {
-      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-      logError(`\n${error.signalDescription}`)
-    } else {
-      // eslint-disable-next-line no-console
-      console.log('')
-      logError(error.stack)
-    }
-  }
-})()

package/src/commands/build.ts

@@ -1,131 +0,0 @@
-import {type DeployOptions} from 'commands/deploy'
-import {assertProfilesPresent, assertProfileValid, promptProfile} from 'lib/aws'
-import {halt, runCommandSync} from 'lib/command'
-import {CORE_CONFIG_NAME} from 'lib/constants'
-import {applyEnv, assertEnvValid} from 'lib/env'
-import {assertCrtExists} from 'lib/https'
-import {logCommand, logTitle} from 'lib/logging'
-import {notify} from 'lib/notifier'
-import {
-  getIfCoreFns,
-  getPaths,
-  getWidgetUuid,
-  resolveBin,
-  resolveOwn,
-} from 'lib/resolve'
-
-///////////////////////////////////////////////////////////////////////////////
-
-export type BuildOptions = {
-  localCore: boolean
-  analyze: boolean
-  https: boolean
-  serve: boolean
-  deploy: boolean
-  env?: string
-  nolint: boolean
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-export const build = async (
-  options: BuildOptions & DeployOptions,
-): Promise<void> => {
-  const {env} = options
-
-  applyEnv(env)
-
-  if (options.deploy && !options.profile && !options.ci) {
-    assertProfilesPresent()
-    options.profile = await promptProfile()
-  }
-
-  assertOptionsValid(options)
-
-  const flags = prepareFlags(options)
-  const {ifCore} = getIfCoreFns()
-  const paths = getPaths(ifCore)
-  const configName = ifCore(CORE_CONFIG_NAME, getWidgetUuid())
-  const title = ifCore(
-    'Building optimised (minified) bundle of Tamaro Core …',
-    `Building optimised (minified) bundle of "${configName}" customer configuration …`,
-  )
-
-  const wpBin = resolveBin('webpack')
-  const wpConfig = resolveOwn('dist/webpack.config.js')
-  const cmd = `
-    ${wpBin}
-      --config ${wpConfig}
-      --env min
-      ${flags}
-  `
-
-  logTitle(title)
-  logCommand(cmd)
-  runCommandSync(cmd, {stdio: 'inherit'})
-
-  /////////////////////////////////////////////////////////////////////////////
-
-  logTitle(`\nBundle for "${configName}" customer configuration is done.`)
-  // eslint-disable-next-line no-console
-  console.log(`Path: ${paths.appDist}\n`)
-
-  /////////////////////////////////////////////////////////////////////////////
-
-  process.on('exit', () => {
-    notify({
-      title: 'build',
-      message: `Bundle for "${configName}" customer configuration is done.`,
-    })
-  })
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const assertOptionsValid = (options: BuildOptions & DeployOptions) => {
-  const {localCore, https, deploy, env, profile} = options
-  const {ifCore} = getIfCoreFns()
-
-  if (ifCore() && localCore) {
-    halt('Flag "--local-core" is redundant if running in Tamaro Core context.')
-  }
-
-  if (localCore && deploy) {
-    halt('Flags "--local-core" and "--deploy" must not be used together.')
-  }
-
-  if (https) {
-    assertCrtExists()
-  }
-
-  if (profile) {
-    assertProfileValid(profile)
-  }
-
-  assertEnvValid(env)
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const prepareFlags = (options: BuildOptions) => {
-  const flags: string[] = []
-  const {localCore, analyze, https, nolint} = options
-
-  if (localCore) {
-    flags.push('--env localCore')
-  }
-
-  if (analyze) {
-    flags.push('--env analyze')
-  }
-
-  if (https) {
-    flags.push('--env https')
-  }
-
-  if (nolint) {
-    flags.push('--env nolint')
-  }
-
-  return flags.join(' ')
-}