rork-xcode 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Rork, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,124 @@
+# rork-xcode
+
+[![CI](https://github.com/rorkai/rork-xcode/actions/workflows/ci.yml/badge.svg)](https://github.com/rorkai/rork-xcode/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/rork-xcode)](https://www.npmjs.com/package/rork-xcode)
+
+The [fastest](#performance) zero-dependency Xcode project (`project.pbxproj`) parser and builder for any JavaScript runtime: browsers, Node.js, Bun, Electron, Cloudflare Workers, and React Native.
+
+```ts
+import { parsePbxproj, buildPbxproj } from "rork-xcode";
+
+const project = parsePbxproj(pbxprojText);
+
+for (const [uuid, object] of Object.entries(project.objects)) {
+  if (object.isa === "PBXNativeTarget") {
+    console.log(uuid, object.name, object.productType);
+  }
+}
+
+const text = buildPbxproj(project); // byte-stable, Xcode-canonical layout
+```
+
+## Why
+
+`project.pbxproj` is the heart of every Xcode project: targets, build phases, build settings, file references. Programs that create or repair Xcode projects increasingly run everywhere at once: an API on an edge runtime, a desktop app's Node process, a CLI inside a build sandbox.
+
+`rork-xcode` is designed for exactly that situation:
+
+- **Zero dependencies.** The pbxproj grammar is a small OpenStep-style property list dialect: dictionaries, arrays, strings, and hex data runs. A dedicated scanner covers it completely, with no general-purpose parser stack, no native addon, and no WASM blob.
+- **One artifact, one code path.** A single ESM file with named exports. No environment-conditional entry points, no reliance on ambient globals like `Buffer`. What you test locally is what runs in production, whatever the bundler.
+- **Xcode-canonical output.** The serializer reproduces the layout Xcode itself writes (tab indentation, per-isa object sections in sorted order, single-line build-file entries, and derived reference comments like `13B07F86… /* AppDelegate.swift in Sources */`), so diffs against Xcode-saved projects stay minimal and Xcode does not rewrite the file on next save.
+- **Round-trip faithful.** Parse → build is byte-identical for Xcode-canonical documents and a fixed point for everything else. Lexical subtleties that plain number conversion would destroy (leading-zero values like `0755`, trailing-zero versions like `5.0`, digit runs longer than the double-precision safe range) are preserved as strings by design.
+- **Loud failure modes.** Malformed documents fail with a typed error carrying line and column; unrepresentable values (`null`, booleans, non-finite numbers) fail with the exact path of the offending value. Nothing is silently dropped.
+
+## Install
+
+```sh
+pnpm add rork-xcode
+```
+
+## API
+
+### `parsePbxproj(text)`
+
+Parses a `project.pbxproj` document into plain JavaScript values. The leading `// !$*UTF8*$!` marker and all comments are treated as trivia.
+
+| Source shape                                           | JavaScript value |
+| ------------------------------------------------------ | ---------------- |
+| `{ key = value; ... }`                                 | plain object     |
+| `( item, item, ... )`                                  | array            |
+| unquoted number that prints back (`46`, `3.14`, `-12`) | `number`         |
+| `<48656c6c6f>`                                         | `Uint8Array`     |
+| everything else                                        | `string`         |
+
+An unquoted literal becomes a number exactly when the number formats back to the identical text, so serializing can never change a scalar's bytes: leading-zero values (`0755`), trailing-zero versions (`5.0`), bare-dot decimals (`.5`), and digit runs beyond double precision all stay strings. Dictionary keys keep document order. Quoted values are always strings, so `"46"` and `46` remain distinguishable.
+
+```ts
+import { parsePbxproj, PbxprojParseError } from "rork-xcode";
+
+try {
+  const project = parsePbxproj(text);
+} catch (error) {
+  if (error instanceof PbxprojParseError) {
+    console.error(error.message); // "Expected ';' but found '}' (line 41, column 3)"
+    console.error(error.position); // { offset, line, column }
+  }
+}
+```
+
+### `buildPbxproj(root)`
+
+Serializes a document back to pbxproj text. The input is the same shape `parsePbxproj` produces; any dictionary works, and documents carrying a root-level `objects` dictionary get the full Xcode layout treatment: sections grouped by `isa` and sorted, entries sorted by identifier, and reference comments derived from the object graph. Version-like build settings (`SWIFT_VERSION = 5.0`) arrive from the parser as strings and round-trip verbatim.
+
+```ts
+import { buildPbxproj, PbxprojBuildError } from "rork-xcode";
+
+try {
+  const text = buildPbxproj(project);
+} catch (error) {
+  if (error instanceof PbxprojBuildError) {
+    console.error(error.message); // "Cannot serialize a null value… (at $.objects.AA10….name)"
+    console.error(error.path); // "$.objects.AA10….name"
+  }
+}
+```
+
+Booleans are rejected on purpose. The format has no boolean notation (Xcode models flags as the strings `"YES"` and `"NO"`), so writing one would produce a value Xcode misreads.
+
+## Performance
+
+`rork-xcode` is measured against the pbxproj parsers on npm, [`@bacons/xcode`](https://www.npmjs.com/package/@bacons/xcode) (its `/json` parse/build entry point) and [`xcode`](https://www.npmjs.com/package/xcode) (the long-standing package used by native build tooling), on three documents: two real Xcode-written projects from the test suite and a deterministically generated five-target app with 800 source files. It is the fastest at both operations on every document, with zero dependencies.
+
+<p align="center">
+  <img src="assets/performance.svg" alt="Benchmark chart comparing rork-xcode with the @bacons/xcode and xcode packages. Bars show time relative to rork-xcode as the geometric mean over three project documents. Parsing, @bacons/xcode takes 1.3 times as long and xcode 21 times. Building, xcode takes 1.6 times as long and @bacons/xcode 9 times." width="880" />
+</p>
+
+| Operation | Document                | `rork-xcode` | `@bacons/xcode`  | `xcode`          |
+| --------- | ----------------------- | ------------ | ---------------- | ---------------- |
+| parse     | legacy app (7 KiB)      | **13.9 µs**  | 17.8 µs (1.3×)   | 297.7 µs (21.4×) |
+| parse     | app, Xcode 16 (20 KiB)  | **43.7 µs**  | 54.4 µs (1.2×)   | 795.0 µs (18.2×) |
+| parse     | generated app (471 KiB) | **0.84 ms**  | 1.20 ms (1.4×)   | 19.74 ms (23.6×) |
+| build     | legacy app              | **15.9 µs**  | 43.1 µs (2.7×)   | 29.6 µs (1.9×)   |
+| build     | app, Xcode 16           | **37.5 µs**  | 113.6 µs (3.0×)  | 71.3 µs (1.9×)   |
+| build     | generated app           | **0.98 ms**  | 85.98 ms (87.7×) | 1.20 ms (1.2×)   |
+
+Measured on an Apple M5 Max, Node.js 24, single thread, with `@bacons/xcode` 1.0.0-alpha.33 and `xcode` 3.0.1. Multipliers are relative to `rork-xcode` on the same row; the ordering also holds on Bun. Reproduce with `pnpm bench:compare`, which interleaves the libraries in round-robin batches and reports the median, after verifying that every library round-trips every fixture.
+
+### Key performance features
+
+- **Single-pass scanner.** One cursor over the input string with table-driven character classification; no tokenizer stage, no intermediate token objects.
+- **Comments skip in bulk.** Reference comments are a sizable share of a canonical document's bytes; comment bodies are jumped with `indexOf` instead of being scanned per character.
+- **Linear comment derivation.** Building the `/* … */` annotations uses reverse indexes over the object graph (build file → phase, configuration list → owner), so serialization stays linear on projects with thousands of objects.
+- **Memoized rendering.** Quoting decisions for the repeated key vocabulary and rendered uuid references are cached per document, halving the quote scans on reference-heavy sections.
+
+## Verification
+
+- The committed fixture corpus spans project generations from Xcode 3 to Xcode 16, captured from real projects with identifiers neutralized: synchronized folders with both exception-set kinds, classic groups, variant groups, aggregate and legacy targets, reference proxies, build rules, Swift packages, and a ~100 KiB multiplatform framework project.
+- Documents already in current Xcode's layout must round-trip byte for byte; documents from other tool generations must normalize to a byte-stable fixed point with unchanged values.
+- On macOS, the suite cross-validates every fixture and its rebuilt form with `plutil`, Apple's own property list parser and the empirical ground truth for what Apple tooling accepts.
+- A corpus sweep (`pnpm corpus`) walks every Xcode project on the machine, verifies each one parses and reaches a byte-stable fixed point, and cross-validates a sample of parsed values against plutil's own reading.
+- CI runs the full gate on Linux and macOS, and executes the built artifact on the oldest supported Node to enforce the `engines` floor.
+
+## License
+
+Apache-2.0

package/dist/index.d.ts

@@ -0,0 +1,155 @@
+//#region src/types.d.ts
+/**
+ * The value model shared by {@link parsePbxproj} and {@link buildPbxproj}.
+ *
+ * `project.pbxproj` files are OpenStep-style property lists: dictionaries,
+ * arrays, strings, and hexadecimal data runs. The format carries no type
+ * markers beyond quoting, so the mapping is driven by lexical shape:
+ *
+ * - `{ key = value; ... }` parses to a {@link PbxprojObject}.
+ * - `( item, item, ... )` parses to a {@link PbxprojArray}.
+ * - `<48656c6c6f>` data runs parse to `Uint8Array`.
+ * - Unquoted integers and decimals (`46`, `3.14`, `-12`) parse to `number`
+ *   under one print-back rule: the literal converts exactly when the number
+ *   formats back to the identical text.
+ * - Everything else (quoted text, identifiers, uuids, paths) parses to
+ *   `string`.
+ *
+ * The print-back rule is what keeps round-trips faithful: any literal the
+ * conversion would reshape stays a string, so serializing never changes a
+ * scalar's bytes. Leading-zero runs like `0755` would corrupt file modes,
+ * trailing-zero decimals like `5.0` would drop the zero build settings are
+ * written with, bare-dot decimals like `.5` would grow a leading zero, and
+ * digit runs beyond `Number.MAX_SAFE_INTEGER` would lose precision (a
+ * 24-character identifier can be all digits); all of these therefore parse
+ * as strings.
+ *
+ * @module
+ */
+/**
+ * A value representable in a `project.pbxproj` document.
+ *
+ * Notably absent are booleans and null: the format has no notation for
+ * either, and Xcode models flags as the strings `"YES"` and `"NO"`.
+ */
+type PbxprojValue = string | number | Uint8Array | PbxprojArray | PbxprojObject;
+/**
+ * A `( ... )` list: an ordered array of values.
+ *
+ * This is a plain JavaScript array; the interface exists only to give the
+ * recursive {@link PbxprojValue} type a name.
+ */
+interface PbxprojArray extends Array<PbxprojValue> {}
+/**
+ * A `{ ... }` dictionary: a plain object whose keys appear in document order.
+ *
+ * Duplicate keys in a parsed document resolve to the last occurrence. A
+ * literal `__proto__` key is always stored as an own property, so parsing
+ * untrusted documents cannot pollute prototypes.
+ */
+interface PbxprojObject {
+  [key: string]: PbxprojValue;
+}
+//#endregion
+//#region src/build.d.ts
+/**
+ * Serializes a project document to `project.pbxproj` text.
+ *
+ * The input is the same shape {@link parsePbxproj} produces; see the module
+ * documentation of `types.ts` for the value model. Output is stable: two
+ * calls with semantically equal documents produce identical text, and the
+ * layout matches what Xcode itself writes so diffs stay minimal.
+ *
+ * @param root The document root. Real project documents carry `objects`,
+ *   `rootObject`, and the version fields, but any dictionary serializes.
+ * @returns The document text, terminated by a newline.
+ * @throws PbxprojBuildError when a value has no pbxproj representation:
+ *   `null`, `undefined`, booleans, bigints, functions, symbols, class
+ *   instances, or non-finite numbers. The error names the path of the
+ *   offending value.
+ */
+declare function buildPbxproj(root: PbxprojObject): string;
+//#endregion
+//#region src/errors.d.ts
+/**
+ * Error types raised by this library.
+ *
+ * Both error classes are exported so callers can distinguish "the document is
+ * malformed" ({@link PbxprojParseError}) from "this value cannot be written"
+ * ({@link PbxprojBuildError}) and report precise context for each.
+ *
+ * @module
+ */
+/**
+ * Location of a parse failure inside the source text.
+ *
+ * Offsets count UTF-16 code units from the start of the string (the same
+ * units `String.prototype.slice` uses), so editors and log tooling can jump
+ * straight to the failure.
+ */
+interface PbxprojErrorPosition {
+  /** Zero-based character offset into the source string. */
+  offset: number;
+  /** One-based line number. */
+  line: number;
+  /** One-based column number, in characters from the start of the line. */
+  column: number;
+}
+/**
+ * Thrown when the source text is not a well-formed OpenStep-style property
+ * list (the format of `project.pbxproj` files).
+ *
+ * The message always embeds the line and column of the failure, and the same
+ * information is available in structured form on {@link position} for
+ * programmatic use.
+ */
+declare class PbxprojParseError extends Error {
+  /** Where in the source text parsing failed. */
+  readonly position: PbxprojErrorPosition;
+  /**
+   * @param message Failure description without location; the location is
+   *   appended automatically.
+   * @param source Full source text, used to compute the position.
+   * @param offset Character offset of the failure inside `source`.
+   */
+  constructor(message: string, source: string, offset: number);
+}
+/**
+ * Thrown when a value cannot be represented in a `project.pbxproj` document.
+ *
+ * Raised for `null`, `undefined`, booleans, bigints, functions, symbols,
+ * class instances, and non-finite numbers. The format itself has no boolean
+ * or null notation (Xcode models booleans as the strings `YES`/`NO`), so
+ * rejecting them loudly beats writing a value Xcode would misread. The
+ * {@link path} pinpoints the offending value inside the input, which matters
+ * when serializing a project with thousands of objects.
+ */
+declare class PbxprojBuildError extends Error {
+  /** Path to the offending value from the root, e.g. `$.objects.13B07F86.name`. */
+  readonly path: string;
+  /**
+   * @param message Failure description without location; the value path is
+   *   appended automatically.
+   * @param path Path to the offending value from the root, `$`.
+   */
+  constructor(message: string, path: string);
+}
+//#endregion
+//#region src/parse.d.ts
+/**
+ * Parses a `project.pbxproj` document into JavaScript values.
+ *
+ * Accepts the leading `// !$*UTF8*$!` marker and any other comments as
+ * trivia. Content after the root value is ignored. See the module
+ * documentation of `types.ts` for how source shapes map to JavaScript
+ * values.
+ *
+ * @param text Source text of the document.
+ * @returns The document's root value. For real project files this is the
+ *   root dictionary with `objects`, `rootObject`, and version fields.
+ * @throws PbxprojParseError when the document is malformed; the error
+ *   carries the line and column of the failure.
+ */
+declare function parsePbxproj(text: string): PbxprojValue;
+//#endregion
+export { type PbxprojArray, PbxprojBuildError, type PbxprojErrorPosition, type PbxprojObject, PbxprojParseError, type PbxprojValue, buildPbxproj, parsePbxproj };