More verbose logging (#121)

* Logging

* Don't show diff for files missing

* More iOS verbose logging

* More logging and create json file if not exists

* More android logging

* Happy with additional logging

* More better logging

* Cleanup

Author: mlynch

package-lock.json

@@ -18,7 +18,7 @@ export default async function execute(ctx: Context, op: Operation) {
 
     jsonFile = ctx.project.ios?.getProjectFile<JsonFile>(
       filename!,
-      (filename: string) => new JsonFile(filename, ctx.project.vfs),
+      (filename: string) => new JsonFile(filename, ctx.project.vfs)
     );
 
     if (!jsonFile) {

packages/configure/src/operations/ios/json.ts

@@ -1,12 +1,13 @@
 import c from '../colors';
 import { processOperations } from '../op';
-import { logger, log, error, warn } from '../util/log';
+import { logger, log, error, warn, debug } from '../util/log';
 import { logPrompt } from '../util/cli';
 import { loadYamlConfig, YamlFile } from '../yaml-config';
 import { hasHandler, runOperation } from '../operations/index';
 import { Context } from '../ctx';
 import { Operation } from '../definitions';
-import { VFSDiff } from '@trapezedev/project';
+import { Logger, VFSDiff } from '@trapezedev/project';
+import kleur from 'kleur';
 
 export async function runCommand(ctx: Context, configFile: YamlFile) {
   let processed: Operation[];
@@ -34,7 +35,13 @@ export async function runCommand(ctx: Context, configFile: YamlFile) {
 async function executeOperations(ctx: Context, operations: Operation[]) {
   for (const op of operations) {
     if (!ctx.args.quiet) {
-      printOp(op);
+      printOp(ctx, op);
+    }
+
+    const skipped = op.platform === 'ios' ? !ctx.project.ios : !ctx.project.android;
+    if (skipped) {
+      Logger.debug(`Skipping ${op.id} because ${op.platform} project does not exist`);
+      continue;
     }
 
     if (!hasHandler(op)) {
@@ -49,9 +56,10 @@ async function executeOperations(ctx: Context, operations: Operation[]) {
   await checkModifiedFiles(ctx);
 }
 
-function printOp(op: Operation) {
+function printOp(ctx: Context, op: Operation) {
+  const skipped = op.platform === 'ios' ? !ctx.project.ios : !ctx.project.android;
   // const env = c.weak(`[${op.env}]`);
-  const tag = c.weak(c.strong(`run`));
+  const tag = skipped ? c.weak(c.strong(`skip`)) : kleur.bold().magenta(`run`);
   const platform = c.success(c.strong(`${op.platform}`));
   const opName = c.strong(op.name);
   const opDisplay = op.displayText;

packages/configure/src/tasks/run.ts

@@ -32,14 +32,15 @@
     "@types/slice-ansi": "^5.0.0",
     "@xmldom/xmldom": "^0.7.5",
     "conventional-changelog": "^3.1.4",
+    "cross-fetch": "^3.1.5",
     "cross-spawn": "^7.0.3",
     "diff": "^5.1.0",
     "env-paths": "^3.0.0",
     "gradle-to-js": "^2.0.0",
     "ini": "^2.0.0",
+    "kleur": "^4.1.5",
     "lodash": "^4.17.21",
     "mergexml": "^1.2.3",
-    "cross-fetch": "^3.1.5",
     "npm-watch": "^0.9.0",
     "plist": "^3.0.4",
     "prettier": "^2.7.1",

packages/gradle-parse/capacitor-gradle-parse.jar

@@ -7,6 +7,7 @@ import { indent } from '../util/text';
 import { VFS, VFSFile, VFSStorable, VFSDiff } from '../vfs';
 import detectIndent from '../util/detect-indent';
 import { AndroidGradleInjectType } from '../definitions';
+import { Logger } from '../logger';
 
 export type GradleAST = any;
 export interface GradleASTNode {
@@ -238,6 +239,9 @@ export class GradleFile extends VFSStorable {
       throw new Error(this.gradleParseError());
     }
 
+    Logger.v('gradle', 'parse', `running Gradle parse with Java path ${java}`);
+    Logger.v('gradle', 'parse', `read gradle file at ${this.filename}`);
+
     try {
       let json: string | null = null;
 
@@ -529,6 +533,7 @@ export class GradleFile extends VFSStorable {
     const source = await this.getGradleSource();
 
     if (source) {
+      Logger.v('gradle', 'setVersionCode', `to ${versionCode} in ${this.filename}`);
       this.source = source.replace(/(versionCode\s+)\w+/, `$1${versionCode}`);
     }
   }
@@ -556,6 +561,7 @@ export class GradleFile extends VFSStorable {
       }
       const num = parseInt(versionCode[1]);
       if (!isNaN(num)) {
+        Logger.v('gradle', 'incrementVersionCode', `to ${num} in ${this.filename}`);
         this.source = source.replace(/(versionCode\s+)\w+/, `$1${num + 1}`);
       }
     }
@@ -565,6 +571,7 @@ export class GradleFile extends VFSStorable {
     const source = await this.getGradleSource();
 
     if (source) {
+      Logger.v('gradle', 'setVersionName', `to ${versionName} in ${this.filename}`);
       this.source = source.replace(
         /(versionName\s+)["'][^"']+["']/,
         `$1"${versionName}"`,

packages/project/package.json

@@ -19,6 +19,7 @@ import { XmlFile } from '../xml';
 import { PropertiesFile } from '../properties';
 import { PlatformProject } from '../platform-project';
 import { readSource } from '../read-src';
+import { Logger } from '../logger';
 
 export class AndroidProject extends PlatformProject {
   private manifest: XmlFile;
@@ -83,14 +84,14 @@ export class AndroidProject extends PlatformProject {
   getXmlFile(path: string) {
     return this.getProjectFile(
       path,
-      (filename: string) => new XmlFile(filename, this.project.vfs),
+      (filename: string) => new XmlFile(filename, this.project.vfs)
     );
   }
 
   getPropertiesFile(path: string) {
     return this.getProjectFile(
       path,
-      (filename: string) => new PropertiesFile(filename, this.project.vfs),
+      (filename: string) => new PropertiesFile(filename, this.project.vfs)
     );
   }
 
@@ -118,6 +119,8 @@ export class AndroidProject extends PlatformProject {
       ?.getAttribute('package');
     const oldPackageParts = oldPackageName?.split('.') ?? [];
 
+    Logger.v('android', 'setPackageName', 'setting Android package name to', packageName, 'from', oldPackageName);
+
     if (packageName === oldPackageName) {
       return;
     }
@@ -131,9 +134,11 @@ export class AndroidProject extends PlatformProject {
 
     this.manifest.getDocumentElement()?.setAttribute('package', packageName);
     await this.appBuildGradle?.setApplicationId(packageName);
+    Logger.v('android', 'setPackageName', `set manifest package attribute and applicationId to ${packageName}`);
     this.manifest.setAttrs('manifest/application/activity', {
       'android:name': `${packageName}.MainActivity`,
     });
+    Logger.v('android', 'setPackageName', `set <activity android:name="${packageName}.MainActivity"`);
 
     if (!this.getAppRoot()) {
       return;
@@ -143,11 +148,14 @@ export class AndroidProject extends PlatformProject {
 
     const destDir = join(sourceDir, ...newPackageParts);
 
-    // TODO: Don't hard code this
     const mainActivityName = this.getMainActivityFilename();
 
+    Logger.v('android', 'setPackageName', `Got main activity name ${mainActivityName}`);
+
     let activityFile = join(sourceDir, ...oldPackageParts, mainActivityName);
 
+    Logger.v('android', 'setPackageName', `Looking for old activity file at ${activityFile}`);
+
     // Make the new directory tree and any missing parents
     await mkdirp(destDir);
     // Move the old activity file over
@@ -157,6 +165,8 @@ export class AndroidProject extends PlatformProject {
     // from the deepest
     let sourceDirLeaf = join(sourceDir, ...oldPackageParts);
 
+    Logger.v('android', 'setPackageName', `removing old source dirs for old package (${sourceDirLeaf})`);
+
     for (const _ of oldPackageParts) {
       try {
         await rmdir(sourceDirLeaf);
@@ -169,6 +179,7 @@ export class AndroidProject extends PlatformProject {
     // Rename the package in the main source file
     activityFile = join(sourceDir, ...newPackageParts, this.getMainActivityFilename());
     if (await pathExists(activityFile)) {
+      Logger.v('android', 'setPackageName', `renaming package in source for activity file ${activityFile}`);
       const activitySource = await readFile(activityFile, {
         encoding: 'utf-8',
       });
@@ -253,6 +264,8 @@ export class AndroidProject extends PlatformProject {
 
     const dir = join(root, resDir);
 
+    Logger.v(`android`, 'addResource', `add res file ${file} to ${resDir}`);
+
     if (!(await pathExists(dir))) {
       await mkdir(dir);
     }
@@ -266,6 +279,8 @@ export class AndroidProject extends PlatformProject {
     }
     const destPath = join(this.project.config.android.path, dest);
 
+    Logger.v(`android`, `copyFile`, `copying ${src} to ${destPath}`);
+
     if (/^(https?:\/\/)/.test(src)) {
       const res = await fetch(src);
       return writeFile(destPath, Buffer.from(await res.arrayBuffer()));
@@ -291,6 +306,8 @@ export class AndroidProject extends PlatformProject {
       await mkdir(dir);
     }
 
+    Logger.v(`android`, `copyToResources`, `copying ${file} to Android resources at ${join(dir, file)}`);
+
     const sourceData = await readSource(source);
     return writeFile(join(dir, file), sourceData);
   }

packages/project/src/android/gradle-file.ts

@@ -1,6 +1,7 @@
 export * from './definitions';
 export * from './frameworks';
 export * from './config';
+export * from './logger';
 export * from './project';
 export * from './xml';
 export * from './json';