diff --git a/.eslintrc.json b/.eslintrc.json index 6591a21f..e71c4f94 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -35,7 +35,6 @@ "@typescript-eslint/no-misused-new": "error", "@typescript-eslint/no-namespace": "error", "@typescript-eslint/no-non-null-assertion": "warn", - "@typescript-eslint/no-object-literal-type-assertion": "error", "@typescript-eslint/no-unnecessary-qualifier": "error", "@typescript-eslint/no-unnecessary-type-assertion": "error", "@typescript-eslint/no-useless-constructor": "error", @@ -43,7 +42,6 @@ "@typescript-eslint/prefer-for-of": "warn", "@typescript-eslint/prefer-function-type": "warn", "@typescript-eslint/prefer-includes": "error", - "@typescript-eslint/prefer-interface": "error", "@typescript-eslint/prefer-string-starts-ends-with": "error", "@typescript-eslint/promise-function-async": "error", "@typescript-eslint/require-array-sort-compare": "error", diff --git a/src/constants.ts b/src/constants.ts index 695bda03..57028b1b 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -32,7 +32,7 @@ export interface ActionInterface { isTest?: string | undefined | null /** The git config name. */ name?: string - /** The repository path, for example JamesIves/github-pages-deploy-action */ + /** The repository path, for example JamesIves/github-pages-deploy-action. */ repositoryName?: string /** The fully qualified repositpory path, this gets auto generated if repositoryName is provided. */ repositoryPath?: string diff --git a/src/execute.ts b/src/execute.ts index 8a699209..88ad1573 100644 --- a/src/execute.ts +++ b/src/execute.ts @@ -4,9 +4,9 @@ let output: string /** Wrapper around the GitHub toolkit exec command which returns the output. * Also allows you to easily toggle the current working directory. - * @param cmd = The command to execute. - * @param cwd - The current working directory. - * @returns - The output from the command. + * + * @param {string} cmd - The command to execute. + * @param {string} cwd - The current working directory. */ export async function execute(cmd: string, cwd: string): Promise { output = '' diff --git a/src/lib.ts b/src/lib.ts index 6289917f..6f726e80 100644 --- a/src/lib.ts +++ b/src/lib.ts @@ -3,7 +3,10 @@ import {action, ActionInterface} from './constants' import {deploy, generateBranch, init} from './git' import {generateRepositoryPath, generateTokenType} from './util' -/** Initializes and runs the action. */ +/** Initializes and runs the action. + * + * @param {object} configuration - The action configuration. + */ export default async function run( configuration: ActionInterface ): Promise {