@raisenow/tamaro-cli 1.3.0 → 1.4.0

package/README.md

@@ -112,6 +112,7 @@ Build an optimised (minified) bundle of _Tamaro Core_ or a customer configuratio
 - `--env <env>` – Environment (dev, stage, prod)
 - `--deploy` – Deploy _Tamaro Core_ or a customer configuration bundle to AWS S3
 - `--tag <tag>` – Tag which should be used for the deployment of the bundle (default: "latest")
+- `--dryrun` – Displays the operations that would be performed using the specified command without actually running them.
 
 ### Build and deploy a customer configuration
 

package/dist/cli.js

@@ -353,16 +353,21 @@ var deploy = async (options) => {
   await validate();
   awsAuthenticate(options);
   const flags = prepareFlags(options);
-  const { tag } = options;
+  const { tag, dryrun } = options;
+  const dryRunFlag = dryrun ? `--dryrun` : "";
   const configName = ifCore(CORE_CONFIG_NAME, getWidgetUuid());
   const deployUrl = `s3://${AWS_S3_BUCKET_TAMARO}/${configName}/${tag}`;
   const entryFilename = ifCore("index.js", "widget.js");
+  if (dryRunFlag) {
+    logTitle("\u{1F9EA} DRY RUN MODE - No actual changes will be made \u{1F9EA}");
+  }
   const cmdSyncAll = `
     aws s3 sync ${paths.appDist} ${deployUrl}
       --acl public-read
       --exclude ${paths.appDist}/${entryFilename}
       --cache-control max-age=31536000
       ${flags}
+      ${dryRunFlag}
   `;
   logTitle("Deploying to AWS S3 \u2026");
   logCommand(cmdSyncAll);
@@ -376,6 +381,7 @@ var deploy = async (options) => {
       --acl public-read
       --cache-control max-age=64800
       ${flags}
+      ${dryRunFlag}
   `;
   logCommand(cmdCpEntry);
   try {
@@ -383,18 +389,20 @@ var deploy = async (options) => {
   } catch (error) {
     halt(error.stderr);
   }
-  const cmdInvalidateCache = `
+  if (!dryRunFlag) {
+    const cmdInvalidateCache = `
     aws cloudfront create-invalidation
       --distribution-id ${AWS_CLOUDFRONT_DISTRIBUTION_ID}
       --paths /${configName}/${tag}/*
       ${flags}
   `;
-  logTitle("\nInvalidating edge cache \u2026");
-  logCommand(cmdInvalidateCache);
-  try {
-    runCommandSync(cmdInvalidateCache);
-  } catch (error) {
-    halt(error.stderr);
+    logTitle("\nInvalidating edge cache \u2026");
+    logCommand(cmdInvalidateCache);
+    try {
+      runCommandSync(cmdInvalidateCache);
+    } catch (error) {
+      halt(error.stderr);
+    }
   }
   const demoPage = `https://${AWS_S3_BUCKET_TAMARO}/${configName}/${tag}/index.html`;
   const entryPoint = `https://${AWS_S3_BUCKET_TAMARO}/${configName}/${tag}/${entryFilename}`;
@@ -461,13 +469,18 @@ var deployEmailConfig = async (options) => {
   await validate();
   awsAuthenticate(options);
   const flags = prepareFlags(options);
+  const dryRunFlag = options.dryrun ? `--dryrun` : "";
   const configName = getWidgetUuid();
   const deployUrl = `s3://${options.bucket}/${configName}`;
+  if (dryRunFlag) {
+    logTitle("\u{1F9EA} DRY RUN MODE - No actual changes will be made \u{1F9EA}");
+  }
   const cmd = `
     aws s3 sync ${emailConfigPath} ${deployUrl}
       --delete
       --exact-timestamps
       ${flags}
+      ${dryRunFlag}
   `;
   logTitle(
     `Deploying email configuration for "${configName}" customer configuration to AWS S3 \u2026`
@@ -701,7 +714,7 @@ var prepareFlags4 = async (options) => {
 // package.json
 var package_default = {
   name: "@raisenow/tamaro-cli",
-  version: "1.3.0",
+  version: "1.4.0",
   author: {
     name: "RaiseNow",
     email: "development@raisenow.com"
@@ -875,6 +888,10 @@ cli.command("deploy").description(
   "--tag <tag>",
   "Tag which should be used for the deployment of the bundle",
   DEFAULT_TAG
+).option(
+  "--dryrun",
+  "Displays the operations that would be performed without actually running them",
+  false
 ).action(async (options) => {
   await deploy(options);
 });
@@ -886,7 +903,11 @@ cli.command("list-deployed").description(
 ).action(async (options) => {
   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) => {
+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").option(
+  "--dryrun",
+  "Displays the operations that would be performed without actually running them",
+  false
+).action(async (options) => {
   await deployEmailConfig(options);
 });
 cli.command("validate").description(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raisenow/tamaro-cli",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "author": {
     "name": "RaiseNow",
     "email": "development@raisenow.com"

package/.history/.eslintignore_20220609190420

@@ -1,4 +0,0 @@
-dist
-node_modules
-tsconfig.eslint.json
-tsconfig.json

package/.history/.eslintignore_20230911190227

@@ -1,6 +0,0 @@
-.history
-.idea
-dist
-node_modules
-tsconfig.eslint.json
-tsconfig.json

package/.history/.eslintignore_20230911211247

@@ -1,7 +0,0 @@
-.history
-.idea
-dist
-node_modules
-pnpm-lock.yaml
-tsconfig.eslint.json
-tsconfig.json

package/.history/.eslintignore_20230911211250

@@ -1,7 +0,0 @@
-.history
-.idea
-dist
-node_modules
-pnpm-lock.yaml
-tsconfig.eslint.json
-tsconfig.json

package/.history/.eslintrc_20230911201601.js

@@ -1,49 +0,0 @@
-module.exports = {
-  root: true,
-  overrides: [
-    {
-      files: ['*.{js,jsx,ts,tsx}'],
-      env: {
-    browser: true,
-    node: true,
-    es2021: true,
-  },
-    },
-  ],
-
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
-    ecmaVersion: 2021,
-    sourceType: 'module',
-    tsconfigRootDir: __dirname,
-    // project: './tsconfig.eslint.json',
-    project: './tsconfig.json',
-    extraFileExtensions: ['.cjs'],
-  },
-  extends: [
-    'eslint:recommended',
-    'plugin:promise/recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:@typescript-eslint/recommended-requiring-type-checking',
-    'prettier',
-  ],
-  plugins: [],
-  rules: {
-    curly: 1,
-    'prefer-const': 2,
-    'require-await': 0,
-    '@typescript-eslint/ban-ts-comment': 0,
-    '@typescript-eslint/no-explicit-any': 0,
-    '@typescript-eslint/no-non-null-assertion': 0,
-    '@typescript-eslint/prefer-optional-chain': 1,
-    '@typescript-eslint/require-await': 0,
-    '@typescript-eslint/no-unsafe-assignment': 0,
-    '@typescript-eslint/no-unsafe-member-access': 0,
-    '@typescript-eslint/no-unsafe-call': 0,
-    '@typescript-eslint/no-unsafe-return': 0,
-    '@typescript-eslint/no-unsafe-argument': 0,
-  },
-}

package/.history/.eslintrc_20230911201643.js

@@ -1,49 +0,0 @@
-module.exports = {
-  root: true,
-  overrides: [
-    {
-      files: ['*.{js,jsx,ts,tsx}'],
-      env: {
-    browser: true,
-    node: true,
-    es2021: true,
-  },
-    },
-  ],
-
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
-    ecmaVersion: 2021,
-    sourceType: 'module',
-    tsconfigRootDir: __dirname,
-    // project: './tsconfig.eslint.json',
-    project: './tsconfig.json',
-    extraFileExtensions: ['.cjs'],
-  },
-  extends: [
-    'eslint:recommended',
-    'plugin:promise/recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:@typescript-eslint/recommended-requiring-type-checking',
-    'prettier',
-  ],
-  plugins: [],
-  rules: {
-    curly: 1,
-    'prefer-const': 2,
-    'require-await': 0,
-    '@typescript-eslint/ban-ts-comment': 0,
-    '@typescript-eslint/no-explicit-any': 0,
-    '@typescript-eslint/no-non-null-assertion': 0,
-    '@typescript-eslint/prefer-optional-chain': 1,
-    '@typescript-eslint/require-await': 0,
-    '@typescript-eslint/no-unsafe-assignment': 0,
-    '@typescript-eslint/no-unsafe-member-access': 0,
-    '@typescript-eslint/no-unsafe-call': 0,
-    '@typescript-eslint/no-unsafe-return': 0,
-    '@typescript-eslint/no-unsafe-argument': 0,
-  },
-}

package/.history/.eslintrc_20230911201735.js

@@ -1,49 +0,0 @@
-module.exports = {
-  root: true,
-  overrides: [
-    {
-      files: ['*.{js,jsx,ts,tsx}'],
-      env: {
-        browser: true,
-        node: true,
-        es2021: true,
-      },
-    },
-  ],
-
-  // parser: '@typescript-eslint/parser',
-  // parserOptions: {
-  //   ecmaFeatures: {
-  //     jsx: true,
-  //   },
-  //   ecmaVersion: 2021,
-  //   sourceType: 'module',
-  //   tsconfigRootDir: __dirname,
-  //   // project: './tsconfig.eslint.json',
-  //   project: './tsconfig.json',
-  //   extraFileExtensions: ['.cjs'],
-  // },
-  // extends: [
-  //   'eslint:recommended',
-  //   'plugin:promise/recommended',
-  //   'plugin:@typescript-eslint/recommended',
-  //   'plugin:@typescript-eslint/recommended-requiring-type-checking',
-  //   'prettier',
-  // ],
-  // plugins: [],
-  // rules: {
-  //   curly: 1,
-  //   'prefer-const': 2,
-  //   'require-await': 0,
-  //   '@typescript-eslint/ban-ts-comment': 0,
-  //   '@typescript-eslint/no-explicit-any': 0,
-  //   '@typescript-eslint/no-non-null-assertion': 0,
-  //   '@typescript-eslint/prefer-optional-chain': 1,
-  //   '@typescript-eslint/require-await': 0,
-  //   '@typescript-eslint/no-unsafe-assignment': 0,
-  //   '@typescript-eslint/no-unsafe-member-access': 0,
-  //   '@typescript-eslint/no-unsafe-call': 0,
-  //   '@typescript-eslint/no-unsafe-return': 0,
-  //   '@typescript-eslint/no-unsafe-argument': 0,
-  // },
-}

package/.history/.eslintrc_20230911201913.js

@@ -1,64 +0,0 @@
-module.exports = {
-  root: true,
-  overrides: [
-    {
-      files: ['*.{js,ts}'],
-      env: {
-        node: true,
-        es2021: true,
-      },
-      settings: {
-        'import/resolver': {
-          typescript: {
-            alwaysTryTypes: true,
-            project: ['./tsconfig.json'],
-          },
-        },
-      },
-      parser: '@typescript-eslint/parser',
-      parserOptions: {
-        ecmaVersion: 2021,
-        sourceType: 'module',
-        tsconfigRootDir: __dirname,
-        project: ['./tsconfig.json'],
-      },
-    },
-
-  ],
-
-
-  // parserOptions: {
-  //   ecmaFeatures: {
-  //     jsx: true,
-  //   },
-  //   ecmaVersion: 2021,
-  //   sourceType: 'module',
-  //   tsconfigRootDir: __dirname,
-  //   // project: './tsconfig.eslint.json',
-  //   project: './tsconfig.json',
-  //   extraFileExtensions: ['.cjs'],
-  // },
-  // extends: [
-  //   'eslint:recommended',
-  //   'plugin:promise/recommended',
-  //   'plugin:@typescript-eslint/recommended',
-  //   'plugin:@typescript-eslint/recommended-requiring-type-checking',
-  //   'prettier',
-  // ],
-  // plugins: [],
-  // rules: {
-  //   curly: 1,
-  //   'prefer-const': 2,
-  //   'require-await': 0,
-  //   '@typescript-eslint/ban-ts-comment': 0,
-  //   '@typescript-eslint/no-explicit-any': 0,
-  //   '@typescript-eslint/no-non-null-assertion': 0,
-  //   '@typescript-eslint/prefer-optional-chain': 1,
-  //   '@typescript-eslint/require-await': 0,
-  //   '@typescript-eslint/no-unsafe-assignment': 0,
-  //   '@typescript-eslint/no-unsafe-member-access': 0,
-  //   '@typescript-eslint/no-unsafe-call': 0,
-  //   '@typescript-eslint/no-unsafe-return': 0,
-  //   '@typescript-eslint/no-unsafe-argument': 0,
-  // },
-}

package/.history/.eslintrc_20230911202002.js

@@ -1,62 +0,0 @@
-module.exports = {
-  root: true,
-  overrides: [
-    {
-      files: ['*.{js,cjs,ts}'],
-      env: {
-        node: true,
-        es2021: true,
-      },
-      settings: {
-        'import/resolver': {
-          typescript: {
-            alwaysTryTypes: true,
-            project: ['./tsconfig.json'],
-          },
-        },
-      },
-      parser: '@typescript-eslint/parser',
-      parserOptions: {
-        ecmaVersion: 2021,
-        sourceType: 'module',
-        tsconfigRootDir: __dirname,
-        project: ['./tsconfig.json'],
-        extraFileExtensions: ['.cjs'],
-      },
-    },
-
-  ],
-
-
-  // parserOptions: {
-  //   ecmaFeatures: {
-  //     jsx: true,
-  //   },
-
-  //   project: './tsconfig.json',
-  //   extraFileExtensions: ['.cjs'],
-  // },
-  // extends: [
-  //   'eslint:recommended',
-  //   'plugin:promise/recommended',
-  //   'plugin:@typescript-eslint/recommended',
-  //   'plugin:@typescript-eslint/recommended-requiring-type-checking',
-  //   'prettier',
-  // ],
-  // plugins: [],
-  // rules: {
-  //   curly: 1,
-  //   'prefer-const': 2,
-  //   'require-await': 0,
-  //   '@typescript-eslint/ban-ts-comment': 0,
-  //   '@typescript-eslint/no-explicit-any': 0,
-  //   '@typescript-eslint/no-non-null-assertion': 0,
-  //   '@typescript-eslint/prefer-optional-chain': 1,
-  //   '@typescript-eslint/require-await': 0,
-  //   '@typescript-eslint/no-unsafe-assignment': 0,
-  //   '@typescript-eslint/no-unsafe-member-access': 0,
-  //   '@typescript-eslint/no-unsafe-call': 0,
-  //   '@typescript-eslint/no-unsafe-return': 0,
-  //   '@typescript-eslint/no-unsafe-argument': 0,
-  // },
-}

package/.history/.eslintrc_20230911202138.js

@@ -1,133 +0,0 @@
-module.exports = {
-  root: true,
-  overrides: [
-    {
-      files: ['*.{js,cjs,ts}'],
-      env: {
-        node: true,
-        es2021: true,
-      },
-      settings: {
-        'import/resolver': {
-          typescript: {
-            alwaysTryTypes: true,
-            project: ['./tsconfig.json'],
-          },
-        },
-      },
-      parser: '@typescript-eslint/parser',
-      parserOptions: {
-        ecmaVersion: 2021,
-        sourceType: 'module',
-        tsconfigRootDir: __dirname,
-        project: ['./tsconfig.json'],
-        extraFileExtensions: ['.cjs'],
-      },
-      extends: [
-        'eslint:recommended',
-        'plugin:@typescript-eslint/recommended-requiring-type-checking',
-        // 'plugin:@typescript-eslint/strict-type-checked',
-        // 'plugin:@typescript-eslint/stylistic-type-checked',
-        'plugin:promise/recommended',
-        'plugin:deprecation/recommended',
-        'plugin:react/recommended',
-        'plugin:react-hooks/recommended',
-        'plugin:import/recommended',
-        'plugin:import/typescript',
-        'prettier',
-      ],
-      plugins: ['unused-imports'],
-      rules: {
-        curly: 1,
-        'prefer-const': 1,
-        'no-console': 1,
-        strict: 1,
-        'no-debugger': 1,
-
-        'no-extra-boolean-cast': 0,
-        '@typescript-eslint/no-explicit-any': 0,
-        '@typescript-eslint/no-non-null-assertion': 0,
-        '@typescript-eslint/no-unsafe-assignment': 0,
-        '@typescript-eslint/no-unsafe-argument': 0,
-        '@typescript-eslint/no-unsafe-member-access': 0,
-        '@typescript-eslint/no-unsafe-return': 0,
-        '@typescript-eslint/no-unsafe-enum-comparison': 0,
-        '@typescript-eslint/no-unsafe-call': 0, // todo: remove this rule later
-        '@typescript-eslint/explicit-function-return-type': 0,
-        '@typescript-eslint/consistent-type-definitions': 0,
-        '@typescript-eslint/no-dynamic-delete': 0,
-
-        '@typescript-eslint/ban-ts-comment': [2, {'ts-expect-error': false}],
-        '@typescript-eslint/no-unused-vars': [1, {varsIgnorePattern: '^_'}],
-        '@typescript-eslint/prefer-optional-chain': 1,
-        '@typescript-eslint/member-delimiter-style': [
-          1,
-          {multiline: {delimiter: 'none'}},
-        ],
-
-        '@typescript-eslint/no-confusing-void-expression': [
-          2,
-          {ignoreArrowShorthand: true},
-        ],
-
-        'import/newline-after-import': 2,
-
-        'unused-imports/no-unused-imports': 1,
-
-        '@typescript-eslint/consistent-type-imports': [
-          2,
-          {
-            prefer: 'type-imports',
-            fixStyle: 'inline-type-imports',
-          },
-        ],
-
-        'sort-imports': [2, {ignoreCase: true, ignoreDeclarationSort: true}],
-        'import/order': [
-          2,
-          {
-            groups: [
-              'builtin',
-              'external',
-              'internal',
-              ['parent', 'sibling', 'index'],
-            ],
-            // Put "react*" on top
-            pathGroups: [
-              {
-                pattern: 'react*',
-                group: 'external',
-                position: 'before',
-              },
-              {
-                pattern: '**/*.json',
-                group: 'unknown',
-                position: 'after',
-              },
-              {
-                pattern: '**/*.yml',
-                group: 'unknown',
-                position: 'after',
-              },
-            ],
-            distinctGroup: false,
-            alphabetize: {
-              order: 'asc',
-              orderImportKind: 'asc',
-              caseInsensitive: true,
-            },
-            'newlines-between': 'never',
-
-            // Since docs for "pathGroupsExcludedImportTypes" option are confusing,
-            // see more info about how to correctly use it here:
-            // https://github.com/import-js/eslint-plugin-import/pull/2156#issuecomment-927559466
-            pathGroupsExcludedImportTypes: [],
-          },
-        ],
-      },
-    },
-    {
-
-    },
-  ],
-}