diff --git a/__test__/input-helper.unit.test.ts b/__test__/input-helper.unit.test.ts new file mode 100644 index 0000000..6355509 --- /dev/null +++ b/__test__/input-helper.unit.test.ts @@ -0,0 +1,28 @@ +import {getInputs} from '../src/input-helper' + +describe('input-helper tests', () => { + const ORIGINAL_ENV = process.env + + beforeEach(() => { + jest.resetModules() + process.env = {...ORIGINAL_ENV} + }) + + afterAll(() => { + process.env = ORIGINAL_ENV + }) + + test('enableUrlCompletion should be false when "false" is passed', () => { + process.env['INPUT_ENABLE-URL-COMPLETION'] = 'false' + + const inputs = getInputs() + expect(inputs.enableUrlCompletion).toBe(false) + }) + + test('enableUrlCompletion should be true when "true" is passed', () => { + process.env['INPUT_ENABLE-URL-COMPLETION'] = 'true' + + const inputs = getInputs() + expect(inputs.enableUrlCompletion).toBe(true) + }) +}) diff --git a/action.yml b/action.yml index 9899483..878d62e 100644 --- a/action.yml +++ b/action.yml @@ -22,6 +22,7 @@ inputs: description: > Enables completion of relative URLs to absolute ones Default: `false` + default: "false" image-extensions: description: > File extensions that will be treated as images diff --git a/dist/index.js b/dist/index.js index b66d398..5c93eb7 100644 --- a/dist/index.js +++ b/dist/index.js @@ -128,7 +128,7 @@ function getInputs() { repository: core.getInput('repository'), shortDescription: core.getInput('short-description'), readmeFilepath: core.getInput('readme-filepath'), - enableUrlCompletion: Boolean(core.getInput('enable-url-completion')), + enableUrlCompletion: core.getBooleanInput('enable-url-completion'), imageExtensions: core.getInput('image-extensions') }; // Environment variable input alternatives and their aliases @@ -157,7 +157,8 @@ function getInputs() { inputs.readmeFilepath = process.env['README_FILEPATH']; } if (!inputs.enableUrlCompletion && process.env['ENABLE_URL_COMPLETION']) { - inputs.enableUrlCompletion = Boolean(process.env['ENABLE_URL_COMPLETION']); + inputs.enableUrlCompletion = + process.env['ENABLE_URL_COMPLETION'].toLowerCase() === 'true'; } if (!inputs.imageExtensions && process.env['IMAGE_EXTENSIONS']) { inputs.imageExtensions = process.env['IMAGE_EXTENSIONS']; @@ -166,9 +167,6 @@ function getInputs() { if (!inputs.readmeFilepath) { inputs.readmeFilepath = readmeHelper.README_FILEPATH_DEFAULT; } - if (!inputs.enableUrlCompletion) { - inputs.enableUrlCompletion = readmeHelper.ENABLE_URL_COMPLETION_DEFAULT; - } if (!inputs.imageExtensions) { inputs.imageExtensions = readmeHelper.IMAGE_EXTENSIONS_DEFAULT; } @@ -313,13 +311,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge }); }; Object.defineProperty(exports, "__esModule", ({ value: true })); -exports.completeRelativeUrls = exports.getReadmeContent = exports.ENABLE_URL_COMPLETION_DEFAULT = exports.IMAGE_EXTENSIONS_DEFAULT = exports.README_FILEPATH_DEFAULT = void 0; +exports.completeRelativeUrls = exports.getReadmeContent = exports.IMAGE_EXTENSIONS_DEFAULT = exports.README_FILEPATH_DEFAULT = void 0; const core = __importStar(__nccwpck_require__(7484)); const fs = __importStar(__nccwpck_require__(9896)); const utils = __importStar(__nccwpck_require__(9277)); exports.README_FILEPATH_DEFAULT = './README.md'; exports.IMAGE_EXTENSIONS_DEFAULT = 'bmp,gif,jpg,jpeg,png,svg,webp'; -exports.ENABLE_URL_COMPLETION_DEFAULT = false; const TITLE_REGEX = `(?: +"[^"]+")?`; const REPOSITORY_URL = `${process.env['GITHUB_SERVER_URL']}/${process.env['GITHUB_REPOSITORY']}`; const BLOB_PREFIX = `${REPOSITORY_URL}/blob/${process.env['GITHUB_REF_NAME']}/`; diff --git a/src/input-helper.ts b/src/input-helper.ts index 7093ee3..0f31920 100644 --- a/src/input-helper.ts +++ b/src/input-helper.ts @@ -18,7 +18,7 @@ export function getInputs(): Inputs { repository: core.getInput('repository'), shortDescription: core.getInput('short-description'), readmeFilepath: core.getInput('readme-filepath'), - enableUrlCompletion: Boolean(core.getInput('enable-url-completion')), + enableUrlCompletion: core.getBooleanInput('enable-url-completion'), imageExtensions: core.getInput('image-extensions') } @@ -54,7 +54,8 @@ export function getInputs(): Inputs { } if (!inputs.enableUrlCompletion && process.env['ENABLE_URL_COMPLETION']) { - inputs.enableUrlCompletion = Boolean(process.env['ENABLE_URL_COMPLETION']) + inputs.enableUrlCompletion = + process.env['ENABLE_URL_COMPLETION'].toLowerCase() === 'true' } if (!inputs.imageExtensions && process.env['IMAGE_EXTENSIONS']) { @@ -65,9 +66,6 @@ export function getInputs(): Inputs { if (!inputs.readmeFilepath) { inputs.readmeFilepath = readmeHelper.README_FILEPATH_DEFAULT } - if (!inputs.enableUrlCompletion) { - inputs.enableUrlCompletion = readmeHelper.ENABLE_URL_COMPLETION_DEFAULT - } if (!inputs.imageExtensions) { inputs.imageExtensions = readmeHelper.IMAGE_EXTENSIONS_DEFAULT } diff --git a/src/readme-helper.ts b/src/readme-helper.ts index 90075c4..f7e381e 100644 --- a/src/readme-helper.ts +++ b/src/readme-helper.ts @@ -4,7 +4,6 @@ import * as utils from './utils' export const README_FILEPATH_DEFAULT = './README.md' export const IMAGE_EXTENSIONS_DEFAULT = 'bmp,gif,jpg,jpeg,png,svg,webp' -export const ENABLE_URL_COMPLETION_DEFAULT = false const TITLE_REGEX = `(?: +"[^"]+")?` const REPOSITORY_URL = `${process.env['GITHUB_SERVER_URL']}/${process.env['GITHUB_REPOSITORY']}`