refactor: rename macPackager to osxPackager

electron-userland · Apr 28, 2016 · 955507f · 955507f
1 parent 7373131
commit 955507f
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/docs/Options.md b/docs/Options.md
@@ -50,7 +50,7 @@ Here documented only `electron-builder` specific options:
 ## `.build`
 | Name | Description
 | --- | ---
-| app-bundle-id | <a name="BuildMetadata-app-bundle-id"></a>*OS X-only.* The bundle identifier to use in the application's plist.
+| app-bundle-id | <a name="BuildMetadata-app-bundle-id"></a>*OS X-only.* The app bundle ID. See [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070).
 | app-category-type | <a name="BuildMetadata-app-category-type"></a><p>*OS X-only.* The application category type, as shown in the Finder via *View -&gt; Arrange by Application Category* when viewing the Applications directory.</p> <p>For example, <code>app-category-type=public.app-category.developer-tools</code> will set the application category to *Developer Tools*.</p> <p>Valid values are listed in [Apple’s documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).</p>
 | asar | <a name="BuildMetadata-asar"></a><p>Whether to package the application’s source code into an archive, using [Electron’s archive format](https://github.com/electron/asar). Defaults to <code>true</code>. Reasons why you may want to disable this feature are described in [an application packaging tutorial in Electron’s documentation](http://electron.atom.io/docs/latest/tutorial/application-packaging/#limitations-on-node-api/).</p>
 | iconUrl | <a name="BuildMetadata-iconUrl"></a><p>*windows-only.* A URL to an ICO file to use as the application icon (displayed in Control Panel &gt; Programs and Features). Defaults to the Electron icon.</p> <p>Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.</p> <ul> <li>If you don’t plan to build windows installer, you can omit it.</li> <li>If your project repository is public on GitHub, it will be <code>https://raw.githubusercontent.com/${u}/${p}/master/build/icon.ico</code> by default.</li> </ul>

diff --git a/src/metadata.ts b/src/metadata.ts
@@ -76,7 +76,7 @@ export interface AuthorMetadata {
  */
 export interface BuildMetadata {
   /*
-   *OS X-only.* The bundle identifier to use in the application's plist.
+   *OS X-only.* The app bundle ID. See [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070).
    */
   readonly "app-bundle-id"?: string
   /*

diff --git a/src/macPackager.ts → src/osxPackager.ts b/src/macPackager.ts → src/osxPackager.ts
diff --git a/src/packager.ts b/src/packager.ts
@@ -6,7 +6,7 @@ import { Promise as BluebirdPromise } from "bluebird"
 import { InfoRetriever } from "./repositoryInfo"
 import { AppMetadata, DevMetadata, Platform } from "./metadata"
 import { PackagerOptions, PlatformPackager, BuildInfo, ArtifactCreated } from "./platformPackager"
-import MacPackager from "./macPackager"
+import OsXPackager from "./osxPackager"
 import { WinPackager } from "./winPackager"
 import * as errorMessages from "./errorMessages"
 import * as util from "util"
@@ -92,7 +92,7 @@ export class Packager implements BuildInfo {
     switch (platform) {
       case Platform.OSX:
       {
-        const helperClass: typeof MacPackager = require("./macPackager").default
+        const helperClass: typeof OsXPackager = require("./osxPackager").default
         return new helperClass(this, cleanupTasks)
       }
 

diff --git a/test/src/osxPackagerTest.ts b/test/src/osxPackagerTest.ts
@@ -1,7 +1,7 @@
 import test from "./helpers/avaEx"
 import { assertPack, platform, modifyPackageJson } from "./helpers/packTester"
 import { Platform } from "out"
-import OsXPackager from "out/macPackager"
+import OsXPackager from "out/osxPackager"
 import { move } from "fs-extra-p"
 import * as path from "path"
 import { BuildInfo } from "out/platformPackager"

diff --git a/tsconfig.json b/tsconfig.json
@@ -66,8 +66,8 @@
     "src/index.ts",
     "src/install-app-deps.ts",
     "src/linuxPackager.ts",
-    "src/macPackager.ts",
     "src/metadata.ts",
+    "src/osxPackager.ts",
     "src/packager.ts",
     "src/platformPackager.ts",
     "src/promise.ts",