Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 9bc07f3

Browse files
author
Ben McKernan
committed
feat: Add references-empty-enum rule
Add rule that ensures references are always or never empty for a given list of commit types.
1 parent cbada4b commit 9bc07f3

File tree

4 files changed

+44
-0
lines changed

4 files changed

+44
-0
lines changed

‎index.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module.exports = {
2+
rules: {
3+
"references-empty-enum": require("./references-empty-enum")
4+
}
5+
};

‎package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
"commitlintplugin",
1010
"episerver"
1111
],
12+
"dependencies": {
13+
"@commitlint/ensure": "^8.1.0",
14+
"@commitlint/message": "^8.1.0"
15+
},
1216
"devDependencies": {
1317
"@episerver/eslint-config": "^1.2.0",
1418
"eslint": "^6.2.1"

‎references-empty-enum.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
const ensure = require("@commitlint/ensure");
2+
const message = require("@commitlint/message");
3+
4+
module.exports = function (parsed, when = "never", value) {
5+
const { references, type } = parsed;
6+
7+
if (!type || !ensure.enum(type, value)) {
8+
return [true];
9+
}
10+
11+
const negated = when === "always";
12+
const empty = references.length === 0;
13+
14+
return [
15+
negated ? empty : !empty,
16+
message(["references", negated ? "must" : "must not", `be empty when type is one of [${value.join(", ")}]`])
17+
];
18+
};

‎yarn.lock

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@
1818
esutils "^2.0.2"
1919
js-tokens "^4.0.0"
2020

21+
"@commitlint/ensure@^8.1.0":
22+
version "8.1.0"
23+
resolved "https://registry.yarnpkg.com/@commitlint/ensure/-/ensure-8.1.0.tgz#6c669f85c3005ed15c8141d83cf5312c43001613"
24+
integrity sha512-dBU4CcjN0vJSDNOeSpaHNgQ1ra444u4USvI6PTaHVAS4aeDpZ5Cds1rxkZNsocu48WNycUu0jP84+zjcw2pPLQ==
25+
dependencies:
26+
lodash "4.17.14"
27+
28+
"@commitlint/message@^8.1.0":
29+
version "8.1.0"
30+
resolved "https://registry.yarnpkg.com/@commitlint/message/-/message-8.1.0.tgz#8fb8046ddaa7e5c846a79da7cdbd15cf1a7770ae"
31+
integrity sha512-AjHq022G8jQQ/3YrBOjwVBD4xF75hvC3vcvFoBIb7cC8vad1QWq+1w+aks0KlEK5IW+/+7ORZXIH+oyW7h3+8A==
32+
2133
"@episerver/eslint-config@^1.2.0":
2234
version "1.2.0"
2335
resolved "https://registry.yarnpkg.com/@episerver/eslint-config/-/eslint-config-1.2.0.tgz#97c9b85dd7c885fac3aad3fde980211225ebed14"
@@ -485,6 +497,11 @@ levn@^0.3.0, levn@~0.3.0:
485497
prelude-ls "~1.1.2"
486498
type-check "~0.3.2"
487499

500+
lodash@4.17.14:
501+
version "4.17.14"
502+
resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.14.tgz#9ce487ae66c96254fe20b599f21b6816028078ba"
503+
integrity sha512-mmKYbW3GLuJeX+iGP+Y7Gp1AiGHGbXHCOh/jZmrawMmsE7MS4znI3RL2FsjbqOyMayHInjOeykW7PEajUk1/xw==
504+
488505
lodash@^4.17.12, lodash@^4.17.14:
489506
version "4.17.15"
490507
resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.15.tgz#b447f6670a0455bbfeedd11392eff330ea097548"

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /