node-xcode icon indicating copy to clipboard operation
node-xcode copied to clipboard

Lack of documentation costs hours

Open jfrumar opened this issue 8 years ago • 0 comments

There is no documentation for this module, both in the README and in the code (there's no comments, no function JSdoc headers, nothing).

This means we've spent countless hours trying to determine how to interface with, and grok this module. The PBX file format is tough enough on its own, so adding code on top of it makes it a very blurry-eyed experience.

It's impossible to tell which functions are designed to be called externally, and which ones are purely for internal purposes only since the whole pbxProject class is exported, and every function is exposed on the prototype. For example a internal use function prefix (like '_internalOnlyFunc()') would give a big hint, or just not putting every internal helper function on the prototype would help too.

I'm trying to modify a simple "Copy Files Phase" framework to enable code signing. The file doesn't appear in the PBXBuildFile section until I manually click the "Code Sign On Copy" in xcode. I am trying to add the file to the PBXBuildFile section so that I can specify the "CodeSignOnCopy" attribute.

jfrumar avatar May 09 '16 18:05 jfrumar