Merge pull request #191 from xt0rted/version-support

More easily support new `dotnet-format` versions

Author: xt0rted

CHANGELOG.md

@@ -5,6 +5,8 @@
 - Bumped `@actions/core` from 1.2.6 to 1.2.7
 - Bumped `@actions/io` from 1.0.2 to 1.1.0
 - Updated the `repo-token` input to be optional and defaulted it to `GITHUB_TOKEN`. If you're already using this value, or not using the `only-changed-files` option, you can remove this setting from your workflow.
+- Updated the output target from `es6` to `es2019`
+- Added a new `version` input to allow picking the cli version of `dotnet-format` to use. Currently this defaults to `3` and is the only version supported. A future update will add support for versions 4 and 5.
 
 ## Version 1.1.0
 

README.md

@@ -160,12 +160,13 @@ jobs:
 Name | Allowed values | Description
 -- | -- | --
 `repo-token` | `GITHUB_TOKEN` (default) or PAT | `GITHUB_TOKEN` token or a repo scoped PAT.
+`version` | `3` (default) | Version of `dotnet-format` to use.
+`action` | `check` (default), `fix` | Primary action `dotnet-format` should perform.
 
 ### Optional
 
 Name | Allowed values | Description
 -- | -- | --
-`action` | `check` (default), `fix` | Primary action `dotnet-format` should perform.
 `only-changed-files` | `true`, `false` (default) | Only changed files in the current pull request should be formatted.
 `fail-fast` | `true` (default), `false` | The job should fail if there's a formatting error. Only used with the `check` action.
 

action.yml

@@ -14,9 +14,14 @@ inputs:
     required: true
     default: ${{ github.token }}
 
+  version:
+    description: "Version of dotnet-format to use"
+    required: true
+    default: "3"
+
   action:
     description: "Primary action dotnet-format should perform (check for errors or apply fixes)"
-    required: false
+    required: true
     default: "check"
 
   only-changed-files:

src/actions.ts

@@ -4,12 +4,16 @@ import {
 } from "@actions/core";
 
 import { format } from "./dotnet";
+import { checkVersion } from "./version";
 
 export async function check(): Promise<void> {
   const onlyChangedFiles = getInput("only-changed-files") === "true";
   const failFast = getInput("fail-fast") === "true";
+  const version = getInput("version", { required: true });
 
-  const result = await format({
+  const dotnetFormatVersion = checkVersion(version);
+
+  const result = await format(dotnetFormatVersion)({
     dryRun: true,
     onlyChangedFiles,
   });
@@ -24,8 +28,11 @@ export async function check(): Promise<void> {
 
 export async function fix(): Promise<void> {
   const onlyChangedFiles = getInput("only-changed-files") === "true";
+  const version = getInput("version", { required: true });
+
+  const dotnetFormatVersion = checkVersion(version);
 
-  const result = await format({
+  const result = await format(dotnetFormatVersion)({
     dryRun: false,
     onlyChangedFiles,
   });

src/dotnet.ts

@@ -11,6 +11,10 @@ import { getPullRequestFiles } from "./files";
 
 import type { ExecOptions } from "@actions/exec/lib/interfaces";
 
+import type { DotNetFormatVersion } from "./version";
+
+export type FormatFunction = (options: FormatOptions) => Promise<boolean>;
+
 export interface FormatOptions {
   dryRun: boolean;
   onlyChangedFiles: boolean;
@@ -30,7 +34,7 @@ function formatOnlyChangedFiles(onlyChangedFiles: boolean): boolean {
   return false;
 }
 
-export async function format(options: FormatOptions): Promise<boolean> {
+async function formatVersion3(options: FormatOptions): Promise<boolean> {
   const execOptions: ExecOptions = { ignoreReturnCode: true };
 
   const dotnetFormatOptions = ["format", "--check"];
@@ -58,3 +62,13 @@ export async function format(options: FormatOptions): Promise<boolean> {
 
   return !!dotnetResult;
 }
+
+export function format(version: DotNetFormatVersion): FormatFunction {
+  switch (version || "") {
+    case "3":
+      return formatVersion3;
+
+    default:
+      throw Error(`dotnet-format version "${version}" is unsupported`);
+  }
+}

src/version.ts

@@ -0,0 +1,18 @@
+export type DotNetFormatVersion =
+  | "3"
+;
+
+const supportedVersions: DotNetFormatVersion[] = [
+  "3",
+];
+
+export function checkVersion(version: string): DotNetFormatVersion {
+  for (let i = 0; i < supportedVersions.length; i++) {
+    const ver = supportedVersions[i];
+    if (ver === version) {
+      return version;
+    }
+  }
+
+  throw Error(`dotnet-format version "${version}" is unsupported`);
+}