Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update error message to be consistent with what is being enforced #5

Merged
merged 3 commits into from
Feb 5, 2024
Merged

fix: Update error message to be consistent with what is being enforced #5

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68ab139
fix error message
despairblue Jan 26, 2024
b5bf9d8
rename constant to match error described in value
despairblue Jan 26, 2024
23c11cc
Revert "rename constant to match error described in value"
despairblue Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/constants.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ const ERRORS = {
"PR title does not match PR title convention: type: subject or type(scope): subject",
`For \`type\`, use \`type:\` or \`type(scope):\`, where \`type\` is one of ${displayTypes}`,
`If present, \`scope\` must be one of ${displayScopes} or \`<displayName> Node\``,
"For the subject, mind the whitespace, start with lowercase and omit final period",
"For the subject, mind the whitespace, start with uppercase and omit final period",
].join(". "),
TICKET_NUMBER_PRESENT: "PR title must not contain a ticket number",
TYPE_NOT_FOUND: `Failed to find \`type\` in PR title. Expected one of ${displayTypes}`,
INVALID_TYPE: `Unknown \`type\` in PR title. Expected one of ${displayTypes}`,
INVALID_SCOPE: `Unknown \`scope\` in PR title. Expected one of ${displayScopes} or \`<displayName> Node\``,
LOWERCASE_INITIAL_IN_SUBJECT: "First char of subject must be uppercase",
UPPERCASE_INITIAL_IN_SUBJECT: "First char of subject must be uppercase",
despairblue marked this conversation as resolved.
Show resolved Hide resolved
FINAL_PERIOD_IN_SUBJECT: "Subject must not end with a period",
NO_PRESENT_TENSE_IN_SUBJECT: "Subject must use present tense",
SKIP_CHANGELOG_NOT_IN_FINAL_POSITION: `\`${NO_CHANGELOG}\` must be located at the end of the subject`,
Expand Down
2 changes: 1 addition & 1 deletion src/validatePrTitle.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ async function validatePrTitle(title) {
const { subject } = match.groups;

if (startsWithLowerCase(subject)) {
issues.push(ERRORS.LOWERCASE_INITIAL_IN_SUBJECT);
issues.push(ERRORS.UPPERCASE_INITIAL_IN_SUBJECT);
}

if (endsWithPeriod(subject)) {
Expand Down
2 changes: 1 addition & 1 deletion src/validatePrTitle.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ describe("subject", () => {
const issues = await validate("feat(core): implement feature");
expect(issues)
.toHaveLength(1)
.toContain(ERRORS.LOWERCASE_INITIAL_IN_SUBJECT);
.toContain(ERRORS.UPPERCASE_INITIAL_IN_SUBJECT);
});

test("Validation should fail for final period in subject", async () => {
Expand Down
Loading