144 pbxproj files (#146)

* Working on pbx

* Add strings plist and xcconfig files to xcode project

* Fix build

Author: mlynch

packages/configure/src/tasks/run.ts

@@ -87,7 +87,7 @@ async function checkModifiedFiles(ctx: Context) {
   Object.keys(files).map(k => {
     const file = files[k];
     log(c.log.WARN(c.strong(`updated`)), file.getFilename());
-    const diff = diffs.find(d => d.file === file);
+    const diff = diffs.find((d: any) => d.file === file);
     if (diff && ctx.args.diff) {
       printDiff(diff);
     }
@@ -110,12 +110,12 @@ async function checkModifiedFiles(ctx: Context) {
     );
 
     if (answers.apply) {
-      return ctx.project.vfs.commitAll();
+      return ctx.project.vfs.commitAll(ctx.project);
     } else {
       log('Not applying changes. Exiting');
     }
   } else if (!ctx.args.dryRun && ctx.args.y) {
     logger.info('-y provided, automatically applying configuration');
-    return ctx.project.vfs.commitAll();
+    return ctx.project.vfs.commitAll(ctx.project);
   }
 }

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

@@ -518,6 +518,29 @@ export class IosProject extends PlatformProject {
     return copy(srcPath, destPath);
   }
 
+  /**
+   * Add a source file to the project. this attemps to add the file
+   * to the main "app" target, or adds it to the empty group (i.e. the root of
+   * the project tree) if the app target can't be found.
+   */
+  async addFile(path: string): Promise<void> {
+    const groups = this.pbxProject?.hash.project.objects['PBXGroup'] ?? [];
+    const emptyGroup = Object.entries(groups).find(([key, value]: [string, any]) => {
+      return value.isa === 'PBXGroup' && typeof value.name === 'undefined'
+    });
+
+    const appTarget = this.getAppTargetName();
+    const appGroup = Object.entries(groups).find(([key, value]: [string, any]) => {
+      return value.isa === 'PBXGroup' && (value.name === appTarget || value.path === appTarget);
+    });
+
+    if (appGroup) {
+      this.pbxProject?.addSourceFile(path, {}, appGroup?.[0]);
+    } else {
+      this.pbxProject?.addSourceFile(path, {}, emptyGroup?.[0]);
+    }
+  }
+
   private async assertEntitlementsFile(targetName: IosTargetName, buildName: IosBuildName | null) {
     let file = this.getEntitlementsFile(targetName, buildName ?? undefined);
 

packages/project/src/ios/project.ts

@@ -1,5 +1,6 @@
 import plist, { PlistObject, PlistValue } from "plist";
-import { readFile, writeFile } from '@ionic/utils-fs';
+import { relative } from 'path';
+import { pathExists, readFile, writeFile } from '@ionic/utils-fs';
 import { mergeWith, union } from 'lodash';
 
 import { parsePlist } from "./util/plist";
@@ -23,25 +24,40 @@ export class PlistFile extends VFSStorable {
     this.doc = doc;
   }
 
+  async exists() {
+    return pathExists(this.path);
+  }
+
   async load() {
     if (this.vfs.isOpen(this.path)) {
       return;
     }
 
-    this.doc = await parsePlist(this.path);
+    if (await this.exists()) {
+      this.doc = await parsePlist(this.path);
+    } else {
+      this.doc = {};
+    }
+
     Logger.v('plist', 'read', `Loaded plist file at ${this.path}`, this.doc);
     this.vfs.open(this.path, this, this.plistCommitFn, this.plistDiffFn);
   }
 
-  private plistCommitFn = async (file: VFSFile) => {
+  private plistCommitFn = async (file: VFSFile, project: MobileProject) => {
     const data = file.getData() as PlistFile;
     const xml = plist.build(data.getDocument() ?? {}, {
       indent: '	', // Tab character
       offset: -1,
       newline: '\n'
     });
+    const shouldAdd = !(await pathExists(this.path));
     await assertParentDirs(file.getFilename());
-    return writeFile(file.getFilename(), xml);
+    await writeFile(file.getFilename(), xml);
+    // Add the file to the project
+    if (shouldAdd) {
+      const rel = relative(project.config.ios?.path ?? '', this.path);
+      project.ios?.addFile(rel);
+    }
   }
 
   plistDiffFn = async (file: VFSFile) => {

packages/project/src/plist.ts

@@ -76,7 +76,7 @@ export class MobileProject {
   }
 
   commit(): Promise<void> {
-    return this.vfs.commitAll();
+    return this.vfs.commitAll(this);
   }
 
   async copyFile(src: string, dest: string): Promise<void> {

packages/project/src/project.ts

@@ -1,5 +1,7 @@
 import { pathExists, readFile, writeFile } from '@ionic/utils-fs';
+import { relative } from 'path';
 import { Logger } from './logger';
+import { MobileProject } from './project';
 import { assertParentDirs } from './util/fs';
 import { generateStrings, parseStrings, StringsEntries } from './util/strings';
 import { VFS, VFSFile, VFSStorable } from './vfs';
@@ -90,10 +92,18 @@ export class StringsFile extends VFSStorable {
     return parseStrings(contents);
   }
 
-  private commitFn = async (file: VFSFile) => {
+  private commitFn = async (file: VFSFile, project: MobileProject) => {
     const f = file.getData() as StringsFile;
     const src = generateStrings(f.doc);
     await assertParentDirs(file.getFilename());
-    return writeFile(file.getFilename(), src);
+
+    const shouldAdd = !(await pathExists(this.path));
+    await writeFile(file.getFilename(), src);
+
+    // Add the file to the project
+    if (shouldAdd) {
+      const rel = relative(project.config.ios?.path ?? '', this.path);
+      project.ios?.addFile(rel);
+    }
   }
 }

packages/project/src/strings.ts

@@ -1,4 +1,5 @@
 import * as Diff from 'diff';
+import { MobileProject } from './project';
 
 export interface VFSDiff {
   file?: VFSFile;
@@ -21,7 +22,7 @@ export class VFSRef<T extends VFSStorable> {
   constructor(
     private filename: string,
     private data: T | null,
-    private commitFn: (file: VFSFile) => Promise<void>,
+    private commitFn: (file: VFSFile, project: MobileProject) => Promise<void>,
     private diffFn?: (file: VFSFile) => Promise<VFSDiff>,
   ) {}
 
@@ -42,8 +43,8 @@ export class VFSRef<T extends VFSStorable> {
     this.modified = true;
   }
 
-  commit(): Promise<void> {
-    return this.commitFn(this);
+  commit(project: MobileProject): Promise<void> {
+    return this.commitFn(this, project);
   }
 
   async diff(): Promise<VFSDiff> {
@@ -70,7 +71,7 @@ export class VFS {
   open<T extends VFSStorable>(
     filename: string,
     data: T,
-    commitFn: (file: VFSFile) => Promise<void>,
+    commitFn: (file: VFSFile, project: MobileProject) => Promise<void>,
     diffFn?: (file: VFSFile) => Promise<VFSDiff>,
   ) {
     const ref = new VFSRef(filename, data, commitFn, diffFn);
@@ -93,8 +94,8 @@ export class VFS {
     }, {} as { [key: string]: VFSFile });
   }
 
-  async commitAll() {
-    await Promise.all(Object.values(this.openFiles).map(file => file.commit()));
+  async commitAll(project: MobileProject) {
+    await Promise.all(Object.values(this.openFiles).map(file => file.commit(project)));
   }
 
   async diffAll() {

packages/project/src/vfs.ts

@@ -1,5 +1,7 @@
 import { pathExists, readFile, writeFile } from '@ionic/utils-fs';
+import { relative } from 'path';
 import { Logger } from './logger';
+import { MobileProject } from './project';
 import { assertParentDirs } from './util/fs';
 import { VFS, VFSFile, VFSStorable } from './vfs';
 
@@ -76,9 +78,15 @@ export class XCConfigFile extends VFSStorable {
     return contents;
   }
 
-  private commitFn = async (file: VFSFile) => {
+  private commitFn = async (file: VFSFile, project: MobileProject) => {
     const src = this.generate();
     await assertParentDirs(file.getFilename());
-    return writeFile(file.getFilename(), src);
+    const shouldAdd = !(await pathExists(this.path));
+    await writeFile(file.getFilename(), src);
+    // Add the file to the project
+    if (shouldAdd) {
+      const rel = relative(project.config.ios?.path ?? '', this.path);
+      project.ios?.addFile(rel);
+    }
   }
 }

packages/project/src/xcconfig.ts

@@ -1,7 +1,7 @@
 import tempy from 'tempy';
 import { join } from 'path';
 import { copy, pathExists, readFile, rm } from '@ionic/utils-fs';
-import { MobileProject } from '../src';
+import { MobileProject, StringsFile, XCConfigFile, XmlFile } from '../src';
 import { MobileProjectConfig } from '../src/config';
 import { PlistFile } from '../src/plist';
 
@@ -381,6 +381,43 @@ describe('project - ios standard', () => {
     const destContents = await readFile(dest);
     expect(destContents.length).toBeGreaterThan(0);
   });
+
+  it('should add source files when committing', async () => {
+    const stringsFile = project.ios?.getProjectFile<StringsFile>(
+        "NewStrings.strings",
+        (filename: string) => new StringsFile(filename, project.vfs)
+      );
+    await stringsFile?.load();
+
+    const xcconfigFile = project.ios?.getProjectFile<XCConfigFile>(
+        "NewConfig.xcconfig",
+        (filename: string) => new XCConfigFile(filename, project.vfs)
+      );
+    await xcconfigFile?.load();
+
+    const plistFile = project.ios?.getProjectFile<PlistFile>(
+        "NewPlist.plist",
+        (filename: string) => new PlistFile(filename, project.vfs)
+      );
+    await plistFile?.load();
+
+    /*
+    const xmlFile = project.ios?.getProjectFile<XmlFile>(
+        "NewXml.xml",
+        (filename: string) => new XmlFile(filename, project.vfs)
+      );
+    await xmlFile?.load();
+    */
+
+    await project.commit();
+
+    const pbx = project.ios?.getPbxProject();
+    expect(!!pbx?.hasFile('NewStrings.strings')).toBe(true);
+    expect(!!pbx?.hasFile('NewConfig.xcconfig')).toBe(true);
+    expect(!!pbx?.hasFile('NewPlist.plist')).toBe(true);
+    // expect(!!pbx?.hasFile('NewXml.xml')).toBe(true);
+  });
+
 });
 
 describe('ios - no info plist case', () => {