From 13d7b2dbb174a73f3f32010ab4b7396143bd986e Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 17 Mar 2022 02:27:04 +0000 Subject: [PATCH] fix: comply with markdown style guidelines The markdown style linting for our repos requires `*` instead of `-` for unordered lists. Because ncu-team uses `-`, it results in failing lints in some repos, thus requiring manual changes to the output. Use `*` instead so that becomes unnecessary. I had this problem in https://github.com/nodejs/TSC/pull/1189. Refs: https://github.com/nodejs/TSC/commit/3cbcd5a02c400d7c0886683166f9ff320c2c0f5c --- lib/team_info.js | 4 ++-- test/fixtures/ncu_team_sync_expected.md | 8 ++++---- test/fixtures/ncu_team_sync_out.md | 8 ++++---- test/unit/team_info.test.js | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/team_info.js b/lib/team_info.js index 3446ed420..09ff36f0e 100644 --- a/lib/team_info.js +++ b/lib/team_info.js @@ -8,8 +8,8 @@ function byLogin(a, b) { } function getContact({ login, url, name, email }) { - if (!name) return `- [@${login}](${url})`; - return `- [@${login}](${url}) - ${name}`; + if (!name) return `* [@${login}](${url})`; + return `* [@${login}](${url}) - ${name}`; } function key(org, team) { diff --git a/test/fixtures/ncu_team_sync_expected.md b/test/fixtures/ncu_team_sync_expected.md index 0904ed74d..84a5dd6d7 100644 --- a/test/fixtures/ncu_team_sync_expected.md +++ b/test/fixtures/ncu_team_sync_expected.md @@ -2,9 +2,9 @@ -- [@Bar](https://github.com/Bar) - Bar Bar -- [@foo](https://github.com/foo) - Mr. foo -- [@quo](https://github.com/quo) - Ms. Quo +* [@Bar](https://github.com/Bar) - Bar Bar +* [@foo](https://github.com/foo) - Mr. foo +* [@quo](https://github.com/quo) - Ms. Quo @@ -12,6 +12,6 @@ -- [@nodejs-github-bot](https://github.com/nodejs-github-bot) - Node.js GitHub Bot +* [@nodejs-github-bot](https://github.com/nodejs-github-bot) - Node.js GitHub Bot diff --git a/test/fixtures/ncu_team_sync_out.md b/test/fixtures/ncu_team_sync_out.md index 0904ed74d..84a5dd6d7 100644 --- a/test/fixtures/ncu_team_sync_out.md +++ b/test/fixtures/ncu_team_sync_out.md @@ -2,9 +2,9 @@ -- [@Bar](https://github.com/Bar) - Bar Bar -- [@foo](https://github.com/foo) - Mr. foo -- [@quo](https://github.com/quo) - Ms. Quo +* [@Bar](https://github.com/Bar) - Bar Bar +* [@foo](https://github.com/foo) - Mr. foo +* [@quo](https://github.com/quo) - Ms. Quo @@ -12,6 +12,6 @@ -- [@nodejs-github-bot](https://github.com/nodejs-github-bot) - Node.js GitHub Bot +* [@nodejs-github-bot](https://github.com/nodejs-github-bot) - Node.js GitHub Bot diff --git a/test/unit/team_info.test.js b/test/unit/team_info.test.js index 6d1ffbbb7..b9b34bf0c 100644 --- a/test/unit/team_info.test.js +++ b/test/unit/team_info.test.js @@ -7,9 +7,9 @@ import TeamInfo from '../../lib/team_info.js'; import { readJSON, readFile, path as getPath } from '../fixtures/index.js'; const collabList = -`- [@Bar](https://github.com/Bar) - Bar Bar -- [@foo](https://github.com/foo) - Mr. foo -- [@quo](https://github.com/quo) - Ms. Quo`; +`* [@Bar](https://github.com/Bar) - Bar Bar +* [@foo](https://github.com/foo) - Mr. foo +* [@quo](https://github.com/quo) - Ms. Quo`; describe('TeamInfo', function() { let request;