Place exports at top and rename cert path to be stack agnostic.

halfnibble · halfnibble · commit c2e2bab695d2 · 2020-01-15T18:38:43.000-08:00
diff --git a/common/reviews/api/debug-certificate-manager.api.md b/common/reviews/api/debug-certificate-manager.api.md
@@ -17,7 +17,7 @@ export class CertificateStore {
     }
 
 // @public
-export function ensureCertificate(canGenerateNewCertificate: boolean, parentTask: ILogging): ICertificate;
+export function ensureCertificate(canGenerateNewCertificate: boolean, parentLogger: ILogging): ICertificate;
 
 // @public (undocumented)
 export interface ICertificate {
@@ -39,8 +39,8 @@ export interface ILogging {
     logWarning: (string: any) => void;
 }
 
-// @public (undocumented)
-export function untrustCertificate(parentTask: ILogging): boolean;
+// @public
+export function untrustCertificate(parentLogger: ILogging): boolean;
 
 
 // (No @packageDocumentation comment for this package)
diff --git a/core-build/gulp-core-build-serve/README.md b/core-build/gulp-core-build-serve/README.md
@@ -121,7 +121,7 @@ The certificate is generated and self-signed with a unique private key and an at
 it (Windows and macOS only). If the user does not agree to trust the certificate, provides invalid root
 credentials, or something else goes wrong, the `TrustCertTask` will fail and the `ServeTask` will serve
 with the default, non-trusted certificate. If trust succeeds, the certificate and the private key are
-dropped in the `.gcb-serve-data` directory in the user's home folder in `PEM` format. On platforms
+dropped in the `.rushstack-serve-data` directory in the user's home folder in `PEM` format. On platforms
 other than Windows and macOS, the certificate and key are always dropped in that directory, and the user
 must trust the certificate manually.
 
@@ -134,6 +134,6 @@ signature is found by its serial number and then the certificate is deleted from
 signature. Regardless of whether the untrust succeeds or not, the certificate and key are deleted
 from the user's home directory.
 
-To manually untrust the certificate, delete the files in the `.gcb-serve-data` directory under your
+To manually untrust the certificate, delete the files in the `.rushstack-serve-data` directory under your
 home directory and untrust the certificate with the
 `73 1c 32 17 44 e3 46 50 a2 02 e3 ef 91 c3 c1 b9` serial number.
diff --git a/libraries/debug-certificate-manager/src/CertificateStore.ts b/libraries/debug-certificate-manager/src/CertificateStore.ts
@@ -22,7 +22,7 @@ export class CertificateStore {
   }
 
   private _userProfilePath: string;
-  private _gcbServeDataPath: string;
+  private _serveDataPath: string;
   private _certificatePath: string;
   private _keyPath: string;
 
@@ -84,10 +84,10 @@ export class CertificateStore {
       throw new Error('Unable to determine the current user\'s home directory');
     }
 
-    this._gcbServeDataPath = path.join(this._userProfilePath, '.gcb-serve-data');
-    FileSystem.ensureFolder(this._gcbServeDataPath);
+    this._serveDataPath = path.join(this._userProfilePath, '.rushstack-serve-data');
+    FileSystem.ensureFolder(this._serveDataPath);
 
-    this._certificatePath = path.join(this._gcbServeDataPath, 'gcb-serve.cer');
-    this._keyPath = path.join(this._gcbServeDataPath, 'gcb-serve.key');
+    this._certificatePath = path.join(this._serveDataPath, 'rushstack-serve.pem');
+    this._keyPath = path.join(this._serveDataPath, 'rushstack-serve.key');
   }
 }
diff --git a/libraries/debug-certificate-manager/src/certificates.ts b/libraries/debug-certificate-manager/src/certificates.ts

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ export class CertificateStore {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`// @public`
`20`		`-export function ensureCertificate(canGenerateNewCertificate: boolean, parentTask: ILogging): ICertificate;`
	`20`	`+export function ensureCertificate(canGenerateNewCertificate: boolean, parentLogger: ILogging): ICertificate;`
`21`	`21`
`22`	`22`	`// @public (undocumented)`
`23`	`23`	`export interface ICertificate {`
`@@ -39,8 +39,8 @@ export interface ILogging {`
`39`	`39`	`logWarning: (string: any) => void;`
`40`	`40`	`}`
`41`	`41`
`42`		`-// @public (undocumented)`
`43`		`-export function untrustCertificate(parentTask: ILogging): boolean;`
	`42`	`+// @public`
	`43`	`+export function untrustCertificate(parentLogger: ILogging): boolean;`
`44`	`44`
`45`	`45`
`46`	`46`	`// (No @packageDocumentation comment for this package)`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ export class CertificateStore {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`private _userProfilePath: string;`
`25`		`- private _gcbServeDataPath: string;`
	`25`	`+ private _serveDataPath: string;`
`26`	`26`	`private _certificatePath: string;`
`27`	`27`	`private _keyPath: string;`
`28`	`28`
`@@ -84,10 +84,10 @@ export class CertificateStore {`
`84`	`84`	`throw new Error('Unable to determine the current user\'s home directory');`
`85`	`85`	`}`
`86`	`86`
`87`		`- this._gcbServeDataPath = path.join(this._userProfilePath, '.gcb-serve-data');`
`88`		`- FileSystem.ensureFolder(this._gcbServeDataPath);`
	`87`	`+ this._serveDataPath = path.join(this._userProfilePath, '.rushstack-serve-data');`
	`88`	`+ FileSystem.ensureFolder(this._serveDataPath);`
`89`	`89`
`90`		`- this._certificatePath = path.join(this._gcbServeDataPath, 'gcb-serve.cer');`
`91`		`- this._keyPath = path.join(this._gcbServeDataPath, 'gcb-serve.key');`
	`90`	`+ this._certificatePath = path.join(this._serveDataPath, 'rushstack-serve.pem');`
	`91`	`+ this._keyPath = path.join(this._serveDataPath, 'rushstack-serve.key');`
`92`	`92`	`}`
`93`	`93`	`}`