bigdig / browser-ios-1

Ghostery Browser for iOS

Cliqz for iOS

This branch (master)

This branch is for mainline development.

This branch only works with Xcode 9.3 and supports iOS 10, and 11.

This branch is written in Swift 4

Please make sure you aim your pull requests in the right direction.

Getting involved

We encourage you to participate in this open source project. We love Pull Requests, Bug Reports, ideas, (security) code reviews or any kind of positive contribution.

Building the code

As of April 2018, this project requires Xcode 9.3. Latest Node version 10 breaks. Use node v9.

1. Install the latest Xcode developer tools from Apple.
2. Install Carthage

   brew update
   brew install carthage

3. Install cocoadpods

   sudo gem install cocoapods

4. Fork the repository https://github.com/ghostery/browser-ios
5. Clone the forked repository:

   git clone https://github.com/YOUR_USERNAME/ghostery-ios

6. Pull in the project dependencies:

   cd ghostery-ios
   sh ./bootstrap.sh
   npm install
   npm run bundle
   pod install

7. Open Client.xcworkspace in Xcode.
8. Build the Fennec scheme in Xcode.

Building User Scripts

User Scripts (JavaScript injected into the WKWebView) are compiled, concatenated and minified using webpack. User Scripts to be aggregated are placed in the following directories:

/Client
|-- /Frontend
    |-- /UserContent
        |-- /UserScripts
            |-- /AllFrames
            |   |-- /AtDocumentEnd
            |   |-- /AtDocumentStart
            |-- /MainFrame
                |-- /AtDocumentEnd
                |-- /AtDocumentStart

This reduces the total possible number of User Scripts down to four. The compiled output from concatenating and minifying the User Scripts placed in these folders resides in /Client/Assets and are named accordingly:

• AllFramesAtDocumentEnd.js
• AllFramesAtDocumentStart.js
• MainFrameAtDocumentEnd.js
• MainFrameAtDocumentStart.js

To simplify the build process, these compiled files are checked-in to this repository. When adding or editing User Scripts, these files can be re-compiled with webpack manually. This requires Node.js to be installed and all required npm packages can be installed by running npm install in the root directory of the project. User Scripts can be compiled by running the following npm command in the root directory of the project:

npm run build

Contributor guidelines

Swift style

• Swift code should generally follow the conventions listed at https://github.com/raywenderlich/swift-style-guide.
  • Exception: we use 4-space indentation instead of 2.

Whitespace

• New code should not contain any trailing whitespace.
• We recommend enabling both the "Automatically trim trailing whitespace" and "Including whitespace-only lines" preferences in Xcode (under Text Editing).
• git rebase --whitespace=fix can also be used to remove whitespace from your commits before issuing a pull request.

Commits

• Each commit should have a single clear purpose. If a commit contains multiple unrelated changes, those changes should be split into separate commits.
• If a commit requires another commit to build properly, those commits should be squashed.
• Follow-up commits for any review comments should be squashed. Do not include "Fixed PR comments", merge commits, or other "temporary" commits in pull requests.