Improve bot error messages (#637)

This commit is contained in:
James Nylen 2019-10-14 18:14:56 +00:00 committed by GitHub
parent 045e6db7fb
commit f3969f28fa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 10 deletions

View file

@ -195,7 +195,7 @@ exports.parseFromDirectory = contentPath => {
readmeEntry.linkedFilename = match[ 1 ];
if ( profileFilenames.indexOf( readmeEntry.linkedFilename ) === -1 ) {
readmeError(
'Broken link to company "%s": "%s"',
'Missing company profile for "%s", or broken link: "%s"',
readmeEntry.name,
$profileLink.attr( 'href' )
);
@ -211,14 +211,14 @@ exports.parseFromDirectory = contentPath => {
}
} else {
readmeError(
'Invalid link to company "%s": "%s"',
'Invalid link to company profile for "%s": "%s"',
readmeEntry.name,
$profileLink.attr( 'href' )
);
}
} else {
readmeError(
'Company "%s" has no linked Markdown profile ("%s.md")',
'Company "%s" has no linked Markdown profile ("/company-profiles/%s.md")',
readmeEntry.name,
companyNameToProfileFilename( readmeEntry.name )
);

View file

@ -24,14 +24,14 @@ describe( 'validation errors', () => {
expectValidateFixturesResult( 'missing-company-names', {
errorCount: 11,
output: [
'README.md: Company "⚠⚠⚠" has no linked Markdown profile (".md")',
'README.md: Company "⚠⚠⚠" has no linked Markdown profile ("/company-profiles/.md")',
'README.md: Missing company name: <td></td><td><a href="https://andyet.com">https://andyet.com</a></td><td>Worldwide</td>',
'README.md: Company is listed out of order: "" (should be before "⚠⚠⚠")',
'README.md: Company "" has no linked Markdown profile (".md")',
'README.md: Company "" has no linked Markdown profile ("/company-profiles/.md")',
'README.md: Missing company name: <td><a href="/company-profiles/10up.md"></a> &#x26A0;</td><td><a href="https://10up.com/">https://10up.com/</a></td><td>Worldwide</td>',
'README.md: Missing company name: <td><a href="/company-profiles/17hats.md"></a></td><td><a href="https://www.17hats.com/">https://www.17hats.com/</a></td><td>Worldwide</td>',
'README.md: Missing company name: <td></td><td><a href="https://18f.gsa.gov/">https://18f.gsa.gov/</a></td><td>USA</td>',
'README.md: Company "" has no linked Markdown profile (".md")',
'README.md: Company "" has no linked Markdown profile ("/company-profiles/.md")',
'10up.md: Profile looks complete, but the main readme contains a warning emoji.',
'18f.md: No link to company profile from readme',
'and-yet.md: No link to company profile from readme',
@ -53,10 +53,10 @@ describe( 'validation errors', () => {
expectValidateFixturesResult( 'bad-profile-links', {
errorCount: 4,
output: [
'README.md: Invalid link to company "&yet": "company-profiles/and-yet.md"',
'README.md: Broken link to company "17hats": "/company-profiles/17hats-nonexistent.md"',
'README.md: Invalid link to company "18F": "/company-profiles/18f.js"',
'README.md: Company "My awesome company" has no linked Markdown profile ("my-awesome-company.md")',
'README.md: Invalid link to company profile for "&yet": "company-profiles/and-yet.md"',
'README.md: Missing company profile for "17hats", or broken link: "/company-profiles/17hats-nonexistent.md"',
'README.md: Invalid link to company profile for "18F": "/company-profiles/18f.js"',
'README.md: Company "My awesome company" has no linked Markdown profile ("/company-profiles/my-awesome-company.md")',
],
} );
} );