Skip to content

dev.md

Latest commit

 

History

History
79 lines (45 loc) · 3.25 KB

dev.md

File metadata and controls

79 lines (45 loc) · 3.25 KB
Raw

Environment

The root directory is a typical multi-page app of Vite with Svelte JavaScript project.

The xcode directory is the root of the Xcode project where the Safari extension app is built.

For other directory structure instructions, please refer to structure.md.

Recommended code editor

Visual Studio Code with extensions: /.vscode/extensions.json

Template

The project is currently based on template-svelte from create-vite.

Additional reference templates are from create-svelte.

Reviewing the template will help you understand the composition of the project.

Requirement

Dev

  • npm install1
  • npm run dev1

Build

  • npm run build1
  • cd ./xcode
  • xcodebuild12 or build with Xcode App

Xcode

Configurations

The Xcode project contains two configurations, which have independent xcconfig configuration files, and can run on your local at the same time without conflicts.

  • Debug: No developer account is required, that is Sign to Run Locally by default, which will speed up the build during development. This is convenient for developers without an account, and contributors who only need to do simple local debugging.

  • Release: A developer account is required, which means it can be used for distribution as well as running on real iOS/iPadOS devices. You will need to override your developer account information in xcconfig to complete the build.

xcconfig

All xcconfig files are in the /xcode/xcconfig/ directory. Each .xcconfig file can be overridden by .dev.xcconfig in the same path, they will be ignored by git, so you can override any build settings locally.

For example, you can create an Userscripts-Release.dev.xcconfig file to override Userscripts-Release.xcconfig and fill in your own developer account information there:

Userscripts-Release.dev.xcconfig

DEVELOPMENT_TEAM = XXXXXXXXXX

Another example, if you want Debug builds to be also signed, so instead of enabling Allow Unsigned Extensions every time in Safari, you can create:

Userscripts-Debug.dev.xcconfig

CODE_SIGN_IDENTITY = Apple Development
DEVELOPMENT_TEAM = XXXXXXXXXX

Note that all existing .xcconfig files already include .dev.xcconfig files of the same name, so they will be applied automatically once you create them. You only need to fill in the setting items that need to be overridden or added.

Contribute

Contributing guide

About

Userscripts @ 2018-2023

Footnotes

  1. These commands can also be executed directly through the vscode tasks. Please refer to: /.vscode/tasks.json ↩ ↩2 ↩3 ↩4

  2. Local setup may be required. Please refer to: Building from the Command Line with Xcode FAQ ↩