@raisenow/tamaro-cli 1.0.8 → 1.0.11

package/src/lib/env.ts

@@ -0,0 +1,102 @@
+import {createRequire} from 'module'
+import type {IfUtilsFn} from 'webpack-config-utils'
+import {expand as dotenvExpand} from 'dotenv-expand'
+import {config as dotenvConfig} from 'dotenv'
+import {getWidgetUuid, resolveApp} from 'lib/resolve'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type EnvVars = {
+  [key: string]: string | undefined
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const require = createRequire(import.meta.url)
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const getEnvVars = (
+  filePath: string,
+  ifMin: IfUtilsFn,
+  ifCore: IfUtilsFn,
+  ifLocalCore: IfUtilsFn,
+) => {
+  dotenvExpand(dotenvConfig({path: filePath}))
+
+  process.env.NODE_ENV ??= ifMin('production', 'development')
+  process.env.BABEL_ENV ??= ifMin('production', 'development')
+  process.env.EXPOSE_VAR ??= ifCore('rnw.tamaroCore', 'rnw.tamaro')
+  process.env.ELEMENT_ATTRIBUTE_DATA_WIDGET ??= ifCore(
+    'rnw-tamaro-core',
+    'rnw-tamaro',
+  )
+  process.env.WEBPACK_UNIQUE_NAME ??= ifCore('RnwTamaroCore', 'RnwTamaro')
+
+  // HMR doesn't work in ie11, it breaks everything.
+  // If you want to run dev-server and test in ie11, set HMR_ENABLED to 'false'
+  process.env.HMR_ENABLED ??= ifMin('false', 'true')
+
+  if (ifCore()) {
+    process.env.PRODUCT_NAME = 'tamaro'
+
+    const corePkgPath = resolveApp('package.json')
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const {version} = require(corePkgPath)
+
+    process.env.PRODUCT_VERSION = version
+  }
+
+  if (!ifCore()) {
+    process.env.WIDGET_UUID = getWidgetUuid()
+
+    if (ifLocalCore()) {
+      process.env.CORE_URL = `http://0.0.0.0:1234/index.js`
+    } else {
+      let version = process.env.CORE_VERSION
+      version = version ? `@${version}` : ''
+
+      process.env.CORE_URL ??= `https://cdn.jsdelivr.net/npm/@raisenow/tamaro-core${version}/dist/index.js`
+    }
+  }
+
+  // var names which will be exposed along with "PUBLIC_*" var names
+  const varNames = [
+    // common
+    'NODE_ENV',
+    'BABEL_ENV',
+    'EXPOSE_VAR',
+    'ELEMENT_ATTRIBUTE_DATA_WIDGET',
+    'WEBPACK_UNIQUE_NAME',
+
+    // core
+    'PRODUCT_NAME',
+    'PRODUCT_VERSION',
+
+    // config
+    'WIDGET_UUID',
+    'CORE_URL',
+    'CORE_VERSION', // must be explicitly specified in each config
+    'IS_CREDIT_CARD_IFRAME',
+  ]
+
+  // Collect all vars which names start from "PUBLIC_" or present in "varNames" array
+  const raw = Object.keys(process.env)
+    .filter((key) => /^PUBLIC_/.test(key) || varNames.includes(key))
+    .reduce<EnvVars>((env, key) => {
+      env[key] = process.env[key]
+
+      return env
+    }, {})
+
+  // Stringify all values so we can feed into webpack DefinePlugin
+  const stringified = {
+    'process.env': Object.keys(raw).reduce<EnvVars>((env, key) => {
+      env[key] = JSON.stringify(raw[key])
+
+      return env
+    }, {}),
+  }
+
+  return {raw, stringified}
+}

package/src/lib/logging.ts

@@ -0,0 +1,32 @@
+import chalk from 'chalk'
+import stripIndent from 'strip-indent'
+import columnify from 'columnify'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logTitle = (title: string) => {
+  console.log(`${chalk.bold(title)}`)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logError = (message?: string) => {
+  if (message) {
+    console.log(chalk.red(message))
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logCommand = (cmd: string): void => {
+  console.log(`\n${chalk.dim(stripIndent(cmd).trim())}\n`)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logDataTable = (data: {
+  [key: string]: string | undefined
+}): void => {
+  console.log(columnify(data, {showHeaders: false}))
+  console.log('')
+}

package/src/lib/notifier.ts

@@ -0,0 +1,22 @@
+import notifier from 'node-notifier'
+import stripIndent from 'strip-indent'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type NotifyArgs = {
+  title: string
+  message: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const notify = (args: NotifyArgs) => {
+  const {title, message = ''} = args
+
+  notifier.notify({
+    title,
+    message: stripIndent(message).trim(),
+    contentImage: 'https://assets.raisenow.io/favicon.png',
+    sound: 'Funk',
+  })
+}

package/src/lib/resolve.ts

@@ -0,0 +1,144 @@
+import {createRequire} from 'module'
+import {basename, dirname, join, relative, resolve} from 'path'
+import {existsSync, realpathSync} from 'fs'
+import {getIfUtils, IfUtils, IfUtilsFn} from 'webpack-config-utils'
+import {logError} from 'lib/logging'
+import stripIndent from 'strip-indent'
+import chalk from 'chalk'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type ResolveFn = (relativePath: string) => string
+
+///////////////////////////////////////////////////////////////////////////////
+
+const require = createRequire(import.meta.url)
+export const moduleFileExtensions = ['ts', 'tsx', 'js', 'jsx']
+export const extensions = moduleFileExtensions.map((v) => `.${v}`)
+
+///////////////////////////////////////////////////////////////////////////////
+
+const TAMARO_CORE_PACKAGE_NAMES = ['@raisenow/tamaro-core']
+const TAMARO_CONFIGURATIONS_PACKAGE_NAMES = ['@raisenow/tamaro-configurations']
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const resolveApp: ResolveFn = (relativePath) =>
+  resolve(realpathSync(process.cwd()), relativePath)
+
+///////////////////////////////////////////////////////////////////////////////
+
+// __dirname is "dist" in runtime
+export const resolveOwn: ResolveFn = (relativePath) =>
+  resolve(__dirname, '..', relativePath)
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const resolveModule = (resolveFn: ResolveFn, filePath: string) => {
+  const extension = moduleFileExtensions.find((extension) =>
+    existsSync(resolveFn(`${filePath}.${extension}`)),
+  )
+
+  if (extension) {
+    return resolveFn(`${filePath}.${extension}`)
+  }
+
+  return resolveFn(`${filePath}.js`)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const resolveBin = (name: string) => {
+  const pkgPath = require.resolve(`${name}/package.json`)
+  const {bin} = require(pkgPath)
+  const dir = dirname(pkgPath)
+  const binPath = typeof bin === 'object' ? bin[name] : bin
+
+  return join(dir, binPath)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const getWidgetUuid = () => basename(resolveApp('.'))
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const getPaths = (ifCore: IfUtilsFn) => {
+  return ifCore(
+    {
+      app: resolveApp('.'),
+      appEntry: resolveModule(resolveApp, 'src/index'),
+      appDist: resolveApp('dist'),
+      appNodeModules: resolveApp('node_modules'),
+      appTsConfig: resolveApp('tsconfig.json'),
+      appHtml: resolveApp('src/*.html'),
+      appEnv: resolveApp('.env'),
+      appTailwindConfig: resolveApp('tailwind.config.js'),
+    },
+    {
+      app: resolveApp('.'),
+      appEntry: resolveModule(resolveApp, 'widget'),
+      appDist: resolveApp(`../../dist/${getWidgetUuid()}`),
+      appNodeModules: resolveApp('../../node_modules'),
+      appTsConfig: resolveApp('tsconfig.json'),
+      appHtml: resolveApp('*.html'),
+      appEnv: resolveApp('.env'),
+      appTailwindConfig: undefined,
+    },
+  )
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+type Paths = {
+  [key: string]: string | undefined
+}
+
+export const getRelativePaths = (paths: Paths): Paths => {
+  const relativePaths: Paths = {}
+
+  for (const [type, absPath] of Object.entries(paths)) {
+    if (absPath) {
+      relativePaths[type] = relative('./', absPath) || '.'
+    }
+  }
+
+  return relativePaths
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const getIfCoreFns = (): IfUtils => {
+  const corePkgPath = resolveApp('package.json')
+  const configsPkgPath = resolveApp('../../package.json')
+
+  if (existsSync(corePkgPath)) {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const {name} = require(corePkgPath)
+
+    if (TAMARO_CORE_PACKAGE_NAMES.includes(name)) {
+      return getIfUtils({core: true}, ['core'])
+    }
+  }
+
+  if (existsSync(configsPkgPath)) {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const {name} = require(configsPkgPath)
+
+    if (TAMARO_CONFIGURATIONS_PACKAGE_NAMES.includes(name)) {
+      return getIfUtils({core: false}, ['core'])
+    }
+  }
+
+  logError(
+    stripIndent(`\
+      You must run "npx @raisenow/tamaro-cli" commands from:
+      1. Root of "${chalk.bold(TAMARO_CORE_PACKAGE_NAMES[0])}" package folder.
+      2. Root of particular customer configuration folder of "${chalk.bold(
+        TAMARO_CONFIGURATIONS_PACKAGE_NAMES[0],
+      )}" package.
+      You are currently in "${chalk.bold(realpathSync(process.cwd()))}".
+    `),
+  )
+  process.exit(1)
+}

package/src/webpack.config.ts

@@ -1,14 +1,10 @@
+import {createRequire} from 'module'
 import {basename, dirname} from 'path'
+import {existsSync} from 'fs'
 import glob from 'glob'
 import {getIfUtils, removeEmpty} from 'webpack-config-utils'
-import webpack, {
-  Configuration,
-  DefinePlugin,
-  IgnorePlugin,
-  ProgressPlugin,
-  RuleSetUseItem,
-} from 'webpack'
-import {getPortPromise} from 'portfinder'
+import webpack from 'webpack'
+import type {Configuration, RuleSetUseItem} from 'webpack'
 import {TsconfigPathsPlugin} from 'tsconfig-paths-webpack-plugin'
 import {CleanWebpackPlugin} from 'clean-webpack-plugin'
 import HtmlWebpackPlugin from 'html-webpack-plugin'
@@ -21,20 +17,21 @@ import {} from 'webpack-dev-server'
 import ESLintPlugin from 'eslint-webpack-plugin'
 import CopyPlugin from 'copy-webpack-plugin'
 import StatoscopeWebpackPlugin from '@statoscope/webpack-plugin'
-import InterpolateHtmlPlugin from 'lib/InterpolateHtmlPlugin'
+import {InterpolateHtmlPlugin} from 'lib/InterpolateHtmlPlugin'
 import {
   extensions,
-  getEnvVars,
   getIfCoreFns,
   getPaths,
-  logDataTable,
+  getRelativePaths,
   moduleFileExtensions,
   resolveApp,
-  resolveOwn,
-} from 'lib/helpers'
+} from 'lib/resolve'
+import {getEnvVars} from 'lib/env'
+import {logDataTable, logTitle} from 'lib/logging'
 
 ///////////////////////////////////////////////////////////////////////////////
 
+const require = createRequire(import.meta.url)
 const imageInlineSizeLimit = 0
 // const imageInlineSizeLimit = 8 * 1024 // 8kb
 
@@ -49,10 +46,14 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
   const appHtmlFiles = glob.sync(paths.appHtml)
   const envVars = getEnvVars(paths.appEnv, ifMin, ifCore, ifLocalCore)
   const {ifHmr} = getIfUtils({hmr: process.env.HMR_ENABLED === 'true'}, ['hmr'])
-  const port = await getPortPromise({port: 1234})
+  const useTailwind =
+    ifCore() && paths.appTailwindConfig && existsSync(paths.appTailwindConfig)
 
-  logDataTable(paths, 'Paths')
-  logDataTable(envVars.raw, 'Environment variables')
+  logTitle('Paths:')
+  logDataTable(getRelativePaths(paths))
+
+  logTitle('Environment variables:')
+  logDataTable(envVars.raw)
 
   const getCssLoaders = (cssOptions: any = {}): RuleSetUseItem[] => {
     return removeEmpty([
@@ -78,7 +79,15 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
         options: {
           postcssOptions: {
             plugins: removeEmpty([
-              ifCore([require.resolve('tailwindcss'), paths.appTailwindConfig]),
+              useTailwind
+                ? [
+                    // eslint-disable-next-line node/no-missing-require
+                    require.resolve('tailwindcss', {
+                      paths: [paths.appNodeModules],
+                    }),
+                    paths.appTailwindConfig,
+                  ]
+                : undefined,
               require.resolve('postcss-custom-properties'),
               require.resolve('autoprefixer'),
             ]),
@@ -109,7 +118,7 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
         }),
       ],
     },
-    entry: [resolveOwn('src/lib/polyfills.js'), paths.appEntry],
+    entry: paths.appEntry,
     output: {
       publicPath: 'auto',
       path: ifMin(paths.appDist, undefined),
@@ -309,7 +318,6 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
     devtool: ifMin(false, 'cheap-module-source-map'),
 
     devServer: {
-      port,
       static: false,
       historyApiFallback: {
         disableDotRule: true,
@@ -335,7 +343,7 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
     },
 
     plugins: removeEmpty([
-      new ProgressPlugin(),
+      new webpack.ProgressPlugin(),
       new ESLintPlugin({
         extensions: moduleFileExtensions,
         eslintPath: require.resolve('eslint'),
@@ -372,7 +380,7 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
       ),
 
       new InterpolateHtmlPlugin(envVars.raw),
-      new DefinePlugin(envVars.stringified),
+      new webpack.DefinePlugin(envVars.stringified),
 
       new ForkTsCheckerWebpackPlugin({
         typescript: {
@@ -403,7 +411,7 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
         }),
       ),
 
-      new IgnorePlugin({
+      new webpack.IgnorePlugin({
         resourceRegExp: /^\.\/locale$/,
         contextRegExp: /moment$/,
       }),
@@ -412,12 +420,7 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
 
       ifMin() && ifCore()
         ? new CopyPlugin({
-            patterns: [
-              {
-                from: 'docs',
-                to: 'docs',
-              },
-            ],
+            patterns: ['README.md', 'readme.html'],
           })
         : undefined,
 
@@ -431,6 +434,11 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
           })
         : undefined,
     ]),
+
+    infrastructureLogging: {
+      stream: process.stdout,
+      appendOnly: false,
+    },
   }
 
   // console.log(util.inspect(config, {showHidden: false, depth: null}))

package/tsconfig.json

@@ -5,7 +5,7 @@
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "esnext",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "module": "esnext",                       /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     // "lib": [],                             /* Specify library files to be included in the compilation. */
     "allowJs": true,                          /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */

package/readme.md

@@ -1,201 +0,0 @@
-# Getting started
-
-It's a command-line interface for all operations with Tamaro customer configurations and *Tamaro Core*.
-
-You don't need to install it manually. The recommended way is to run it using `npx` command, which must be available along with `node` and `npm` commands.
-
-# Usage
-
-To see an overview of all possible commands just run the following command without any arguments:
-
-```bash
-npx -y @raisenow/tamaro-cli
-```
-
-To see the info about some particular command (for example `dev` command), prepend `help` before the command name:
-
-```bash
-npx -y @raisenow/tamaro-cli help dev
-```
-
-Substitute `dev` with the command you want to get info about.
-
-# Commands
-
-Available commands:
-- [dev](#dev)
-- [build](#build)
-- [deploy](#deploy)
-- [serve](#serve)
-
-## dev
-
-Runs development web-server for *Tamaro Core* or particular customer configuration.
-
-Options:
-- `--local-core` – Load *Tamaro Core* from localhost instead of CDN
-
-### Run development web-server using Tamaro Core from CDN
-
-Run development web-server for `example-02-typical-customisations` customer configuration.
-
-After running this command, development web-server should be running on http://localhost:1234/ (port may differ).
-
-```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli dev
-```
-
-### Run development web-server using locally running Tamaro Core
-
-1.  Run development web-server for *Tamaro Core* in the first terminal tab.
-    
-    After running this command, development web-server should be running on http://localhost:1234/ (port may differ).
-
-    ```bash
-    cd /path/to/tamaro-core
-    npx -y @raisenow/tamaro-cli dev
-    ```
-
-2.  Run development web-server for `example-02-typical-customisations` customer configuration in the second terminal tab.
-    
-    After running this command, development web-server should be running on http://localhost:1235/ (port may differ).
-
-    ```bash
-    cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-    npx -y @raisenow/tamaro-cli dev --local-core
-    ```
-
-## build
-
-Build optimised (minified) bundle of *Tamaro Core* or customer configuration for production.
-
-Options:
-- `--local-core` – Load *Tamaro Core* from localhost instead of CDN
-- `--analyze` – Generate bundle statistics to `reports` folder
-- `--deploy` – Deploy *Tamaro Core* or customer configuration bundle to AWS
-- `--serve` – Run web-server for the bundle
-- `--tag <tag>` – Tag which will be used for deployment of the bundle
-
-Before trying to deploy a bundle, make sure you have proper AWS credentials in your environment, otherwise deployment will fail.
-More info about configuring AWS credentials and profiles is in the [wiki page](https://raisenow.atlassian.net/wiki/spaces/DEVOPS/pages/3201731220).
-
-### Build and deploy customer configuration
-
-Build and deploy optimised (minified) bundle of `example-02-typical-customisations` customer configuration.
-
-```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli build --deploy
-```
-
-As a result bundle should be deployed to: https://tamaro.raisenow.com/example-02-typical-customisations/latest/index.html
-
-### Build and deploy customer configuration with a specific tag
-
-Build and deploy optimised (minified) bundle of `example-02-typical-customisations` customer configuration with `WEB-123` tag.
-
-```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli build --deploy --tag WEB-123
-```
-
-As a result bundle should be deployed to: https://tamaro.raisenow.com/example-02-typical-customisations/WEB-123/index.html
-
-### Build and serve customer configuration
-
-Build and serve optimised (minified) bundle of `example-02-typical-customisations` customer configuration.
-
-After running this command, web-server should be running on http://localhost:1234/ (port may differ).
-
-```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli build --serve
-```
-
-
-## deploy
-
-Deploy prebuilt Tamaro Core or customer configuration bundle to AWS.
-
-Options:
-- `--tag <tag>` – Tag which will be used for deployment of the bundle
-
-Make sure you have built the bundle before deploying it with this command, otherwise you may mistakenly deploy the bundle from previous build.
-
-Example:
-
-1. Build optimised (minified) bundle of `example-02-typical-customisations` customer configuration.
-
-    ```bash
-    cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-    npx -y @raisenow/tamaro-cli build
-    ```
-
-2.  Deploy it:
-
-    ```bash
-    npx -y @raisenow/tamaro-cli deploy
-    ```
-
-3.  Optionally deploy it with `WEB-123` tag:
-
-    ```bash
-    npx -y @raisenow/tamaro-cli deploy --tag WEB-123
-    ```
-
-## serve
-
-Run web-server for prebuilt bundle.
-
-Example:
-
-1.  Build optimised (minified) bundle of `example-02-typical-customisations` customer configuration.
-
-    ```bash
-    cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-    npx -y @raisenow/tamaro-cli build
-    ```
-
-2.  Serve it.
-
-    After running this command, web-server should be running on http://localhost:1234/ (port may differ).
-
-    ```bash
-    npx -y @raisenow/tamaro-cli serve
-    ```
-
-
-# Development
-
-Make sure you have installed and activated proper `node` and `npm` versions.
-
-- `node: ">= 16"`
-- `npm: ">= 8"`
-
-Clone the repo and install its dependencies:
-
-```bash
-git clone git@bitbucket.org:raisenow/tamaro-cli.git
-cd tamaro-cli
-npm ci
-```
-
-Link package source to be able to run its local version:
-
-```bash
-npm link .
-```
-
-Run the `dev` script to watch source files and automatically rebuild on changes.
-It must be running during *Tamaro CLI* development process. 
-
-```bash
-npm run dev
-```
-
-To use local linked version of *Tamaro CLI*, use it without `@raisenow/` scope, `-y` flag is also not needed:
-
-```bash
-npx tamaro-cli dev
-```