From 8bcde5c83e84a0373049250f1b35988621b11088 Mon Sep 17 00:00:00 2001 From: Abdelali El Makkioui <57806853+abel-mak@users.noreply.github.com> Date: Sat, 21 Aug 2021 06:01:50 +0100 Subject: [PATCH] docs: withs "requierable" typos in descriptions and tests (#250) --- index.js | 2 +- lib/load-parser-config.js | 2 +- test/integration.test.js | 4 ++-- test/load-release-rules.test.js | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/index.js b/index.js index 65d4f298..542d536d 100644 --- a/index.js +++ b/index.js @@ -14,7 +14,7 @@ const DEFAULT_RELEASE_RULES = require('./lib/default-release-rules'); * * @param {Object} pluginConfig The plugin configuration. * @param {String} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint') - * @param {String} pluginConfig.config Requierable npm package with a custom conventional-changelog preset + * @param {String} pluginConfig.config Requirable npm package with a custom conventional-changelog preset * @param {String|Array} pluginConfig.releaseRules A `String` to load an external module or an `Array` of rules. * @param {Object} pluginConfig.parserOpts Additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`. * @param {Object} context The semantic-release context. diff --git a/lib/load-parser-config.js b/lib/load-parser-config.js index af093eba..7fb396c2 100644 --- a/lib/load-parser-config.js +++ b/lib/load-parser-config.js @@ -8,7 +8,7 @@ const conventionalChangelogAngular = require('conventional-changelog-angular'); * * @param {Object} pluginConfig The plugin configuration. * @param {Object} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint') - * @param {String} pluginConfig.config Requierable npm package with a custom conventional-changelog preset + * @param {String} pluginConfig.config Requirable npm package with a custom conventional-changelog preset * @param {Object} pluginConfig.parserOpts Additionnal `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`. * @param {Object} context The semantic-release context. * @param {String} context.cwd The current working directory. diff --git a/test/integration.test.js b/test/integration.test.js index e7ac70ae..5e141cc3 100644 --- a/test/integration.test.js +++ b/test/integration.test.js @@ -111,7 +111,7 @@ test('Exclude commits if they have a matching revert commits', async t => { t.true(t.context.log.calledWith('Analysis of %s commits complete: %s release', 3, 'patch')); }); -test('Accept a "releaseRules" option that reference a requierable module', async t => { +test('Accept a "releaseRules" option that reference a requirable module', async t => { const commits = [ {hash: '123', message: 'fix(scope1): First fix'}, {hash: '456', message: 'feat(scope2): Second feature'}, @@ -356,7 +356,7 @@ test('Throw error if "releaseRules" is not an Array or a String', async t => { }); }); -test('Throw error if "releaseRules" option reference a requierable module that is not an Array or a String', async t => { +test('Throw error if "releaseRules" option reference a requirable module that is not an Array or a String', async t => { await t.throwsAsync(analyzeCommits({releaseRules: './test/fixtures/release-rules-invalid'}, {cwd}), { message: /Error in commit-analyzer configuration: "releaseRules" must be an array of rules/, }); diff --git a/test/load-release-rules.test.js b/test/load-release-rules.test.js index a6818dae..765e424a 100644 --- a/test/load-release-rules.test.js +++ b/test/load-release-rules.test.js @@ -10,7 +10,7 @@ test('Accept a "releaseRules" option', t => { t.deepEqual(releaseRules, testReleaseRules); }); -test('Accept a "releaseRules" option that reference a requierable module', t => { +test('Accept a "releaseRules" option that reference a requirable module', t => { const releaseRules = loadReleaseRules({releaseRules: './test/fixtures/release-rules'}, {cwd}); t.deepEqual(releaseRules, testReleaseRules); @@ -57,7 +57,7 @@ test('Throw error if "releaseRules" is not an Array or a String', t => { }); }); -test('Throw error if "releaseRules" option reference a requierable module that is not an Array or a String', t => { +test('Throw error if "releaseRules" option reference a requirable module that is not an Array or a String', t => { t.throws(() => loadReleaseRules({releaseRules: './test/fixtures/release-rules-invalid'}, {cwd}), { message: /Error in commit-analyzer configuration: "releaseRules" must be an array of rules/, });