@getik-public/cli 1.3.0-beta1 → 1.3.0

package/CHANGELOG.md

@@ -1,7 +1,5 @@
-### v1.3.0-beta1
-Added new features:
-- new script: `getik-cli increment-version`(only for mobile for now)
-- extended `getik-cli mobile-build` script to build only angular and zip it for OTA feature.
+### v1.3.0
+Added prebuild checks before any production builds for store
 
 
 ### v1.2.1

package/bin/index.js

@@ -4,14 +4,12 @@ import { program } from 'commander';
 import chalk from 'chalk';
 import figlet from 'figlet';
 
-import { incrementVersion } from '../src/increment-version.js';
 import { mobileBuild } from '../src/mobile-build.js';
 import { uploadToGetikCloud } from '../src/upload-to-getik-cloud.js';
 
 
 console.log(chalk.green(figlet.textSync('Getik CLI', {horizontalLayout: 'full'})));
 
-incrementVersion();
 mobileBuild();
 uploadToGetikCloud();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getik-public/cli",
-  "version": "1.3.0-beta1",
+  "version": "1.3.0",
   "publishConfig": {
     "access": "public"
   },

package/src/mobile-build.js

@@ -19,7 +19,7 @@ async function applyPatchersForExternalNpmPackages() {
   for (const filename of patchesInFolder) {
     if (filename.indexOf(filenameEndsWith) === filename.length - filenameEndsWith.length) {
       let pathToFile = path.join(process.cwd(), patchesFolderName, filename);
-      if (process.platform === "win32") {
+      if (process.platform === 'win32') {
         pathToFile = path.join('file:\\', pathToFile);
       }
       const patcherImport = await import(pathToFile);
@@ -65,7 +65,7 @@ async function applyPatchersForExternalNpmPackages() {
 }
 
 
-function readVersionsFromPackageJson(options) {
+function readVersionsFromPackageJson() {
   console.log('Checking versions in package.json file...');
   const packageJsonBuffer = fs.readFileSync(path.join(process.cwd(), 'package.json'));
   const packageJson = JSON.parse(packageJsonBuffer);
@@ -88,34 +88,15 @@ function readVersionsFromPackageJson(options) {
   const zTransformed = (z < 10) ? `0${z}` : z;
   const versionCode = `${x}${yTransformed}${zTransformed}`;
 
-  const env = (options.environment.charAt(0).toUpperCase() + options.environment.slice(1));
-  const otaVersionPropertyName = `otaVersion${env.split('Debug')[0]}`;
-  const otaVersionMessage = packageJson[otaVersionPropertyName] ? ` , ${otaVersionPropertyName} = ${packageJson[otaVersionPropertyName]}.` : '.';
-
-  console.log(`Extracted versions: versionName = ${versionName}, versionCode = ${versionCode}${otaVersionMessage}`);
+  console.log(`Extracted versions: versionName = \x1b[32m${versionName}\x1b[0m, versionCode = \x1b[32m${versionCode}\x1b[0m.`);
 
   return {
     versionName: versionName,
     versionCode: versionCode,
-    ota: packageJson[otaVersionPropertyName],
   }
 }
 
 
-function makeVersionsFileInTypescript(versions) {
-  const pathToVersionsFile = path.join(process.cwd(), 'src', 'environments', 'versions.ts');
-  if (fs.existsSync(pathToVersionsFile)) {
-    fs.rmSync(pathToVersionsFile);
-  }
-  const versionsFileContent = `export const versions = {
-  ota: ${versions.ota},
-  native: '${versions.versionName}',
-};
-`;
-  fs.writeFileSync(pathToVersionsFile, versionsFileContent);
-}
-
-
 function checkKeystorePropertiesFile() {
   const pathToKeystoreProperties = path.join(process.cwd(), 'android', 'keystore.properties');
 
@@ -203,19 +184,6 @@ function checkPatcherForPackageMatch(patcher) {
 }
 
 
-function createCommandsForOTA(options, versions) {
-  cleanBuildFolder(options);
-  if (!versions.ota) {
-    throw new Error(`You are trying to build app for OTA but OTA version not found. Make sure you have defined properties "otaVersion<ENVIRONMENT>" for every environment in "package.json".`);
-  }
-  const buildAngular = `ng build --configuration=${options.environment}`;
-  const createZip = `zip -q -r ./${buildFolder}/ota/www-${versions.versionName}-${versions.ota}.zip ./www`;
-  const commands = [buildAngular, createZip];
-
-  return commands;
-}
-
-
 function createCommandsForAndroid(options) {
   const isWindows = (process.platform === 'win32');
   const capitalizedEnvironment = (options.environment.charAt(0).toUpperCase() + options.environment.slice(1));
@@ -228,7 +196,7 @@ function createCommandsForAndroid(options) {
 
 function createCommandsForIos(options) {
   const workspace = './App/App.xcworkspace';
-  const debugMode = (options.environment.indexOf("Debug") >= 0);
+  const debugMode = (options.environment.indexOf('Debug') >= 0);
   const config = (debugMode ? 'Debug' : 'Release');
   const environment = (options.environment.split('Debug')[0]);
   const archive = `./build/archive/${environment}.xcarchive`;
@@ -261,7 +229,7 @@ function createCommandsForIos(options) {
 
 
 function cleanBuildFolder(options) {
-  const platformBuildFolder = `${buildFolder}/${options.ota ? 'ota' : options.platform}`;
+  const platformBuildFolder = `${buildFolder}/${options.platform}`;
   if (fs.existsSync(buildFolder)) {
     fs.rmSync(buildFolder, {recursive: true});
   }
@@ -375,6 +343,20 @@ function runCliCommand(command, callback, path) {
 }
 
 
+function runCliCommandSilent(command, callback, path) {
+  callback = callback || function() {};
+  const ls = spawn(command, [], {shell: true, env: { ...process.env, FORCE_COLOR: true }, cwd: path || ''});
+  const output = [];
+  ls.stdout.on('data', (data) => {
+    output.push(data);
+  });
+
+  ls.on('close', (code) => {
+    callback(code, output.toString());
+  });
+}
+
+
 function runCliCommandList(list, path, callback) {
   if (list.length === 0) {
     return;
@@ -389,45 +371,238 @@ function runCliCommandList(list, path, callback) {
 }
 
 
+function applyReleaseBuildChecks(versions, options, callback) {
+  const debugMode = (options.environment.indexOf('Debug') >= 0);
+  if (debugMode) {
+    callback()
+
+    return;
+  }
+
+  console.log('----------------------------------------------------------------------------------------------------------------------');
+  if (options.force) {
+    console.log('\x1b[31mWARNING: All checks before release build are skipped! Never use "--force" when uploading build to store! \x1b[0m');
+    console.log('----------------------------------------------------------------------------------------------------------------------');
+    callback();
+
+    return;
+  }
+
+  console.log('RUNNING CHECKS BEFORE PRODUCTION BUILD...');
+  let checkFailed = false;
+
+  console.log('');
+  checkForUncommitedFiles((checkForUncommitedFilesStatus) => {
+    checkFailed = (checkFailed || checkForUncommitedFilesStatus);
+
+    console.log('');
+    checkRemoteBranch((checkRemoteBranchStatus) => {
+      checkFailed = (checkFailed || checkRemoteBranchStatus);
+
+      console.log('');
+      checkEnvironmentToBranchScheme(versions, options, (checkEnvironmentToBranchSchemeStatus) => {
+        checkFailed = (checkFailed || checkEnvironmentToBranchSchemeStatus);
+
+        console.log('');
+        checkVersionInCommit(versions, (checkVersionInCommitStatus) => {
+          checkFailed = (checkFailed || checkVersionInCommitStatus);
+
+          console.log('');
+          checkLintErrors((checkLintErrorsStatus) => {
+            checkFailed = (checkFailed || checkLintErrorsStatus);
+
+            console.log('');
+            console.log('END "RUNNING CHECKS BEFORE PRODUCTION BUILD..."');
+            console.log('----------------------------------------------------------------------------------------------------------------------');
+            if (checkFailed) {
+              throw new Error('Some prebuild checks failed, see logs to find out which ones.');
+            }
+            callback();
+          });
+        });
+      });
+    });
+  });
+}
+
+
+function checkForUncommitedFiles(callback) {
+  console.log('- Check if branch is clear. No uncommited changes are allowed.');
+  const cliCommand = 'git status -u --porcelain';
+  runCliCommandSilent(cliCommand, (code, output) => {
+    let checkFailed = false;
+    if (code !== 0) {
+      console.log('\x1b[31m FAILED! "git status" command failed. \x1b[0m');
+      checkFailed = true;
+    } else if (output.length > 0) {
+      console.log('\x1b[31m FAILED! You have uncommited changes. \x1b[0m');
+      checkFailed = true;
+    } else {
+      console.log('\x1b[32m PASSED! \x1b[0m');
+    }
+    callback(checkFailed);
+  });
+}
+
+
+function checkRemoteBranch(callback) {
+  console.log('- Check if local branch is up to date with remote branch.');
+  const cliGetCurrentBranchName = 'git rev-parse --abbrev-ref HEAD';
+  runCliCommandSilent(cliGetCurrentBranchName, (code, branchName) => {
+    if (code !== 0) {
+      console.log('\x1b[31m FAILED! "git rev-parse" command failed. \x1b[0m');
+      callback(true);
+    } else {
+      branchName = branchName.trim();
+      const cliGitFetch = `git fetch origin ${branchName}`;
+      runCliCommandSilent(cliGitFetch, (code) => {
+        if (code !== 0) {
+          console.log('\x1b[31m FAILED! "git fetch" command failed. \x1b[0m');
+          callback(true);
+        } else {
+          const cliGitDiff = `git diff origin/${branchName} ${branchName} --name-only`;
+          runCliCommandSilent(cliGitDiff, (code, diffData) => {
+            if (code !== 0) {
+              console.log('\x1b[31m FAILED! "git diff" command failed. \x1b[0m');
+              callback(true);
+            } else if (diffData.length > 0) {
+              console.log('\x1b[31m FAILED! Local branch is not up to date with remote branch. \x1b[0m');
+              callback(true);
+            } else {
+              console.log('\x1b[32m PASSED! \x1b[0m');
+              callback(false);
+            }
+          });
+        }
+      });
+    }
+  });
+}
+
+
+function checkEnvironmentToBranchScheme(versions, options, callback) {
+  console.log('- Check if build for selected environment can be made from current branch.');
+
+  const cliGetCurrentBranchName = 'git rev-parse --abbrev-ref HEAD';
+  runCliCommandSilent(cliGetCurrentBranchName, (code, branchName) => {
+    if (code !== 0) {
+      console.log('\x1b[31m FAILED! "git rev-parse" command failed. \x1b[0m');
+      callback(true);
+    } else {
+      branchName = branchName.trim();
+      if (options.environment === 'getik') {
+        if (branchName === 'develop') {
+          console.log('\x1b[32m PASSED! \x1b[0m');
+          callback(false);
+        } else {
+          console.log('\x1b[31m FAILED! You can build for "getik" environment only from "develop". \x1b[0m');
+          callback(true);
+        }
+      } else if (options.environment === 'qa') {
+        const requiredBranchName = `release/${versions.versionName.substring(0, versions.versionName.length - 2)}x`;
+        if (branchName === requiredBranchName) {
+          console.log('\x1b[32m PASSED! \x1b[0m');
+          callback(false);
+        } else {
+          console.log(`\x1b[31m FAILED! You can build for "qa" environment only from "${requiredBranchName}". \x1b[0m`);
+          callback(true);
+        }
+      } else if (options.environment === 'preprod' || options.environment === 'prod') {
+        if (branchName === 'master') {
+          console.log('\x1b[32m PASSED! \x1b[0m');
+          callback(false);
+        } else {
+          console.log(`\x1b[31m FAILED! You can build for "${options.environment}" environment only from "master". \x1b[0m`);
+          callback(true);
+        }
+      } else {
+        console.log('\x1b[32m PASSED! \x1b[0m');
+        callback(false);
+      }
+    }
+  });
+}
+
+
+function checkVersionInCommit(versions, callback) {
+  console.log('- Check if latest commit is a version update commit and it is the same as in "package.json".');
+  const cliCommand = 'git log -1 --pretty=%B';
+  runCliCommandSilent(cliCommand, (code, commitMessage) => {
+    commitMessage = commitMessage.trim();
+    let checkFailed = false;
+    if (code !== 0) {
+      console.log('\x1b[31m FAILED! "git log" command failed. \x1b[0m');
+      checkFailed = true;
+    } else {
+      const expectedMessage = `APP VERSION UPDATE: versionName: ${versions.versionName}`;
+      if (commitMessage === expectedMessage) {
+        console.log('\x1b[32m PASSED! \x1b[0m');
+        checkFailed = false;
+      } else {
+        console.log('\x1b[31m FAILED! Version in "package.json" is not the same as in commit message. \x1b[0m');
+        checkFailed = true;
+      }
+    }
+    callback(checkFailed);
+  });
+}
+
+
+function checkLintErrors(callback) {
+  console.log('- Check for lint errors.');
+  const P = ['\\', '|', '/', '-'];
+  let x = 0;
+  const ref = setInterval(() => {
+    process.stdout.write('\r' + P[x++]);
+    x &= 3;
+  }, 250);
+  const cliCommand = 'npm run lint';
+  runCliCommandSilent(cliCommand, (code, output) => {
+    clearInterval(ref);
+    process.stdout.write('\r');
+    let checkFailed = false;
+    if (code !== 0) {
+      console.log('\x1b[31m FAILED! There are "lint" errors. \x1b[0m');
+      checkFailed = true;
+    } else {
+      console.log('\x1b[32m PASSED! \x1b[0m');
+    }
+    callback(checkFailed);
+  });
+}
+
+
 export const mobileBuild = () => {
   program
     .command('mobile-build')
+    .requiredOption('-p, --platform <type>', 'Platform: android, ios')
     .requiredOption('-e, --environment <type>', 'Environment: getik, getikDebug')
-    .option('-p, --platform <type>', 'Platform: android, ios')
     .option('--syncOnly', 'Apply capacitor sync only, without platform build')
-    .option('--ota', 'Only build files for OTA update, not full application build')
     .option('--aab', 'Android platform only, final build as AAB')
     .option('--upload', 'iOS platform only, upload directly to AppStore')
-    .action(async (options) => {
+    .option('--force', 'Skip all checks for builds of type release')
+    .action((options) => {
       console.log('INPUT OPTIONS: ', options);
-      const versions = readVersionsFromPackageJson(options);
-      makeVersionsFileInTypescript(versions);
-
-      if (options.ota) {
-        const otaCliCommands = createCommandsForOTA(options, versions);
-        runCliCommandList(otaCliCommands, undefined, () => {
-          console.log('ZIP file for OTA update created, check folder: ./build/ota/');
-        });
-
-        return;
-      }
-
       const cliCommands = createCliCommands(options);
-
-      if (options.platform === 'android') {
-        checkKeystorePropertiesFile();
-        applyVersionForAndroid(versions);
-      } else if (options.platform === 'ios') {
-        checkSensitiveDataJsonFile();
-        applyVersionForIos(versions);
-      }
-      await applyPatchersForExternalNpmPackages();
-      runCliCommand(cliCommands.buildAngular, function () {
-        runCliCommand(cliCommands.capacitorSync(), function () {
-          runCliCommandList(cliCommands.buildApp, options.platform, () => {
-            setTimeout(() => {
-              copyFinalBuildToRootFolder(options);
-            }, 100);
+      const versions = readVersionsFromPackageJson();
+
+      applyReleaseBuildChecks(versions, options, () => {
+        if (options.platform === 'android') {
+          checkKeystorePropertiesFile();
+          applyVersionForAndroid(versions);
+        } else if (options.platform === 'ios') {
+          checkSensitiveDataJsonFile();
+          applyVersionForIos(versions);
+        }
+        applyPatchersForExternalNpmPackages().then(() => {
+          runCliCommand(cliCommands.buildAngular, function () {
+            runCliCommand(cliCommands.capacitorSync(), function () {
+              runCliCommandList(cliCommands.buildApp, options.platform, () => {
+                setTimeout(() => {
+                  copyFinalBuildToRootFolder(options);
+                }, 100);
+              });
+            });
           });
         });
       });

package/src/increment-version.js

@@ -1,141 +0,0 @@
-import { program } from 'commander';
-import { spawn } from 'child_process';
-import fs from 'fs';
-import path from 'path';
-
-
-function incrementMobileVersions(type, environment) {
-  const packageJsonBuffer = fs.readFileSync(path.join(process.cwd(), 'package.json'));
-  const packageJson = JSON.parse(packageJsonBuffer);
-
-  const allPackageJsonProperties = Object.keys(packageJson);
-  const otaVersionProperties = [];
-  if (environment) {
-    const env = (environment.charAt(0).toUpperCase() + environment.slice(1));
-    const versionPropertyName = `otaVersion${env.split('Debug')[0]}`;
-    const found = allPackageJsonProperties.find((property) => {
-      return (property === versionPropertyName);
-    });
-    if (found) {
-      otaVersionProperties.push(versionPropertyName);
-    }
-  } else {
-    const filtered = allPackageJsonProperties.filter((property) => {
-      const name = 'otaVersion';
-
-      return (property.indexOf(name) === 0) && (property.length > name.length);
-    });
-    otaVersionProperties.push(...filtered);
-
-  }
-
-  if (otaVersionProperties.length === 0) {
-    console.log(`WARNING: OTA version${environment ? 'for ' + environment : ''} not found in package.json. If project doesn't have OTA update ignore this warning. If project has OTA update feature, then make sure every environment has specific property with version defined in package.json`);
-  } else {
-    otaVersionProperties.forEach((propertyName) => {
-      packageJson[propertyName]++;
-    });
-  }
-
-  if (type === 'ota') {
-    if (otaVersionProperties.length === 0) {
-      console.log(`OTA version not incremented, no property found in package.json.`);
-    }
-    fs.writeFileSync(path.join(process.cwd(), 'package.json'), JSON.stringify(packageJson, null, 2));
-    createCommit(packageJson, otaVersionProperties);
-
-    return;
-  }
-
-  const splitVersion = packageJson.version.split('.');
-  let x = parseInt(splitVersion[0], 10);
-  let y = parseInt(splitVersion[1], 10);
-  let z = parseInt(splitVersion[2], 10);
-
-  if (type === 'major') {
-    x++;
-    y = 0;
-    z = 0;
-  } else if (type === 'minor') {
-    y++;
-    z = 0;
-  } else if (type === 'patch') {
-    z++;
-  } else {
-    console.log('Invalid version increment type. Options available: major, minor, patch, ota');
-  }
-
-  packageJson.version = `${x}.${y}.${z}`;
-
-  fs.writeFileSync(path.join(process.cwd(), 'package.json'), JSON.stringify(packageJson, null, 2));
-
-  const packageLockJsonBuffer = fs.readFileSync(path.join(process.cwd(), 'package-lock.json'));
-  const packageLockJson = JSON.parse(packageLockJsonBuffer);
-  packageLockJson.version = `${x}.${y}.${z}`;
-  packageLockJson.packages[''].version = `${x}.${y}.${z}`;
-  fs.writeFileSync(path.join(process.cwd(), 'package-lock.json'), JSON.stringify(packageLockJson, null, 2));
-
-  createCommit(packageJson, otaVersionProperties);
-}
-
-
-function createCommit(packageJsonRef, otaVersionProperties) {
-  let otaVersionMessage = '';
-  otaVersionProperties.forEach((property) => {
-    otaVersionMessage += `; ${property}: ${packageJsonRef[property]}`;
-  });
-  const message = `APP VERSION UPDATE: versionName: ${packageJsonRef.version}${otaVersionMessage}.`;
-
-  const cliCommand = `git commit -a -m "${message}"`;
-  const ls = spawn(cliCommand, [], {shell: true, env: { ...process.env, FORCE_COLOR: true }, cwd: ''});
-
-  ls.on('close', (code) => {
-    if (code !== 0) {
-      console.log('\x1b[31m');
-      throw new Error(`Command FAILED: ${cliCommand}`);
-    } else {
-      console.log(`A new commit was added with message "${message}"`);
-    }
-  });
-}
-
-
-function gitCheckIfCleanRepo(callback) {
-  const cliCommand = 'git status --porcelain';
-  const ls = spawn(cliCommand, [], {shell: true, env: { ...process.env, FORCE_COLOR: true }, cwd: ''});
-  const output = [];
-  ls.stdout.on('data', (data) => {
-    output.push(data);
-  });
-
-  ls.on('close', (code) => {
-    if (code !== 0) {
-      console.log('\x1b[31m');
-      throw new Error(`Command FAILED: ${cliCommand}`);
-    } else if (output.length > 0) {
-      console.log('\x1b[31m');
-      throw new Error('You have uncommited changes. Commit or clear changes before running this command.');
-    } else {
-      callback();
-    }
-  });
-}
-
-
-export const incrementVersion = () => {
-  program
-    .command('increment-version')
-    .requiredOption('-t, --type <type>', 'Type: major - 3.x.x -> 4.x.x; minor - 3.1.x -> 3.2.x; patch - 3.1.0 -> 3.1.1; ota - this is done by default in other types.')
-    .requiredOption('-p, --project <type>', 'Project: mobile')
-    .option('-e, --environment <type>', 'Environment: getik, getikDebug')
-    .action((options) => {
-      console.log('INPUT OPTIONS: ', options);
-      gitCheckIfCleanRepo(function() {
-        if (options.project === 'mobile') {
-          incrementMobileVersions(options.type, options.environment);
-        } else {
-          console.log('Other project types are not supported yet, now only "mobile" is available.');
-        }
-      });
-    });
-};