add sentry dart plugin options and propeties to pubspec file

src/flutter/code-tools.ts

@@ -6,6 +6,8 @@ import * as clack from '@clack/prompts';
 import chalk from 'chalk';
 import {
   sentryImport,
+  pubspecOptions,
+  sentryProperties,
   // testErrorSnippet,
 } from './templates';
 
@@ -35,7 +37,7 @@ export function findFile(dir: string, name: string): string | null {
   return null;
 }
 
-export function patchPubspec(pubspecFile: string | null): boolean {
+export function patchPubspec(pubspecFile: string | null, project: string, org: string): boolean {
   if (!pubspecFile || !fs.existsSync(pubspecFile)) {
     clack.log.warn('No pubspec.yaml source file found in filesystem.');
     Sentry.captureException('No pubspec.yaml source file');
@@ -45,21 +47,58 @@ export function patchPubspec(pubspecFile: string | null): boolean {
 
   const dependenciesIndex = getDependenciesLocation(pubspecContent);
 
+  // TODO: Check if already added sentry:
+
   pubspecContent = pubspecContent.slice(0, dependenciesIndex) +
     '  sentry:\n' +
     pubspecContent.slice(dependenciesIndex);
 
   const devDependenciesIndex = getDevDependenciesLocation(pubspecContent);
 
+  // TODO: Check if already added sentry-dart-plugin:
+
   pubspecContent = pubspecContent.slice(0, devDependenciesIndex) +
     '  sentry-dart-plugin:\n' +
     pubspecContent.slice(devDependenciesIndex);
+
+  // TODO: Check if already added sentry:
+
+  pubspecContent += '\n'
+  pubspecContent += pubspecOptions(project, org);
 
   fs.writeFileSync(pubspecFile, pubspecContent, 'utf8');
 
   return true;
 }
 
+export function addProperties(pubspecFile: string | null, authToken: string) {
+  if (!pubspecFile || !fs.existsSync(pubspecFile)) {
+    clack.log.warn('No pubspec.yaml source file found in filesystem.');
+    Sentry.captureException('No pubspec.yaml source file');
+    return false;
+  }
+
+  try {
+    const pubspecDir = path.dirname(pubspecFile);
+    const sentryPropertiesFileName = 'sentry.properties';
+    const sentryPropertiesFile = path.join(pubspecDir, sentryPropertiesFileName);
+    const sentryPropertiesContent = sentryProperties(authToken);
+
+    fs.writeFileSync(sentryPropertiesFile, sentryPropertiesContent, 'utf8');
+
+    const gitignoreFile = path.join(pubspecDir, '.gitignore');
+    if (fs.existsSync(gitignoreFile)) {
+      fs.appendFileSync(gitignoreFile, `\n${sentryPropertiesFileName}\n`);
+    } else {
+      fs.writeFileSync(gitignoreFile, `${sentryPropertiesFileName}\n`, 'utf8');
+    }
+
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
 export function patchMain(mainFile: string | null): boolean {
   if (!mainFile || !fs.existsSync(mainFile)) {
     clack.log.warn('No main.dart source file found in filesystem.');

src/flutter/flutter-wizzard.ts

@@ -45,21 +45,38 @@ async function runFlutterWizzardWithTelemetry(
 
   // const dsn = selectedProject.keys[0].dsn.public;
   const projectDir = process.cwd();
+  const pubspecFile = findFile(projectDir, 'pubspec.yaml');
 
-  // ======== STEP X. Add Sentry to pubspec.yaml ============
+  // ======== STEP X. Add Sentry and Sentry Dart Plugin to pubspec.yaml ============
   clack.log.step(
     `Adding ${chalk.bold('Sentry')} to your apps ${chalk.cyan('pubspec.yaml',)} file.`,
   );
-  const pubspecPatched = traceStep('Patch pubspec.yaml', () =>
-    codetools.patchPubspec(findFile(projectDir, 'pubspec.yaml')),
-  );
+  const pubspecPatched = codetools.patchPubspec(
+    pubspecFile,
+    selectedProject.slug,
+    selectedProject.organization.slug
+  )
   if (!pubspecPatched) {
     clack.log.warn(
       "Could not add Sentry to your apps pubspec.yaml file. You'll have to add it manually.\nPlease follow the instructions at https://docs.sentry.io/platforms/flutter/#install",
     );
   }
   Sentry.setTag('pubspec-patched', pubspecPatched);
 
+  // ======== STEP X. Add sentry.properties with auth token ============
+
+  const propertiesAdded = codetools.addProperties(pubspecFile, authToken);
+  if (!propertiesAdded) {
+    clack.log.warn(
+      `We could not add "sentry.properties" file in your project directory in order to provide an auth token for Sentry CLI. You'll have to add it manually, or you can set the SENTRY_AUTH_TOKEN environment variable instead. See https://docs.sentry.io/cli/configuration/#auth-token for more information.`,
+    );
+  } else {
+    clack.log.info(
+      `We created "sentry.properties" file in your project directory in order to provide an auth token for Sentry CLI.\nIt was also added to your ".gitignore" file.\nAt your CI enviroment, you can set the SENTRY_AUTH_TOKEN environment variable instead. See https://docs.sentry.io/cli/configuration/#auth-token for more information.`,
+    );
+  }
+  Sentry.setTag('sentry-properties-added', pubspecPatched);
+
   // ======== STEP X. Patch main.dart with setup and a test error snippet ============
   clack.log.step(
     `Patching ${chalk.bold('main.dart')} with setup and test error snippet.`,

src/flutter/templates.ts

@@ -1 +1,14 @@
-export const sentryImport = `import 'package:sentry_flutter/sentry_flutter.dart';\n`;
+export const sentryImport = `import 'package:sentry_flutter/sentry_flutter.dart';\n`;
+
+export function pubspecOptions(project: string, org: string): string {
+  return `sentry:
+  upload_source_maps: true
+  upload_sources: true
+  project: ${project}
+  org: ${org}
+`
+}
+
+export function sentryProperties(authToken: string): string {
+  return `auth_token=${authToken}`;
+}