Wikipedia iOS
The official Wikipedia iOS app.
Building and Running
Note: Your Xcode version must be at least 16.0.
In the directory, run ./scripts/setup. Note: going to scripts directory and running setup will not work due to relative paths.
Running scripts/setup will setup your computer to build and run the app. The script assumes you have Xcode installed already. It will install homebrew, SwiftLint, ClangFormat, and Periphery. It will also create a pre-commit hook that uses ClangFormat for linting Objective-C code.
After running scripts/setup, you should be able to open Wikipedia.xcodeproj and run the app on the iOS Simulator (using the Wikipedia scheme and target). If you encounter any issues, please don't hesitate to let us know via a bug report.
Required Dependencies
If you'd rather install the development prerequisites yourself without our script:
Contributing
Covered in our contributing documentation on MediaWiki.
Development Guidelines
These are general guidelines rather than hard rules.
Coding Guidelines
Formatting
We use Xcode's default 4 space indentation and our .clang-format file with the pre-commit hook setup by scripts/setup. Where possible, our Swift code is automatically formatted by SwiftLint based on the rules defined in .swiftlint-autocorrect.yml.
Process and Code Review Norms
Covered in the process document.
Logging
When reading logs, note that the log levels are shortened to emoji.
- 🗣️ Verbose
- 💬 Debug
- ℹ️ Info
- ⚠️ Warning
- 🚨 Error
The app only writes Warning and Error messages to the console for both Debug and Release mode. If you need to log all messages temporarily during troubleshooting, update this level to DDLogLevelAll.
Testing
The Wikipedia scheme is configured to execute the project's iOS unit tests, which can be run using the Cmd+U hotkey or the Product → Test menu bar action. In order for the tests to pass, the test device's language and region must be set to en-US in Settings → General → Language & Region. There is a ticket filed to update the tests to pass regardless of language and region.
Schemes and Targets
- Wikipedia - Points to production servers.
- Alpha - Points to various staging server environments. You can adjust these environments by changing the
current property of Configuration:
- An option of
appsLabsForPCS will point to the Apps team's staging environment for page content.
- An option of
betaCluster will point to the MediaWiki beta cluster environment for most API calls. This is meant to be a more blanket environment setting, so if this value exists it will also force the beta cluster environment for page content on the article view. This beta cluster environment is also where developers can test sandbox push notifications triggered across various wikis. This is selected by default.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
