@sentry/wizard 4.0.0 → 4.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (330) hide show
  1. package/CHANGELOG.md +11 -2
  2. package/dist/NextJs/configs/next.config.js +1 -1
  3. package/dist/bin.js +2 -1
  4. package/dist/bin.js.map +1 -1
  5. package/dist/bump-version.js +28 -0
  6. package/dist/craft-pre-release.sh +2 -0
  7. package/dist/lib/Steps/Initial.js +2 -12
  8. package/dist/lib/Steps/Initial.js.map +1 -1
  9. package/dist/lib/Steps/Integrations/Electron.js +1 -1
  10. package/dist/lib/Steps/Integrations/Electron.js.map +1 -1
  11. package/dist/src/nextjs/templates.js +1 -1
  12. package/dist/src/nextjs/templates.js.map +1 -1
  13. package/dist/src/run.js +2 -18
  14. package/dist/src/run.js.map +1 -1
  15. package/dist/src/telemetry.js +2 -16
  16. package/dist/src/telemetry.js.map +1 -1
  17. package/dist/src/utils/clack-utils.d.ts +16 -0
  18. package/dist/src/utils/clack-utils.js +53 -45
  19. package/dist/src/utils/clack-utils.js.map +1 -1
  20. package/dist/src/version.d.ts +1 -0
  21. package/dist/src/version.js +7 -0
  22. package/dist/src/version.js.map +1 -0
  23. package/dist/test/nextjs/templates.test.js +4 -4
  24. package/dist/test/nextjs/templates.test.js.map +1 -1
  25. package/dist/test/utils/clack-utils.test.js +52 -0
  26. package/dist/test/utils/clack-utils.test.js.map +1 -1
  27. package/package.json +5 -2
  28. package/.node-cache/node-v22.14.0-darwin-arm64 +0 -0
  29. package/.node-cache/node-v22.14.0-darwin-x64 +0 -0
  30. package/.node-cache/node-v22.14.0-linux-arm64 +0 -0
  31. package/.node-cache/node-v22.14.0-linux-x64 +0 -0
  32. package/.node-cache/node-v22.14.0-win-x64.exe +0 -0
  33. package/COPYING +0 -3575
  34. package/bin.ts +0 -143
  35. package/codecov.yml +0 -15
  36. package/e2e-tests/.env.example +0 -11
  37. package/e2e-tests/README.md +0 -63
  38. package/e2e-tests/jest.config.ts +0 -22
  39. package/e2e-tests/package.json +0 -14
  40. package/e2e-tests/run.sh +0 -15
  41. package/e2e-tests/test-applications/apple/damaged-missing-configuration-list/Project.xcodeproj/project.pbxproj +0 -52
  42. package/e2e-tests/test-applications/apple/damaged-missing-configuration-list/Project.xcodeproj/xcshareddata/xcschemes/Project1.xcscheme +0 -78
  43. package/e2e-tests/test-applications/apple/no-targets/Project.xcodeproj/project.pbxproj +0 -62
  44. package/e2e-tests/test-applications/apple/no-targets/Project.xcodeproj/xcshareddata/xcschemes/Project1.xcscheme +0 -78
  45. package/e2e-tests/test-applications/apple/spm-swiftui-multi-targets/Project.xcodeproj/project.pbxproj +0 -470
  46. package/e2e-tests/test-applications/apple/spm-swiftui-multi-targets/Project.xcodeproj/xcshareddata/xcschemes/Project1.xcscheme +0 -78
  47. package/e2e-tests/test-applications/apple/spm-swiftui-multi-targets/Project1/ContentView.swift +0 -7
  48. package/e2e-tests/test-applications/apple/spm-swiftui-multi-targets/Project1/Project1App.swift +0 -10
  49. package/e2e-tests/test-applications/apple/spm-swiftui-multi-targets/Project2/ContentView.swift +0 -7
  50. package/e2e-tests/test-applications/apple/spm-swiftui-multi-targets/Project2/Project2App.swift +0 -10
  51. package/e2e-tests/test-applications/apple/spm-swiftui-single-target/Project.xcodeproj/project.pbxproj +0 -382
  52. package/e2e-tests/test-applications/apple/spm-swiftui-single-target/Project.xcodeproj/xcshareddata/xcschemes/Project.xcscheme +0 -78
  53. package/e2e-tests/test-applications/apple/spm-swiftui-single-target/Sources/ContentView.swift +0 -7
  54. package/e2e-tests/test-applications/apple/spm-swiftui-single-target/Sources/MainApp.swift +0 -10
  55. package/e2e-tests/test-applications/flutter-test-app/.metadata +0 -45
  56. package/e2e-tests/test-applications/flutter-test-app/README.md +0 -16
  57. package/e2e-tests/test-applications/flutter-test-app/analysis_options.yaml +0 -28
  58. package/e2e-tests/test-applications/flutter-test-app/android/app/build.gradle +0 -44
  59. package/e2e-tests/test-applications/flutter-test-app/android/app/src/debug/AndroidManifest.xml +0 -7
  60. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/AndroidManifest.xml +0 -45
  61. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/kotlin/com/example/flutter_magic/MainActivity.kt +0 -5
  62. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/res/drawable/launch_background.xml +0 -12
  63. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/res/drawable-v21/launch_background.xml +0 -12
  64. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/res/mipmap-hdpi/ic_launcher.png +0 -0
  65. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/res/mipmap-mdpi/ic_launcher.png +0 -0
  66. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png +0 -0
  67. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png +0 -0
  68. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png +0 -0
  69. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/res/values/styles.xml +0 -18
  70. package/e2e-tests/test-applications/flutter-test-app/android/app/src/main/res/values-night/styles.xml +0 -18
  71. package/e2e-tests/test-applications/flutter-test-app/android/app/src/profile/AndroidManifest.xml +0 -7
  72. package/e2e-tests/test-applications/flutter-test-app/android/build.gradle +0 -18
  73. package/e2e-tests/test-applications/flutter-test-app/android/gradle/wrapper/gradle-wrapper.properties +0 -5
  74. package/e2e-tests/test-applications/flutter-test-app/android/gradle.properties +0 -3
  75. package/e2e-tests/test-applications/flutter-test-app/android/settings.gradle +0 -25
  76. package/e2e-tests/test-applications/flutter-test-app/lib/main.dart +0 -125
  77. package/e2e-tests/test-applications/flutter-test-app/linux/CMakeLists.txt +0 -145
  78. package/e2e-tests/test-applications/flutter-test-app/linux/flutter/CMakeLists.txt +0 -88
  79. package/e2e-tests/test-applications/flutter-test-app/linux/flutter/generated_plugin_registrant.cc +0 -11
  80. package/e2e-tests/test-applications/flutter-test-app/linux/flutter/generated_plugin_registrant.h +0 -15
  81. package/e2e-tests/test-applications/flutter-test-app/linux/flutter/generated_plugins.cmake +0 -23
  82. package/e2e-tests/test-applications/flutter-test-app/linux/main.cc +0 -6
  83. package/e2e-tests/test-applications/flutter-test-app/linux/my_application.cc +0 -124
  84. package/e2e-tests/test-applications/flutter-test-app/linux/my_application.h +0 -18
  85. package/e2e-tests/test-applications/flutter-test-app/macos/Flutter/Flutter-Debug.xcconfig +0 -2
  86. package/e2e-tests/test-applications/flutter-test-app/macos/Flutter/Flutter-Release.xcconfig +0 -2
  87. package/e2e-tests/test-applications/flutter-test-app/macos/Flutter/GeneratedPluginRegistrant.swift +0 -10
  88. package/e2e-tests/test-applications/flutter-test-app/macos/Podfile +0 -43
  89. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/AppDelegate.swift +0 -9
  90. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json +0 -68
  91. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png +0 -0
  92. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png +0 -0
  93. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png +0 -0
  94. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png +0 -0
  95. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png +0 -0
  96. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png +0 -0
  97. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png +0 -0
  98. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Base.lproj/MainMenu.xib +0 -343
  99. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Configs/AppInfo.xcconfig +0 -14
  100. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Configs/Debug.xcconfig +0 -2
  101. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Configs/Release.xcconfig +0 -2
  102. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Configs/Warnings.xcconfig +0 -13
  103. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/DebugProfile.entitlements +0 -12
  104. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Info.plist +0 -32
  105. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/MainFlutterWindow.swift +0 -15
  106. package/e2e-tests/test-applications/flutter-test-app/macos/Runner/Release.entitlements +0 -8
  107. package/e2e-tests/test-applications/flutter-test-app/macos/Runner.xcodeproj/project.pbxproj +0 -705
  108. package/e2e-tests/test-applications/flutter-test-app/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +0 -8
  109. package/e2e-tests/test-applications/flutter-test-app/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme +0 -98
  110. package/e2e-tests/test-applications/flutter-test-app/macos/Runner.xcworkspace/contents.xcworkspacedata +0 -7
  111. package/e2e-tests/test-applications/flutter-test-app/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +0 -8
  112. package/e2e-tests/test-applications/flutter-test-app/macos/RunnerTests/RunnerTests.swift +0 -12
  113. package/e2e-tests/test-applications/flutter-test-app/pubspec.lock +0 -213
  114. package/e2e-tests/test-applications/flutter-test-app/pubspec.yaml +0 -89
  115. package/e2e-tests/test-applications/flutter-test-app/test/widget_test.dart +0 -30
  116. package/e2e-tests/test-applications/flutter-test-app/web/favicon.png +0 -0
  117. package/e2e-tests/test-applications/flutter-test-app/web/icons/Icon-192.png +0 -0
  118. package/e2e-tests/test-applications/flutter-test-app/web/icons/Icon-512.png +0 -0
  119. package/e2e-tests/test-applications/flutter-test-app/web/icons/Icon-maskable-192.png +0 -0
  120. package/e2e-tests/test-applications/flutter-test-app/web/icons/Icon-maskable-512.png +0 -0
  121. package/e2e-tests/test-applications/flutter-test-app/web/index.html +0 -38
  122. package/e2e-tests/test-applications/flutter-test-app/web/manifest.json +0 -35
  123. package/e2e-tests/test-applications/flutter-test-app/windows/CMakeLists.txt +0 -108
  124. package/e2e-tests/test-applications/flutter-test-app/windows/flutter/CMakeLists.txt +0 -109
  125. package/e2e-tests/test-applications/flutter-test-app/windows/flutter/generated_plugin_registrant.cc +0 -11
  126. package/e2e-tests/test-applications/flutter-test-app/windows/flutter/generated_plugin_registrant.h +0 -15
  127. package/e2e-tests/test-applications/flutter-test-app/windows/flutter/generated_plugins.cmake +0 -23
  128. package/e2e-tests/test-applications/flutter-test-app/windows/runner/CMakeLists.txt +0 -40
  129. package/e2e-tests/test-applications/flutter-test-app/windows/runner/Runner.rc +0 -121
  130. package/e2e-tests/test-applications/flutter-test-app/windows/runner/flutter_window.cpp +0 -71
  131. package/e2e-tests/test-applications/flutter-test-app/windows/runner/flutter_window.h +0 -33
  132. package/e2e-tests/test-applications/flutter-test-app/windows/runner/main.cpp +0 -43
  133. package/e2e-tests/test-applications/flutter-test-app/windows/runner/resource.h +0 -16
  134. package/e2e-tests/test-applications/flutter-test-app/windows/runner/resources/app_icon.ico +0 -0
  135. package/e2e-tests/test-applications/flutter-test-app/windows/runner/runner.exe.manifest +0 -14
  136. package/e2e-tests/test-applications/flutter-test-app/windows/runner/utils.cpp +0 -65
  137. package/e2e-tests/test-applications/flutter-test-app/windows/runner/utils.h +0 -19
  138. package/e2e-tests/test-applications/flutter-test-app/windows/runner/win32_window.cpp +0 -288
  139. package/e2e-tests/test-applications/flutter-test-app/windows/runner/win32_window.h +0 -102
  140. package/e2e-tests/test-applications/nextjs-test-app/next.config.mjs +0 -4
  141. package/e2e-tests/test-applications/nextjs-test-app/package.json +0 -22
  142. package/e2e-tests/test-applications/nextjs-test-app/src/app/layout.tsx +0 -20
  143. package/e2e-tests/test-applications/nextjs-test-app/src/app/page.tsx +0 -90
  144. package/e2e-tests/test-applications/nuxt-3-test-app/README.md +0 -75
  145. package/e2e-tests/test-applications/nuxt-3-test-app/nuxt.config.ts +0 -5
  146. package/e2e-tests/test-applications/nuxt-3-test-app/package.json +0 -18
  147. package/e2e-tests/test-applications/nuxt-3-test-app/public/favicon.ico +0 -0
  148. package/e2e-tests/test-applications/nuxt-3-test-app/public/robots.txt +0 -1
  149. package/e2e-tests/test-applications/nuxt-4-test-app/README.md +0 -75
  150. package/e2e-tests/test-applications/nuxt-4-test-app/nuxt.config.ts +0 -6
  151. package/e2e-tests/test-applications/nuxt-4-test-app/package.json +0 -18
  152. package/e2e-tests/test-applications/nuxt-4-test-app/public/favicon.ico +0 -0
  153. package/e2e-tests/test-applications/nuxt-4-test-app/public/robots.txt +0 -1
  154. package/e2e-tests/test-applications/remix-test-app/app/entry.client.tsx +0 -18
  155. package/e2e-tests/test-applications/remix-test-app/app/entry.server.tsx +0 -140
  156. package/e2e-tests/test-applications/remix-test-app/app/root.tsx +0 -30
  157. package/e2e-tests/test-applications/remix-test-app/app/routes/_index.tsx +0 -48
  158. package/e2e-tests/test-applications/remix-test-app/app/tailwind.css +0 -3
  159. package/e2e-tests/test-applications/remix-test-app/package.json +0 -37
  160. package/e2e-tests/test-applications/remix-test-app/postcss.config.js +0 -6
  161. package/e2e-tests/test-applications/remix-test-app/tailwind.config.ts +0 -9
  162. package/e2e-tests/test-applications/remix-test-app/vite.config.ts +0 -16
  163. package/e2e-tests/test-applications/sveltekit-test-app/package.json +0 -21
  164. package/e2e-tests/test-applications/sveltekit-test-app/src/app.d.ts +0 -13
  165. package/e2e-tests/test-applications/sveltekit-test-app/src/app.html +0 -11
  166. package/e2e-tests/test-applications/sveltekit-test-app/src/lib/index.ts +0 -1
  167. package/e2e-tests/test-applications/sveltekit-test-app/src/routes/+page.svelte +0 -2
  168. package/e2e-tests/test-applications/sveltekit-test-app/svelte.config.js +0 -18
  169. package/e2e-tests/test-applications/sveltekit-test-app/vite.config.ts +0 -6
  170. package/e2e-tests/tests/flutter.test.ts +0 -127
  171. package/e2e-tests/tests/nextjs.test.ts +0 -161
  172. package/e2e-tests/tests/nuxt-3.test.ts +0 -189
  173. package/e2e-tests/tests/nuxt-4.test.ts +0 -188
  174. package/e2e-tests/tests/remix.test.ts +0 -277
  175. package/e2e-tests/tests/sveltekit.test.ts +0 -284
  176. package/e2e-tests/utils/index.ts +0 -456
  177. package/index.ts +0 -2
  178. package/lib/Constants.ts +0 -118
  179. package/lib/Helper/BottomBar.ts +0 -28
  180. package/lib/Helper/Env.ts +0 -7
  181. package/lib/Helper/File.ts +0 -65
  182. package/lib/Helper/Git.ts +0 -39
  183. package/lib/Helper/Logging.ts +0 -44
  184. package/lib/Helper/MergeConfig.ts +0 -19
  185. package/lib/Helper/Package.ts +0 -80
  186. package/lib/Helper/SentryCli.ts +0 -139
  187. package/lib/Helper/Wizard.ts +0 -58
  188. package/lib/Helper/__tests__/File.ts +0 -15
  189. package/lib/Helper/__tests__/MergeConfig.ts +0 -98
  190. package/lib/Helper/__tests__/SentryCli.ts +0 -86
  191. package/lib/Helper/test-fixtures/next.config.1-merged.js +0 -18
  192. package/lib/Helper/test-fixtures/next.config.1.js +0 -6
  193. package/lib/Helper/test-fixtures/next.config.2.js +0 -8
  194. package/lib/Helper/test-fixtures/next.config.3-merged.js +0 -21
  195. package/lib/Helper/test-fixtures/next.config.3.js +0 -9
  196. package/lib/Helper/test-fixtures/next.config.4-merged.js +0 -21
  197. package/lib/Helper/test-fixtures/next.config.4.js +0 -9
  198. package/lib/Setup.ts +0 -40
  199. package/lib/Steps/BaseStep.ts +0 -25
  200. package/lib/Steps/ChooseIntegration.ts +0 -144
  201. package/lib/Steps/ConfigureProject.ts +0 -10
  202. package/lib/Steps/Initial.ts +0 -35
  203. package/lib/Steps/Integrations/BaseIntegration.ts +0 -42
  204. package/lib/Steps/Integrations/Cordova.ts +0 -283
  205. package/lib/Steps/Integrations/Electron.ts +0 -164
  206. package/lib/Steps/Integrations/MobileProject.ts +0 -72
  207. package/lib/Steps/OpenSentry.ts +0 -80
  208. package/lib/Steps/PromptForParameters.ts +0 -200
  209. package/lib/Steps/Result.ts +0 -22
  210. package/lib/Steps/SentryProjectSelector.ts +0 -83
  211. package/lib/Steps/ShouldConfigure.ts +0 -10
  212. package/lib/Steps/WaitForSentry.ts +0 -56
  213. package/lib/Steps/Welcome.ts +0 -21
  214. package/lib/Steps/index.ts +0 -10
  215. package/lib/__tests__/Env.ts +0 -29
  216. package/scripts/NextJs/configs/_error.js +0 -39
  217. package/scripts/NextJs/configs/next.config.js +0 -36
  218. package/scripts/NextJs/configs/next.config.template.js +0 -12
  219. package/scripts/NextJs/configs/sentry.client.config.js +0 -17
  220. package/scripts/NextJs/configs/sentry.edge.config.js +0 -17
  221. package/scripts/NextJs/configs/sentry.server.config.js +0 -17
  222. package/scripts/NextJs/sentry_sample_error.js +0 -47
  223. package/scripts/craft-pre-release.sh +0 -10
  224. package/src/android/android-wizard.ts +0 -192
  225. package/src/android/code-tools.ts +0 -170
  226. package/src/android/gradle.ts +0 -250
  227. package/src/android/manifest.ts +0 -180
  228. package/src/android/templates.ts +0 -86
  229. package/src/apple/apple-wizard.ts +0 -269
  230. package/src/apple/cocoapod.ts +0 -73
  231. package/src/apple/code-tools.ts +0 -147
  232. package/src/apple/fastlane.ts +0 -170
  233. package/src/apple/templates.ts +0 -65
  234. package/src/apple/xcode-manager.ts +0 -404
  235. package/src/flutter/code-tools.ts +0 -284
  236. package/src/flutter/flutter-wizard.ts +0 -164
  237. package/src/flutter/templates.ts +0 -90
  238. package/src/nextjs/nextjs-wizard.ts +0 -1007
  239. package/src/nextjs/templates.ts +0 -525
  240. package/src/nextjs/utils.ts +0 -21
  241. package/src/nuxt/nuxt-wizard.ts +0 -188
  242. package/src/nuxt/sdk-example.ts +0 -135
  243. package/src/nuxt/sdk-setup.ts +0 -352
  244. package/src/nuxt/templates.ts +0 -303
  245. package/src/nuxt/types.ts +0 -8
  246. package/src/nuxt/utils.ts +0 -42
  247. package/src/react-native/expo-env-file.ts +0 -55
  248. package/src/react-native/expo-metro.ts +0 -212
  249. package/src/react-native/expo.ts +0 -175
  250. package/src/react-native/git.ts +0 -25
  251. package/src/react-native/glob.ts +0 -13
  252. package/src/react-native/gradle.ts +0 -26
  253. package/src/react-native/javascript.ts +0 -103
  254. package/src/react-native/metro.ts +0 -599
  255. package/src/react-native/options.ts +0 -5
  256. package/src/react-native/react-native-wizard.ts +0 -512
  257. package/src/react-native/uninstall.ts +0 -109
  258. package/src/react-native/xcode.ts +0 -302
  259. package/src/remix/codemods/express-server.ts +0 -44
  260. package/src/remix/codemods/handle-error.ts +0 -118
  261. package/src/remix/codemods/root-common.ts +0 -63
  262. package/src/remix/codemods/root-v1.ts +0 -41
  263. package/src/remix/codemods/root-v2.ts +0 -153
  264. package/src/remix/remix-wizard.ts +0 -261
  265. package/src/remix/sdk-example.ts +0 -120
  266. package/src/remix/sdk-setup.ts +0 -546
  267. package/src/remix/templates.ts +0 -11
  268. package/src/remix/utils.ts +0 -96
  269. package/src/run.ts +0 -211
  270. package/src/sourcemaps/sourcemaps-wizard.ts +0 -364
  271. package/src/sourcemaps/tools/angular.ts +0 -42
  272. package/src/sourcemaps/tools/create-react-app.ts +0 -19
  273. package/src/sourcemaps/tools/esbuild.ts +0 -65
  274. package/src/sourcemaps/tools/nextjs.ts +0 -114
  275. package/src/sourcemaps/tools/remix.ts +0 -90
  276. package/src/sourcemaps/tools/rollup.ts +0 -67
  277. package/src/sourcemaps/tools/sentry-cli.ts +0 -287
  278. package/src/sourcemaps/tools/tsc.ts +0 -144
  279. package/src/sourcemaps/tools/types.ts +0 -11
  280. package/src/sourcemaps/tools/vite.ts +0 -300
  281. package/src/sourcemaps/tools/webpack.ts +0 -383
  282. package/src/sourcemaps/utils/detect-tool.ts +0 -46
  283. package/src/sourcemaps/utils/other-wizards.ts +0 -167
  284. package/src/sourcemaps/utils/sdk-version.ts +0 -266
  285. package/src/sveltekit/sdk-example.ts +0 -56
  286. package/src/sveltekit/sdk-setup.ts +0 -667
  287. package/src/sveltekit/sveltekit-wizard.ts +0 -192
  288. package/src/sveltekit/templates.ts +0 -185
  289. package/src/sveltekit/utils.ts +0 -50
  290. package/src/telemetry.ts +0 -144
  291. package/src/utils/ast-utils.ts +0 -270
  292. package/src/utils/bash.ts +0 -57
  293. package/src/utils/clack-utils.ts +0 -1536
  294. package/src/utils/debug.ts +0 -20
  295. package/src/utils/package-json.ts +0 -51
  296. package/src/utils/package-manager.ts +0 -172
  297. package/src/utils/release-registry.ts +0 -19
  298. package/src/utils/semver.ts +0 -33
  299. package/src/utils/sentrycli-utils.ts +0 -24
  300. package/src/utils/string.ts +0 -7
  301. package/src/utils/types.ts +0 -77
  302. package/src/utils/url.ts +0 -27
  303. package/src/utils/vendor/is-unicorn-supported.ts +0 -29
  304. package/test/android/code-tools.test.ts +0 -49
  305. package/test/apple/cocoapod.test.ts +0 -310
  306. package/test/apple/code-tools.test.ts +0 -1042
  307. package/test/apple/fastfile.test.ts +0 -555
  308. package/test/apple/templates.test.ts +0 -191
  309. package/test/apple/xcode-manager.test.ts +0 -1068
  310. package/test/flutter/code-tools.test.ts +0 -212
  311. package/test/flutter/templates.test.ts +0 -100
  312. package/test/nextjs/templates.test.ts +0 -429
  313. package/test/nuxt/templates.test.ts +0 -255
  314. package/test/react-native/expo-metro.test.ts +0 -81
  315. package/test/react-native/expo.test.ts +0 -86
  316. package/test/react-native/gradle.test.ts +0 -310
  317. package/test/react-native/javascript.test.ts +0 -134
  318. package/test/react-native/metro.test.ts +0 -396
  319. package/test/react-native/xcode.test.ts +0 -401
  320. package/test/remix/client-entry.test.ts +0 -122
  321. package/test/remix/server-instrumentation.test.ts +0 -36
  322. package/test/sourcemaps/tools/sentry-cli.test.ts +0 -57
  323. package/test/sourcemaps/tools/tsc.test.ts +0 -181
  324. package/test/sourcemaps/tools/vite.test.ts +0 -149
  325. package/test/sourcemaps/tools/webpack.test.ts +0 -303
  326. package/test/sveltekit/templates.test.ts +0 -152
  327. package/test/utils/ast-utils.test.ts +0 -264
  328. package/test/utils/clack-utils.test.ts +0 -224
  329. package/types/read-env.d.ts +0 -3
  330. package/types/xcode.d.ts +0 -527
@@ -1,1007 +0,0 @@
1
- /* eslint-disable max-lines */
2
- // @ts-ignore - clack is ESM and TS complains about that. It works though
3
- import clack from '@clack/prompts';
4
- import chalk from 'chalk';
5
- import * as fs from 'fs';
6
- // @ts-ignore - magicast is ESM and TS complains about that. It works though
7
- import { builders, generateCode, parseModule } from 'magicast';
8
- import * as path from 'path';
9
-
10
- import * as Sentry from '@sentry/node';
11
-
12
- import {
13
- abort,
14
- abortIfCancelled,
15
- addDotEnvSentryBuildPluginFile,
16
- askShouldCreateExamplePage,
17
- confirmContinueIfNoOrDirtyGitRepo,
18
- createNewConfigFile,
19
- ensurePackageIsInstalled,
20
- featureSelectionPrompt,
21
- getOrAskForProjectData,
22
- getPackageDotJson,
23
- getPackageManager,
24
- installPackage,
25
- isUsingTypeScript,
26
- printWelcome,
27
- runPrettierIfInstalled,
28
- showCopyPasteInstructions,
29
- } from '../utils/clack-utils';
30
- import type { SentryProjectData, WizardOptions } from '../utils/types';
31
- import {
32
- getFullUnderscoreErrorCopyPasteSnippet,
33
- getGlobalErrorCopyPasteSnippet,
34
- getInstrumentationHookContent,
35
- getInstrumentationHookCopyPasteSnippet,
36
- getNextjsConfigCjsAppendix,
37
- getNextjsConfigCjsTemplate,
38
- getNextjsConfigEsmCopyPasteSnippet,
39
- getSentryConfigContents,
40
- getSentryDefaultGlobalErrorPage,
41
- getSentryDefaultUnderscoreErrorPage,
42
- getSentryExamplePagesDirApiRoute,
43
- getSentryExampleAppDirApiRoute,
44
- getSentryExamplePageContents,
45
- getSimpleUnderscoreErrorCopyPasteSnippet,
46
- getWithSentryConfigOptionsTemplate,
47
- getNextjsConfigMjsTemplate,
48
- } from './templates';
49
- import { traceStep, withTelemetry } from '../telemetry';
50
- import { getPackageVersion, hasPackageInstalled } from '../utils/package-json';
51
- import { getNextJsVersionBucket } from './utils';
52
- import { configureCI } from '../sourcemaps/sourcemaps-wizard';
53
-
54
- export function runNextjsWizard(options: WizardOptions) {
55
- return withTelemetry(
56
- {
57
- enabled: options.telemetryEnabled,
58
- integration: 'nextjs',
59
- wizardOptions: options,
60
- },
61
- () => runNextjsWizardWithTelemetry(options),
62
- );
63
- }
64
-
65
- export async function runNextjsWizardWithTelemetry(
66
- options: WizardOptions,
67
- ): Promise<void> {
68
- const { promoCode, telemetryEnabled, forceInstall } = options;
69
-
70
- printWelcome({
71
- wizardName: 'Sentry Next.js Wizard',
72
- promoCode,
73
- telemetryEnabled,
74
- });
75
-
76
- const typeScriptDetected = isUsingTypeScript();
77
-
78
- await confirmContinueIfNoOrDirtyGitRepo();
79
-
80
- const packageJson = await getPackageDotJson();
81
-
82
- await ensurePackageIsInstalled(packageJson, 'next', 'Next.js');
83
-
84
- const nextVersion = getPackageVersion('next', packageJson);
85
- Sentry.setTag('nextjs-version', getNextJsVersionBucket(nextVersion));
86
-
87
- const { selectedProject, authToken, selfHosted, sentryUrl } =
88
- await getOrAskForProjectData(options, 'javascript-nextjs');
89
-
90
- const sdkAlreadyInstalled = hasPackageInstalled(
91
- '@sentry/nextjs',
92
- packageJson,
93
- );
94
- Sentry.setTag('sdk-already-installed', sdkAlreadyInstalled);
95
-
96
- const { packageManager: packageManagerFromInstallStep } =
97
- await installPackage({
98
- packageName: '@sentry/nextjs@^9',
99
- packageNameDisplayLabel: '@sentry/nextjs',
100
- alreadyInstalled: !!packageJson?.dependencies?.['@sentry/nextjs'],
101
- forceInstall,
102
- });
103
-
104
- await traceStep('configure-sdk', async () => {
105
- const tunnelRoute = await askShouldSetTunnelRoute();
106
- const reactComponentAnnotation =
107
- await askShouldEnableReactComponentAnnotation();
108
-
109
- await createOrMergeNextJsFiles(selectedProject, selfHosted, sentryUrl, {
110
- tunnelRoute,
111
- reactComponentAnnotation,
112
- });
113
- });
114
-
115
- await traceStep('create-underscoreerror-page', async () => {
116
- const srcDir = path.join(process.cwd(), 'src');
117
- const maybePagesDirPath = path.join(process.cwd(), 'pages');
118
- const maybeSrcPagesDirPath = path.join(srcDir, 'pages');
119
-
120
- const pagesLocation =
121
- fs.existsSync(maybePagesDirPath) &&
122
- fs.lstatSync(maybePagesDirPath).isDirectory()
123
- ? ['pages']
124
- : fs.existsSync(maybeSrcPagesDirPath) &&
125
- fs.lstatSync(maybeSrcPagesDirPath).isDirectory()
126
- ? ['src', 'pages']
127
- : undefined;
128
-
129
- if (!pagesLocation) {
130
- return;
131
- }
132
-
133
- const underscoreErrorPageFile = fs.existsSync(
134
- path.join(process.cwd(), ...pagesLocation, '_error.tsx'),
135
- )
136
- ? '_error.tsx'
137
- : fs.existsSync(path.join(process.cwd(), ...pagesLocation, '_error.ts'))
138
- ? '_error.ts'
139
- : fs.existsSync(path.join(process.cwd(), ...pagesLocation, '_error.jsx'))
140
- ? '_error.jsx'
141
- : fs.existsSync(path.join(process.cwd(), ...pagesLocation, '_error.js'))
142
- ? '_error.js'
143
- : undefined;
144
-
145
- if (!underscoreErrorPageFile) {
146
- await fs.promises.writeFile(
147
- path.join(process.cwd(), ...pagesLocation, '_error.jsx'),
148
- getSentryDefaultUnderscoreErrorPage(),
149
- { encoding: 'utf8', flag: 'w' },
150
- );
151
-
152
- clack.log.success(
153
- `Created ${chalk.cyan(path.join(...pagesLocation, '_error.jsx'))}.`,
154
- );
155
- } else if (
156
- fs
157
- .readFileSync(
158
- path.join(process.cwd(), ...pagesLocation, underscoreErrorPageFile),
159
- 'utf8',
160
- )
161
- .includes('getInitialProps')
162
- ) {
163
- clack.log.info(
164
- `It seems like you already have a custom error page.\n\nPlease put the following function call in the ${chalk.bold(
165
- 'getInitialProps',
166
- )}\nmethod of your custom error page at ${chalk.bold(
167
- path.join(...pagesLocation, underscoreErrorPageFile),
168
- )}:`,
169
- );
170
-
171
- // eslint-disable-next-line no-console
172
- console.log(getSimpleUnderscoreErrorCopyPasteSnippet());
173
-
174
- const shouldContinue = await abortIfCancelled(
175
- clack.confirm({
176
- message: `Did you modify your ${chalk.cyan(
177
- path.join(...pagesLocation, underscoreErrorPageFile),
178
- )} file as described above?`,
179
- active: 'Yes',
180
- inactive: 'No, get me out of here',
181
- }),
182
- );
183
-
184
- if (!shouldContinue) {
185
- await abort();
186
- }
187
- } else {
188
- clack.log.info(
189
- `It seems like you already have a custom error page.\n\nPlease add the following code to your custom error page\nat ${chalk.cyan(
190
- path.join(...pagesLocation, underscoreErrorPageFile),
191
- )}:`,
192
- );
193
-
194
- // eslint-disable-next-line no-console
195
- console.log(
196
- getFullUnderscoreErrorCopyPasteSnippet(
197
- underscoreErrorPageFile === '_error.ts' ||
198
- underscoreErrorPageFile === '_error.tsx',
199
- ),
200
- );
201
-
202
- const shouldContinue = await abortIfCancelled(
203
- clack.confirm({
204
- message: `Did you add the code to your ${chalk.cyan(
205
- path.join(...pagesLocation, underscoreErrorPageFile),
206
- )} file as described above?`,
207
- active: 'Yes',
208
- inactive: 'No, get me out of here',
209
- }),
210
- );
211
-
212
- if (!shouldContinue) {
213
- await abort();
214
- }
215
- }
216
- });
217
-
218
- await traceStep('create-global-error-page', async () => {
219
- const maybeAppDirPath = path.join(process.cwd(), 'app');
220
- const maybeSrcAppDirPath = path.join(process.cwd(), 'src', 'app');
221
-
222
- const appDirLocation =
223
- fs.existsSync(maybeAppDirPath) &&
224
- fs.lstatSync(maybeAppDirPath).isDirectory()
225
- ? ['app']
226
- : fs.existsSync(maybeSrcAppDirPath) &&
227
- fs.lstatSync(maybeSrcAppDirPath).isDirectory()
228
- ? ['src', 'app']
229
- : undefined;
230
-
231
- if (!appDirLocation) {
232
- return;
233
- }
234
-
235
- const globalErrorPageFile = fs.existsSync(
236
- path.join(process.cwd(), ...appDirLocation, 'global-error.tsx'),
237
- )
238
- ? 'global-error.tsx'
239
- : fs.existsSync(
240
- path.join(process.cwd(), ...appDirLocation, 'global-error.ts'),
241
- )
242
- ? 'global-error.ts'
243
- : fs.existsSync(
244
- path.join(process.cwd(), ...appDirLocation, 'global-error.jsx'),
245
- )
246
- ? 'global-error.jsx'
247
- : fs.existsSync(
248
- path.join(process.cwd(), ...appDirLocation, 'global-error.js'),
249
- )
250
- ? 'global-error.js'
251
- : undefined;
252
-
253
- if (!globalErrorPageFile) {
254
- const newGlobalErrorFileName = `global-error.${
255
- typeScriptDetected ? 'tsx' : 'jsx'
256
- }`;
257
-
258
- await fs.promises.writeFile(
259
- path.join(process.cwd(), ...appDirLocation, newGlobalErrorFileName),
260
- getSentryDefaultGlobalErrorPage(typeScriptDetected),
261
- { encoding: 'utf8', flag: 'w' },
262
- );
263
-
264
- clack.log.success(
265
- `Created ${chalk.cyan(
266
- path.join(...appDirLocation, newGlobalErrorFileName),
267
- )}.`,
268
- );
269
- } else {
270
- clack.log.info(
271
- `It seems like you already have a custom error page for your app directory.\n\nPlease add the following code to your custom error page\nat ${chalk.cyan(
272
- path.join(...appDirLocation, globalErrorPageFile),
273
- )}:\n`,
274
- );
275
-
276
- // eslint-disable-next-line no-console
277
- console.log(
278
- getGlobalErrorCopyPasteSnippet(
279
- globalErrorPageFile === 'global-error.ts' ||
280
- globalErrorPageFile === 'global-error.tsx',
281
- ),
282
- );
283
-
284
- const shouldContinue = await abortIfCancelled(
285
- clack.confirm({
286
- message: `Did you add the code to your ${chalk.cyan(
287
- path.join(...appDirLocation, globalErrorPageFile),
288
- )} file as described above?`,
289
- active: 'Yes',
290
- inactive: 'No, get me out of here',
291
- }),
292
- );
293
-
294
- if (!shouldContinue) {
295
- await abort();
296
- }
297
- }
298
- });
299
-
300
- const shouldCreateExamplePage = await askShouldCreateExamplePage();
301
- if (shouldCreateExamplePage) {
302
- await traceStep('create-example-page', async () =>
303
- createExamplePage(selfHosted, selectedProject, sentryUrl),
304
- );
305
- }
306
-
307
- await addDotEnvSentryBuildPluginFile(authToken);
308
-
309
- const isLikelyUsingTurbopack = await checkIfLikelyIsUsingTurbopack();
310
- if (isLikelyUsingTurbopack || isLikelyUsingTurbopack === null) {
311
- await abortIfCancelled(
312
- clack.select({
313
- message: `Warning: The Sentry SDK doesn't yet fully support Turbopack in dev mode. The SDK will not be loaded in the browser, and serverside instrumentation will be inaccurate or incomplete. Production builds will still fully work. ${chalk.bold(
314
- `To continue this setup, if you are using Turbopack, temporarily remove \`--turbo\` from your dev command until you have verified the SDK is working as expected.`,
315
- )}`,
316
- options: [
317
- {
318
- label: 'I understand.',
319
- hint: 'press enter',
320
- value: true,
321
- },
322
- ],
323
- initialValue: true,
324
- }),
325
- );
326
- }
327
-
328
- const mightBeUsingVercel = fs.existsSync(
329
- path.join(process.cwd(), 'vercel.json'),
330
- );
331
-
332
- if (mightBeUsingVercel) {
333
- clack.log.info(
334
- "▲ It seems like you're using Vercel. We recommend using the Sentry Vercel integration to set up an auth token for Vercel deployments: https://vercel.com/integrations/sentry",
335
- );
336
- } else {
337
- await traceStep('configure-ci', () => configureCI('nextjs', authToken));
338
- }
339
-
340
- const packageManagerForOutro =
341
- packageManagerFromInstallStep ?? (await getPackageManager());
342
- await runPrettierIfInstalled();
343
-
344
- clack.outro(`
345
- ${chalk.green('Successfully installed the Sentry Next.js SDK!')} ${
346
- shouldCreateExamplePage
347
- ? `\n\nYou can validate your setup by (re)starting your dev environment (e.g. ${chalk.cyan(
348
- `${packageManagerForOutro.runScriptCommand} dev`,
349
- )}) and visiting ${chalk.cyan('"/sentry-example-page"')}`
350
- : ''
351
- }${
352
- shouldCreateExamplePage && isLikelyUsingTurbopack
353
- ? `\nDon't forget to remove \`--turbo\` from your dev command until you have verified the SDK is working. You can safely add it back afterwards.`
354
- : ''
355
- }
356
-
357
- ${chalk.dim(
358
- 'If you encounter any issues, let us know here: https://github.com/getsentry/sentry-javascript/issues',
359
- )}`);
360
- }
361
-
362
- type SDKConfigOptions = {
363
- tunnelRoute: boolean;
364
- reactComponentAnnotation: boolean;
365
- };
366
-
367
- async function createOrMergeNextJsFiles(
368
- selectedProject: SentryProjectData,
369
- selfHosted: boolean,
370
- sentryUrl: string,
371
- sdkConfigOptions: SDKConfigOptions,
372
- ) {
373
- const selectedFeatures = await featureSelectionPrompt([
374
- {
375
- id: 'performance',
376
- prompt: `Do you want to enable ${chalk.bold(
377
- 'Tracing',
378
- )} to track the performance of your application?`,
379
- enabledHint: 'recommended',
380
- },
381
- {
382
- id: 'replay',
383
- prompt: `Do you want to enable ${chalk.bold(
384
- 'Sentry Session Replay',
385
- )} to get a video-like reproduction of errors during a user session?`,
386
- enabledHint: 'recommended, but increases bundle size',
387
- },
388
- ] as const);
389
-
390
- const typeScriptDetected = isUsingTypeScript();
391
-
392
- const configVariants = ['server', 'client', 'edge'] as const;
393
-
394
- for (const configVariant of configVariants) {
395
- await traceStep(`create-sentry-${configVariant}-config`, async () => {
396
- const jsConfig = `sentry.${configVariant}.config.js`;
397
- const tsConfig = `sentry.${configVariant}.config.ts`;
398
-
399
- const jsConfigExists = fs.existsSync(path.join(process.cwd(), jsConfig));
400
- const tsConfigExists = fs.existsSync(path.join(process.cwd(), tsConfig));
401
-
402
- let shouldWriteFile = true;
403
-
404
- if (jsConfigExists || tsConfigExists) {
405
- const existingConfigs = [];
406
-
407
- if (jsConfigExists) {
408
- existingConfigs.push(jsConfig);
409
- }
410
-
411
- if (tsConfigExists) {
412
- existingConfigs.push(tsConfig);
413
- }
414
-
415
- const overwriteExistingConfigs = await abortIfCancelled(
416
- clack.confirm({
417
- message: `Found existing Sentry ${configVariant} config (${existingConfigs.join(
418
- ', ',
419
- )}). Overwrite ${existingConfigs.length > 1 ? 'them' : 'it'}?`,
420
- }),
421
- );
422
- Sentry.setTag(
423
- `overwrite-${configVariant}-config`,
424
- overwriteExistingConfigs,
425
- );
426
-
427
- shouldWriteFile = overwriteExistingConfigs;
428
-
429
- if (overwriteExistingConfigs) {
430
- if (jsConfigExists) {
431
- fs.unlinkSync(path.join(process.cwd(), jsConfig));
432
- clack.log.warn(`Removed existing ${chalk.cyan(jsConfig)}.`);
433
- }
434
- if (tsConfigExists) {
435
- fs.unlinkSync(path.join(process.cwd(), tsConfig));
436
- clack.log.warn(`Removed existing ${chalk.cyan(tsConfig)}.`);
437
- }
438
- }
439
- }
440
-
441
- if (shouldWriteFile) {
442
- await fs.promises.writeFile(
443
- path.join(process.cwd(), typeScriptDetected ? tsConfig : jsConfig),
444
- getSentryConfigContents(
445
- selectedProject.keys[0].dsn.public,
446
- configVariant,
447
- selectedFeatures,
448
- ),
449
- { encoding: 'utf8', flag: 'w' },
450
- );
451
- clack.log.success(
452
- `Created fresh ${chalk.cyan(
453
- typeScriptDetected ? tsConfig : jsConfig,
454
- )}.`,
455
- );
456
- Sentry.setTag(`created-${configVariant}-config`, true);
457
- }
458
- });
459
- }
460
-
461
- await traceStep('setup-instrumentation-hook', async () => {
462
- const hasRootAppDirectory = hasDirectoryPathFromRoot('app');
463
- const hasRootPagesDirectory = hasDirectoryPathFromRoot('pages');
464
- const hasSrcDirectory = hasDirectoryPathFromRoot('src');
465
-
466
- let instrumentationHookLocation: 'src' | 'root' | 'does-not-exist';
467
-
468
- const instrumentationTsExists = fs.existsSync(
469
- path.join(process.cwd(), 'instrumentation.ts'),
470
- );
471
- const instrumentationJsExists = fs.existsSync(
472
- path.join(process.cwd(), 'instrumentation.js'),
473
- );
474
- const srcInstrumentationTsExists = fs.existsSync(
475
- path.join(process.cwd(), 'src', 'instrumentation.ts'),
476
- );
477
- const srcInstrumentationJsExists = fs.existsSync(
478
- path.join(process.cwd(), 'src', 'instrumentation.js'),
479
- );
480
-
481
- // https://nextjs.org/docs/app/building-your-application/configuring/src-directory
482
- // https://nextjs.org/docs/app/api-reference/file-conventions/instrumentation
483
- // The logic for where Next.js picks up the instrumentation file is as follows:
484
- // - If there is either an `app` folder or a `pages` folder in the root directory of your Next.js app, Next.js looks
485
- // for an `instrumentation.ts` file in the root of the Next.js app.
486
- // - Otherwise, if there is neither an `app` folder or a `pages` folder in the rood directory of your Next.js app,
487
- // AND if there is an `src` folder, Next.js will look for the `instrumentation.ts` file in the `src` folder.
488
- if (hasRootPagesDirectory || hasRootAppDirectory) {
489
- if (instrumentationJsExists || instrumentationTsExists) {
490
- instrumentationHookLocation = 'root';
491
- } else {
492
- instrumentationHookLocation = 'does-not-exist';
493
- }
494
- } else {
495
- if (srcInstrumentationTsExists || srcInstrumentationJsExists) {
496
- instrumentationHookLocation = 'src';
497
- } else {
498
- instrumentationHookLocation = 'does-not-exist';
499
- }
500
- }
501
-
502
- const newInstrumentationFileName = `instrumentation.${
503
- typeScriptDetected ? 'ts' : 'js'
504
- }`;
505
-
506
- if (instrumentationHookLocation === 'does-not-exist') {
507
- let newInstrumentationHookLocation: 'root' | 'src';
508
- if (hasRootPagesDirectory || hasRootAppDirectory) {
509
- newInstrumentationHookLocation = 'root';
510
- } else if (hasSrcDirectory) {
511
- newInstrumentationHookLocation = 'src';
512
- } else {
513
- newInstrumentationHookLocation = 'root';
514
- }
515
-
516
- const newInstrumentationHookPath =
517
- newInstrumentationHookLocation === 'root'
518
- ? path.join(process.cwd(), newInstrumentationFileName)
519
- : path.join(process.cwd(), 'src', newInstrumentationFileName);
520
-
521
- const successfullyCreated = await createNewConfigFile(
522
- newInstrumentationHookPath,
523
- getInstrumentationHookContent(newInstrumentationHookLocation),
524
- );
525
-
526
- if (!successfullyCreated) {
527
- await showCopyPasteInstructions(
528
- newInstrumentationFileName,
529
- getInstrumentationHookCopyPasteSnippet(
530
- newInstrumentationHookLocation,
531
- ),
532
- );
533
- }
534
- } else {
535
- await showCopyPasteInstructions(
536
- srcInstrumentationTsExists || instrumentationTsExists
537
- ? 'instrumentation.ts'
538
- : srcInstrumentationJsExists || instrumentationJsExists
539
- ? 'instrumentation.js'
540
- : newInstrumentationFileName,
541
- getInstrumentationHookCopyPasteSnippet(instrumentationHookLocation),
542
- );
543
- }
544
- });
545
-
546
- await traceStep('setup-next-config', async () => {
547
- const withSentryConfigOptionsTemplate = getWithSentryConfigOptionsTemplate({
548
- orgSlug: selectedProject.organization.slug,
549
- projectSlug: selectedProject.slug,
550
- selfHosted,
551
- sentryUrl,
552
- tunnelRoute: sdkConfigOptions.tunnelRoute,
553
- reactComponentAnnotation: sdkConfigOptions.reactComponentAnnotation,
554
- });
555
-
556
- const nextConfigPossibleFilesMap = {
557
- js: 'next.config.js',
558
- mjs: 'next.config.mjs',
559
- cjs: 'next.config.cjs',
560
- ts: 'next.config.ts',
561
- mts: 'next.config.mts',
562
- cts: 'next.config.cts',
563
- };
564
-
565
- const foundNextConfigFile = Object.entries(nextConfigPossibleFilesMap).find(
566
- ([, fileName]) => fs.existsSync(path.join(process.cwd(), fileName)),
567
- );
568
-
569
- if (!foundNextConfigFile) {
570
- Sentry.setTag('next-config-strategy', 'create');
571
-
572
- // Try to figure out whether the user prefers ESM
573
- let isTypeModule = false;
574
- try {
575
- const packageJsonText = await fs.promises.readFile(
576
- path.join(process.cwd(), 'package.json'),
577
- 'utf8',
578
- );
579
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
580
- const packageJson = JSON.parse(packageJsonText);
581
- // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
582
- if (packageJson.type === 'module') {
583
- isTypeModule = true;
584
- }
585
- } catch {
586
- // noop
587
- }
588
-
589
- // We are creating `next.config.(m)js` files by default as they are supported by the most Next.js versions
590
- const configFilename = isTypeModule
591
- ? nextConfigPossibleFilesMap.mjs
592
- : nextConfigPossibleFilesMap.js;
593
- const configContent = isTypeModule
594
- ? getNextjsConfigMjsTemplate(withSentryConfigOptionsTemplate)
595
- : getNextjsConfigCjsTemplate(withSentryConfigOptionsTemplate);
596
-
597
- await fs.promises.writeFile(
598
- path.join(process.cwd(), configFilename),
599
- configContent,
600
- { encoding: 'utf8', flag: 'w' },
601
- );
602
-
603
- clack.log.success(
604
- `Created ${chalk.cyan(configFilename)} with Sentry configuration.`,
605
- );
606
-
607
- return;
608
- }
609
-
610
- const [foundNextConfigFileType, foundNextConfigFileFilename] =
611
- foundNextConfigFile;
612
-
613
- if (foundNextConfigFileType === 'js' || foundNextConfigFileType === 'cjs') {
614
- Sentry.setTag('next-config-strategy', 'modify');
615
-
616
- const nextConfigCjsContent = fs.readFileSync(
617
- path.join(process.cwd(), foundNextConfigFileFilename),
618
- 'utf8',
619
- );
620
-
621
- const probablyIncludesSdk =
622
- nextConfigCjsContent.includes('@sentry/nextjs') &&
623
- nextConfigCjsContent.includes('withSentryConfig');
624
-
625
- let shouldInject = true;
626
-
627
- if (probablyIncludesSdk) {
628
- const injectAnyhow = await abortIfCancelled(
629
- clack.confirm({
630
- message: `${chalk.cyan(
631
- foundNextConfigFileFilename,
632
- )} already contains Sentry SDK configuration. Should the wizard modify it anyways?`,
633
- }),
634
- );
635
-
636
- shouldInject = injectAnyhow;
637
- }
638
-
639
- if (shouldInject) {
640
- await fs.promises.appendFile(
641
- path.join(process.cwd(), foundNextConfigFileFilename),
642
- getNextjsConfigCjsAppendix(withSentryConfigOptionsTemplate),
643
- 'utf8',
644
- );
645
-
646
- clack.log.success(
647
- `Added Sentry configuration to ${chalk.cyan(
648
- foundNextConfigFileFilename,
649
- )}. ${chalk.dim('(you probably want to clean this up a bit!)')}`,
650
- );
651
- }
652
-
653
- Sentry.setTag('next-config-mod-result', 'success');
654
- }
655
-
656
- if (
657
- foundNextConfigFileType === 'mjs' ||
658
- foundNextConfigFileType === 'mts' ||
659
- foundNextConfigFileType === 'cts' ||
660
- foundNextConfigFileType === 'ts'
661
- ) {
662
- const nextConfigMjsContent = fs.readFileSync(
663
- path.join(process.cwd(), foundNextConfigFileFilename),
664
- 'utf8',
665
- );
666
-
667
- const probablyIncludesSdk =
668
- nextConfigMjsContent.includes('@sentry/nextjs') &&
669
- nextConfigMjsContent.includes('withSentryConfig');
670
-
671
- let shouldInject = true;
672
-
673
- if (probablyIncludesSdk) {
674
- const injectAnyhow = await abortIfCancelled(
675
- clack.confirm({
676
- message: `${chalk.cyan(
677
- foundNextConfigFileFilename,
678
- )} already contains Sentry SDK configuration. Should the wizard modify it anyways?`,
679
- }),
680
- );
681
-
682
- shouldInject = injectAnyhow;
683
- }
684
-
685
- try {
686
- if (shouldInject) {
687
- const mod = parseModule(nextConfigMjsContent);
688
- mod.imports.$add({
689
- from: '@sentry/nextjs',
690
- imported: 'withSentryConfig',
691
- local: 'withSentryConfig',
692
- });
693
- // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
694
- const expressionToWrap = generateCode(mod.exports.default.$ast).code;
695
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
696
- mod.exports.default = builders.raw(`withSentryConfig(
697
- ${expressionToWrap},
698
- ${withSentryConfigOptionsTemplate}
699
- )`);
700
- const newCode = mod.generate().code;
701
-
702
- await fs.promises.writeFile(
703
- path.join(process.cwd(), foundNextConfigFileFilename),
704
- newCode,
705
- {
706
- encoding: 'utf8',
707
- flag: 'w',
708
- },
709
- );
710
- clack.log.success(
711
- `Added Sentry configuration to ${chalk.cyan(
712
- foundNextConfigFileFilename,
713
- )}. ${chalk.dim('(you probably want to clean this up a bit!)')}`,
714
- );
715
-
716
- Sentry.setTag('next-config-mod-result', 'success');
717
- }
718
- } catch {
719
- Sentry.setTag('next-config-mod-result', 'fail');
720
- clack.log.warn(
721
- chalk.yellow(
722
- `Something went wrong writing to ${chalk.cyan(
723
- foundNextConfigFileFilename,
724
- )}.`,
725
- ),
726
- );
727
- clack.log.info(
728
- `Please put the following code snippet into ${chalk.cyan(
729
- foundNextConfigFileFilename,
730
- )}: ${chalk.dim('You probably have to clean it up a bit.')}\n`,
731
- );
732
-
733
- // eslint-disable-next-line no-console
734
- console.log(
735
- getNextjsConfigEsmCopyPasteSnippet(withSentryConfigOptionsTemplate),
736
- );
737
-
738
- const shouldContinue = await abortIfCancelled(
739
- clack.confirm({
740
- message: `Are you done putting the snippet above into ${chalk.cyan(
741
- foundNextConfigFileFilename,
742
- )}?`,
743
- active: 'Yes',
744
- inactive: 'No, get me out of here',
745
- }),
746
- );
747
-
748
- if (!shouldContinue) {
749
- await abort();
750
- }
751
- }
752
- }
753
- });
754
- }
755
-
756
- function hasDirectoryPathFromRoot(dirnameOrDirs: string | string[]): boolean {
757
- const dirPath = Array.isArray(dirnameOrDirs)
758
- ? path.join(process.cwd(), ...dirnameOrDirs)
759
- : path.join(process.cwd(), dirnameOrDirs);
760
-
761
- return fs.existsSync(dirPath) && fs.lstatSync(dirPath).isDirectory();
762
- }
763
-
764
- async function createExamplePage(
765
- selfHosted: boolean,
766
- selectedProject: SentryProjectData,
767
- sentryUrl: string,
768
- ): Promise<void> {
769
- const hasSrcDirectory = hasDirectoryPathFromRoot('src');
770
- const hasRootAppDirectory = hasDirectoryPathFromRoot('app');
771
- const hasRootPagesDirectory = hasDirectoryPathFromRoot('pages');
772
- const hasSrcAppDirectory = hasDirectoryPathFromRoot(['src', 'app']);
773
- const hasSrcPagesDirectory = hasDirectoryPathFromRoot(['src', 'pages']);
774
-
775
- Sentry.setTag('nextjs-app-dir', hasRootAppDirectory || hasSrcAppDirectory);
776
-
777
- const typeScriptDetected = isUsingTypeScript();
778
-
779
- // If `pages` or an `app` directory exists in the root, we'll put the example page there.
780
- // `app` directory takes priority over `pages` directory when they coexist, so we prioritize that.
781
- // https://nextjs.org/docs/app/building-your-application/routing#the-app-router
782
-
783
- const appFolderLocation = hasRootAppDirectory
784
- ? ['app']
785
- : hasSrcAppDirectory
786
- ? ['src', 'app']
787
- : undefined;
788
-
789
- let pagesFolderLocation = hasRootPagesDirectory
790
- ? ['pages']
791
- : hasSrcPagesDirectory
792
- ? ['src', 'pages']
793
- : undefined;
794
-
795
- // If the user has neither pages nor app directory we create a pages folder for them
796
- if (!appFolderLocation && !pagesFolderLocation) {
797
- const newPagesFolderLocation = hasSrcDirectory
798
- ? ['src', 'pages']
799
- : ['pages'];
800
- fs.mkdirSync(path.join(process.cwd(), ...newPagesFolderLocation), {
801
- recursive: true,
802
- });
803
-
804
- pagesFolderLocation = newPagesFolderLocation;
805
- }
806
-
807
- if (appFolderLocation) {
808
- const examplePageContents = getSentryExamplePageContents({
809
- selfHosted,
810
- orgSlug: selectedProject.organization.slug,
811
- projectId: selectedProject.id,
812
- sentryUrl,
813
- useClient: true,
814
- });
815
-
816
- fs.mkdirSync(
817
- path.join(process.cwd(), ...appFolderLocation, 'sentry-example-page'),
818
- {
819
- recursive: true,
820
- },
821
- );
822
-
823
- const newPageFileName = `page.${typeScriptDetected ? 'tsx' : 'jsx'}`;
824
-
825
- await fs.promises.writeFile(
826
- path.join(
827
- process.cwd(),
828
- ...appFolderLocation,
829
- 'sentry-example-page',
830
- newPageFileName,
831
- ),
832
- examplePageContents,
833
- { encoding: 'utf8', flag: 'w' },
834
- );
835
-
836
- clack.log.success(
837
- `Created ${chalk.cyan(
838
- path.join(...appFolderLocation, 'sentry-example-page', newPageFileName),
839
- )}.`,
840
- );
841
-
842
- fs.mkdirSync(
843
- path.join(
844
- process.cwd(),
845
- ...appFolderLocation,
846
- 'api',
847
- 'sentry-example-api',
848
- ),
849
- {
850
- recursive: true,
851
- },
852
- );
853
-
854
- const newRouteFileName = `route.${typeScriptDetected ? 'ts' : 'js'}`;
855
-
856
- await fs.promises.writeFile(
857
- path.join(
858
- process.cwd(),
859
- ...appFolderLocation,
860
- 'api',
861
- 'sentry-example-api',
862
- newRouteFileName,
863
- ),
864
- getSentryExampleAppDirApiRoute(),
865
- { encoding: 'utf8', flag: 'w' },
866
- );
867
-
868
- clack.log.success(
869
- `Created ${chalk.cyan(
870
- path.join(
871
- ...appFolderLocation,
872
- 'api',
873
- 'sentry-example-api',
874
- newRouteFileName,
875
- ),
876
- )}.`,
877
- );
878
- } else if (pagesFolderLocation) {
879
- const examplePageContents = getSentryExamplePageContents({
880
- selfHosted,
881
- orgSlug: selectedProject.organization.slug,
882
- projectId: selectedProject.id,
883
- sentryUrl,
884
- useClient: false,
885
- });
886
-
887
- await fs.promises.writeFile(
888
- path.join(
889
- process.cwd(),
890
- ...pagesFolderLocation,
891
- 'sentry-example-page.jsx',
892
- ),
893
- examplePageContents,
894
- { encoding: 'utf8', flag: 'w' },
895
- );
896
-
897
- clack.log.success(
898
- `Created ${chalk.cyan(
899
- path.join(...pagesFolderLocation, 'sentry-example-page.js'),
900
- )}.`,
901
- );
902
-
903
- fs.mkdirSync(path.join(process.cwd(), ...pagesFolderLocation, 'api'), {
904
- recursive: true,
905
- });
906
-
907
- await fs.promises.writeFile(
908
- path.join(
909
- process.cwd(),
910
- ...pagesFolderLocation,
911
- 'api',
912
- 'sentry-example-api.js',
913
- ),
914
- getSentryExamplePagesDirApiRoute(),
915
- { encoding: 'utf8', flag: 'w' },
916
- );
917
-
918
- clack.log.success(
919
- `Created ${chalk.cyan(
920
- path.join(...pagesFolderLocation, 'api', 'sentry-example-api.js'),
921
- )}.`,
922
- );
923
- }
924
- }
925
-
926
- /**
927
- * Ask users if they want to set the tunnelRoute option.
928
- * We can't set this by default because it potentially increases hosting bills.
929
- * It's valuable enough to for users to justify asking the additional question.
930
- */
931
- async function askShouldSetTunnelRoute() {
932
- return await traceStep('ask-tunnelRoute-option', async (span) => {
933
- const shouldSetTunnelRoute = await abortIfCancelled(
934
- clack.select({
935
- message:
936
- 'Do you want to route Sentry requests in the browser through your Next.js server to avoid ad blockers?',
937
- options: [
938
- {
939
- label: 'Yes',
940
- value: true,
941
- hint: 'Can increase your server load and hosting bill',
942
- },
943
- {
944
- label: 'No',
945
- value: false,
946
- hint: 'Browser errors and events might be blocked by ad blockers before being sent to Sentry',
947
- },
948
- ],
949
- initialValue: true,
950
- }),
951
- );
952
-
953
- if (!shouldSetTunnelRoute) {
954
- clack.log.info(
955
- "Sounds good! We'll leave the option commented for later, just in case :)",
956
- );
957
- }
958
-
959
- span?.setAttribute('tunnelRoute', shouldSetTunnelRoute);
960
- Sentry.setTag('tunnelRoute', shouldSetTunnelRoute);
961
-
962
- return shouldSetTunnelRoute;
963
- });
964
- }
965
-
966
- async function askShouldEnableReactComponentAnnotation() {
967
- return await traceStep('ask-react-component-annotation-option', async () => {
968
- const shouldEnableReactComponentAnnotation = await abortIfCancelled(
969
- clack.select({
970
- message:
971
- 'Do you want to enable React component annotations to make breadcrumbs and session replays more readable?',
972
- options: [
973
- {
974
- label: 'Yes',
975
- value: true,
976
- hint: 'Annotates React component names - increases bundle size',
977
- },
978
- {
979
- label: 'No',
980
- value: false,
981
- hint: 'Continue without React component annotations',
982
- },
983
- ],
984
- initialValue: true,
985
- }),
986
- );
987
-
988
- return shouldEnableReactComponentAnnotation;
989
- });
990
- }
991
-
992
- /**
993
- * Returns true or false depending on whether we think the user is using Turbopack. May return null in case we aren't sure.
994
- */
995
- async function checkIfLikelyIsUsingTurbopack(): Promise<boolean | null> {
996
- let packageJsonContent: string;
997
- try {
998
- packageJsonContent = await fs.promises.readFile(
999
- path.join(process.cwd(), 'package.json'),
1000
- 'utf8',
1001
- );
1002
- } catch {
1003
- return null;
1004
- }
1005
-
1006
- return packageJsonContent.includes('--turbo');
1007
- }