chore: reworking how we deal with exporting things from the main package

packages/backend-common/src/index.ts

@@ -24,3 +24,4 @@ export * from './reading';
 export * from './service';
 export * from './paths';
 export * from './hot';
+export * from './scm';

packages/backend-common/src/scm/git.ts

@@ -18,11 +18,19 @@ import http from 'isomorphic-git/http/node';
 import fs from 'fs-extra';
 import { Logger } from 'winston';
 
+/*
+provider    username  	    password
+GitHub      token	          'x-oauth-basic'
+GitHub App 	token	          'x-access-token'
+BitBucket	  'x-token-auth'	token
+GitLab      'oauth2'	      token
+From : https://isomorphic-git.org/docs/en/onAuth
+*/
 class SCM {
   constructor(
     private readonly config: {
-      username: string;
-      password: string;
+      username?: string;
+      password?: string;
       logger?: Logger;
     },
   ) {}
@@ -126,14 +134,15 @@ class SCM {
   }
 }
 
+// TODO(blam): This could potentially become something like for URL
+// and use the integrations config for URLReading instead.
+// But for now, I don't want to do all that in this PR.
 export const fromAuth = ({
   username,
   password,
   logger,
 }: {
-  username: string;
-  password: string;
+  username?: string;
+  password?: string;
   logger?: Logger;
-}) => {
-  return new SCM({ username, password, logger });
-};
+}) => new SCM({ username, password, logger });

packages/backend-common/src/scm/index.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * as Git from './git';