import ExternalLink from 'sentry/components/links/externalLink';
import List from 'sentry/components/list/';
import ListItem from 'sentry/components/list/listItem';
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
import type {
Docs,
OnboardingConfig,
} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {appleFeedbackOnboarding} from 'sentry/gettingStartedDocs/apple/apple-macos';
import {t, tct} from 'sentry/locale';
const getExperimentalFeaturesSnippet = () => `
import Sentry
SentrySDK.start { options in
// ...
// Enable all experimental features
options.attachViewHierarchy = true
options.enablePreWarmedAppStartTracing = true
options.enableMetricKit = true
options.enableTimeToFullDisplayTracing = true
options.swiftAsyncStacktraces = true
}`;
const onboarding: OnboardingConfig = {
install: () => [
{
type: StepType.INSTALL,
description: (
{tct(
'Add Sentry automatically to your app with the [wizardLink:Sentry wizard] (call this inside your project directory).',
{
wizardLink: (
),
}
)}
),
configurations: [
{
language: 'bash',
code: `brew install getsentry/tools/sentry-wizard && sentry-wizard -i ios`,
},
],
},
],
configure: () => [
{
type: StepType.CONFIGURE,
description: t('The Sentry wizard will automatically patch your application:'),
configurations: [
{
description: (
{t('Install the Sentry SDK via Swift Package Manager or Cocoapods')}
{tct(
'Update your [appDelegate: AppDelegate] or SwiftUI App Initializer with the default Sentry configuration and an example error',
{
appDelegate:
,
}
)}
{tct(
'Add a new [phase: Upload Debug Symbols] phase to your [xcodebuild: xcodebuild] build script',
{
phase:
,
xcodebuild:
,
}
)}
{tct(
'Create [sentryclirc: .sentryclirc] with an auth token to upload debug symbols (this file is automatically added to [gitignore: .gitignore])',
{
sentryclirc:
,
gitignore:
,
}
)}
{t(
"When you're using Fastlane, it will add a Sentry lane for uploading debug symbols"
)}
),
additionalInfo: tct(
'Alternatively, you can also [manualSetupLink:set up the SDK manually].',
{
manualSetupLink: (
),
stepsBelow: ,
}
),
},
],
},
],
verify: () => [
{
type: StepType.VERIFY,
description: t(
'The Sentry wizard automatically adds a code snippet that captures a message to your project. Simply run your app and you should see this message in your Sentry project.'
),
},
{
title: t('Experimental Features'),
description: tct(
'Want to play with some new features? Try out our experimental features for [vh: View Hierarchy], [ttfd: Time to Full Display (TTFD)], [metricKit: MetricKit], [prewarmedAppStart: Prewarmed App Start Tracing], and [asyncStacktraces: Swift Async Stacktraces]. Experimental features are still a work-in-progress and may have bugs. We recognize the irony. [break] Let us know if you have feedback through [gh: GitHub issues].',
{
vh: (
),
ttfd: (
),
metricKit: (
),
prewarmedAppStart: (
),
asyncStacktraces: (
),
gh: ,
break:
,
}
),
configurations: [
{
language: 'swift',
code: getExperimentalFeaturesSnippet(),
},
],
},
],
nextSteps: () => [
{
id: 'cocoapods-carthage',
name: t('CocoaPods/Carthage'),
description: t(
'Learn about integrating Sentry into your project using CocoaPods or Carthage.'
),
link: 'https://docs.sentry.io/platforms/apple/install/',
},
{
id: 'debug-symbols',
name: t('Debug Symbols'),
description: t('Symbolicate and get readable stacktraces in your Sentry errors.'),
link: 'https://docs.sentry.io/platforms/apple/dsym/',
},
{
id: 'swiftui',
name: t('SwiftUI'),
description: t('Learn about our first class integration with SwiftUI.'),
link: 'https://docs.sentry.io/platforms/apple/performance/instrumentation/swiftui-instrumentation/',
},
{
id: 'profiling',
name: t('Profiling'),
description: t(
'Collect and analyze performance profiles from real user devices in production.'
),
link: 'https://docs.sentry.io/platforms/apple/profiling/',
},
],
};
const docs: Docs = {
onboarding,
feedbackOnboardingCrashApi: appleFeedbackOnboarding,
};
export default docs;