refactor: stricter releaseType typing (googleapis#745)

Author: joeldodge79

.eslintrc.json

@@ -1,3 +1,9 @@
 {
-  "extends": "./node_modules/gts"
+  "extends": "./node_modules/gts",
+  "rules": {
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {"argsIgnorePattern": "^_", "varsIgnorePattern": "^_$"}
+    ]
+  }
 }

src/bin/release-please.ts

@@ -19,7 +19,7 @@ import {coerceOption} from '../util/coerce-option';
 import {GitHubReleaseOptions} from '../github-release';
 import {ReleasePROptions} from '../release-pr';
 import {factory} from '../factory';
-import {getReleaserNames} from '../releasers';
+import {getReleaserTypes, ReleaseType} from '../releasers';
 import * as yargs from 'yargs';
 
 interface ErrorObject {
@@ -31,7 +31,7 @@ interface ErrorObject {
 
 interface YargsOptions {
   describe: string;
-  choices?: string[];
+  choices?: readonly ReleaseType[];
   demand?: boolean;
   type?: string;
   default?: string | boolean;
@@ -113,7 +113,7 @@ export const parser = yargs
   })
   .option('release-type', {
     describe: 'what type of repo is a release being created for?',
-    choices: getReleaserNames(),
+    choices: getReleaserTypes(),
     default: 'node',
   })
   .option('bump-minor-pre-major', {

src/factory.ts

@@ -22,7 +22,7 @@ import {
   GitHubRelease,
   ReleaseResponse,
 } from './github-release';
-import {getReleasers} from './releasers';
+import {ReleaseType, getReleasers} from './releasers';
 
 function runCommand(
   command: string,
@@ -55,7 +55,7 @@ function releasePR(options: ReleasePROptions): ReleasePR {
   return new (factory.releasePRClass(options.releaseType))(releaseOptions);
 }
 
-export function releasePRClass(releaseType: string): typeof ReleasePR {
+export function releasePRClass(releaseType: ReleaseType): typeof ReleasePR {
   const releasers = getReleasers();
   const releaser = releasers[releaseType];
   if (!releaser) {

src/github-release.ts

@@ -19,6 +19,7 @@ import {factory} from './factory';
 import {GitHub, OctokitAPIs} from './github';
 import {parse} from 'semver';
 import {ReleasePR} from './release-pr';
+import {ReleaseType} from './releasers';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const parseGithubRepoUrl = require('parse-github-repo-url');
@@ -38,7 +39,7 @@ export interface ReleaseResponse {
 }
 
 export interface GitHubReleaseOptions extends SharedOptions {
-  releaseType?: string;
+  releaseType?: ReleaseType;
   changelogPath?: string;
   draft?: boolean;
   defaultBranch?: string;
@@ -54,7 +55,7 @@ export class GitHubRelease {
   packageName?: string;
   monorepoTags?: boolean;
   token?: string;
-  releaseType?: string;
+  releaseType?: ReleaseType;
   draft: boolean;
   defaultBranch?: string;
 
@@ -108,7 +109,7 @@ export class GitHubRelease {
         })
       : new ReleasePR({
           ...releaseOptions,
-          ...{releaseType: 'unknown'},
+          ...{releaseType: 'base'},
         });
 
     const candidate = await releasePR.buildRelease(

src/index.ts

@@ -30,7 +30,7 @@ export interface SharedOptions {
 }
 
 export {factory} from './factory';
-export {getReleaserNames, getReleasers} from './releasers';
+export {getReleaserTypes, getReleasers} from './releasers';
 export {GitHubRelease, GitHubReleaseOptions} from './github-release';
 export {JavaYoshi} from './releasers/java-yoshi';
 export {Ruby} from './releasers/ruby';

src/release-pr.ts

@@ -31,6 +31,7 @@ import {Commit} from './graphql-to-commits';
 import {Update} from './updaters/update';
 import {BranchName} from './util/branch-name';
 import {extractReleaseNotes} from './util/release-notes';
+import {ReleaseType} from './releasers';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const parseGithubRepoUrl = require('parse-github-repo-url');
@@ -51,7 +52,7 @@ export interface ReleasePROptions extends SharedOptions {
   octokitAPIs?: OctokitAPIs;
   // Path to version.rb file
   versionFile?: string;
-  releaseType: string;
+  releaseType: ReleaseType;
   changelogSections?: [];
   // Optionally provide GitHub instance
   github?: GitHub;
@@ -87,8 +88,6 @@ export interface OpenPROptions {
 }
 
 export class ReleasePR {
-  static releaserName = 'base';
-
   apiUrl: string;
   defaultBranch?: string;
   labels: string[];
@@ -197,10 +196,8 @@ export class ReleasePR {
   // the release name when creating a GitHub release, for instance by returning
   // name in package.json, or setup.py.
   static async lookupPackageName(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    gh: GitHub,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    path?: string
+    _gh: GitHub,
+    _path?: string
   ): Promise<string | undefined> {
     return Promise.resolve(undefined);
   }
@@ -292,7 +289,6 @@ export class ReleasePR {
 
   // Override this method to detect the release version from code (if it cannot be
   // inferred from the release PR head branch)
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   protected detectReleaseVersionFromTitle(title: string): string | undefined {
     const pattern = /^chore: release ?(?<component>.*) (?<version>\d+\.\d+\.\d+)$/;
     const match = title.match(pattern);
@@ -317,7 +313,7 @@ export class ReleasePR {
 
   // Override this method to modify the pull request body
   protected async buildPullRequestBody(
-    version: string,
+    _version: string,
     changelogEntry: string
   ): Promise<string> {
     return `:robot: I have created a release \\*beep\\* \\*boop\\* \n---\n${changelogEntry}\n\nThis PR was generated with [Release Please](https://github.com/googleapis/${RELEASE_PLEASE}). See [documentation](https://github.com/googleapis/${RELEASE_PLEASE}#${RELEASE_PLEASE}).`;

src/releasers/go-yoshi.ts

@@ -47,14 +47,12 @@ const SUB_MODULES = [
 const REGEN_PR_REGEX = /.*auto-regenerate.*/;
 
 export class GoYoshi extends ReleasePR {
-  static releaserName = 'go-yoshi';
   protected async _run(): Promise<number | undefined> {
     const latestTag = await this.gh.latestTag(
       this.monorepoTags ? `${this.packageName}-` : undefined,
       false
     );
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const [_owner, repo] = parseGithubRepoUrl(this.repoUrl);
+    const [_, repo] = parseGithubRepoUrl(this.repoUrl);
     let regenPR: Commit | undefined;
     let sha: null | string = null;
     const commits = (

src/releasers/index.ts

@@ -27,30 +27,55 @@ import {TerraformModule} from './terraform-module';
 import {Rust} from './rust';
 import {OCaml} from './ocaml';
 
-// TODO: add any new releasers you create to this list:
-export function getReleasers(): {[key: string]: typeof ReleasePR} {
-  const releasers = {
-    go: GoYoshi, // TODO(codyoss): refactor this into a more generic go strategy.
-    'go-yoshi': GoYoshi,
-    'java-bom': JavaBom,
-    'java-yoshi': JavaYoshi,
-    node: Node,
-    'php-yoshi': PHPYoshi,
-    python: Python,
-    'ruby-yoshi': RubyYoshi,
-    ruby: Ruby,
-    simple: Simple,
-    'terraform-module': TerraformModule,
-    rust: Rust,
-    ocaml: OCaml,
-  };
+// add any new releasers you create to this type as well as the `releasers`
+// object below.
+export type ReleaseType =
+  | 'base' // not exposed to end users
+  | 'go'
+  | 'go-yoshi'
+  | 'java-bom'
+  | 'java-yoshi'
+  | 'node'
+  | 'ocaml'
+  | 'php-yoshi'
+  | 'python'
+  | 'ruby'
+  | 'ruby-yoshi'
+  | 'rust'
+  | 'simple'
+  | 'terraform-module';
+
+type Releasers = Partial<Record<ReleaseType, typeof ReleasePR>>;
+
+const releasers: Releasers = {
+  go: GoYoshi, // TODO(codyoss): refactor this into a more generic go strategy.
+  'go-yoshi': GoYoshi,
+  'java-bom': JavaBom,
+  'java-yoshi': JavaYoshi,
+  node: Node,
+  ocaml: OCaml,
+  'php-yoshi': PHPYoshi,
+  python: Python,
+  ruby: Ruby,
+  'ruby-yoshi': RubyYoshi,
+  rust: Rust,
+  simple: Simple,
+  'terraform-module': TerraformModule,
+};
+
+export function getReleasers(): Releasers {
   return releasers;
 }
 
+// deprecated, use getReleaserTypes
 export function getReleaserNames(): string[] {
-  const releasers = getReleasers();
-  return Object.keys(releasers).map(key => {
-    const releaser = releasers[key];
-    return releaser.releaserName;
-  });
+  return getReleaserTypes() as string[];
+}
+
+export function getReleaserTypes(): readonly ReleaseType[] {
+  const names: ReleaseType[] = [];
+  for (const releaseType of Object.keys(releasers)) {
+    names.push(releaseType as ReleaseType);
+  }
+  return names;
 }

src/releasers/java-bom.ts

@@ -47,7 +47,6 @@ const DEPENDENCY_UPDATE_REGEX = /^deps: update dependency (.*) to (v.*)(\s\(#\d+
 const DEPENDENCY_PATCH_VERSION_REGEX = /^v\d+\.\d+\.[1-9]\d*(-.*)?/;
 
 export class JavaBom extends ReleasePR {
-  static releaserName = 'java-bom';
   protected async _run(): Promise<number | undefined> {
     const versionsManifestContent = await this.gh.getFileContents(
       'versions.txt'

src/releasers/java-yoshi.ts

@@ -49,7 +49,6 @@ const CHANGELOG_SECTIONS = [
 ];
 
 export class JavaYoshi extends ReleasePR {
-  static releaserName = 'java-yoshi';
   protected async _run(): Promise<number | undefined> {
     const versionsManifestContent = await this.gh.getFileContents(
       'versions.txt'
@@ -295,7 +294,7 @@ export class JavaYoshi extends ReleasePR {
   // If you modify this, you must ensure that the releaser can parse the tag version
   // from the pull request.
   protected async buildBranchName(
-    version: string,
+    _version: string,
     includePackageName: boolean
   ): Promise<BranchName> {
     const defaultBranch = await this.getDefaultBranch();
@@ -321,7 +320,6 @@ export class JavaYoshi extends ReleasePR {
 
   // Override this method to detect the release version from code (if it cannot be
   // inferred from the release PR head branch)
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   protected detectReleaseVersionFromTitle(title: string): string | undefined {
     const pattern = /^chore\((?<branch>[^(]+)\): release ?(?<component>.*) (?<version>\d+\.\d+\.\d+)$/;
     const match = title.match(pattern);