Skip to content

Commit

Permalink
docs: withs "requierable" typos in descriptions and tests (#250)
Browse files Browse the repository at this point in the history
  • Loading branch information
abel-mak committed Aug 21, 2021
1 parent 3888609 commit 8bcde5c
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion index.js
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion lib/load-parser-config.js
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions test/integration.test.js
Expand Up @@ -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'},
Expand Down Expand Up @@ -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/,
});
Expand Down
4 changes: 2 additions & 2 deletions test/load-release-rules.test.js
Expand Up @@ -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);
Expand Down Expand Up @@ -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/,
});
Expand Down

0 comments on commit 8bcde5c

Please sign in to comment.