Skip to content

Commit a63fc39

Browse files
committed
Improve awesome/git-repo-age error message
The "Awesome list must reside in a valid git repository" error message (awesome/git-repo-age) also appears when (e.g. Travis) makes a shallow copy of the awesome repo. This is documented in the README file, but users may miss it. Rephrase error message and add a pointer to the README file.
1 parent a7b88fd commit a63fc39

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

rules/git-repo-age.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@ module.exports = rule('remark-lint:awesome/git-repo-age', async (ast, file) => {
3535
file.message(`Git repository must be at least ${minGitRepoAgeDays} days old`);
3636
}
3737
} catch (_) {
38-
// Most likely not a Git repository
39-
file.message('Awesome list must reside in a valid git repository');
38+
// Not a Git repository or a shallow copy missing the
39+
// .travis.yml "git:\ndepth: false" setting
40+
file.message('Awesome list must reside in a valid deep-copied Git repository (see README)');
4041
}
4142
});
4243

test/rules/git-repo-age.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ test.serial('git-repo-age - error invalid git repo', async t => {
3030
t.deepEqual(messages, [
3131
{
3232
ruleId: 'awesome/git-repo-age',
33-
message: 'Awesome list must reside in a valid git repository'
33+
message: 'Awesome list must reside in a valid deep-copied Git repository (see README)'
3434
}
3535
]);
3636
});

0 commit comments

Comments
 (0)