Skip to content

Commit

Permalink
fix: comply with markdown style guidelines
Browse files Browse the repository at this point in the history
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 nodejs/TSC#1189.

Refs: nodejs/TSC@3cbcd5a
  • Loading branch information
Trott committed Mar 17, 2022
1 parent 919ec3b commit 13d7b2d
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions lib/team_info.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
8 changes: 4 additions & 4 deletions test/fixtures/ncu_team_sync_expected.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

<!-- ncu-team-sync.team(nodejs/automation-collaborators) -->

- [@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

<!-- ncu-team-sync end -->

## nodejs/bots

<!-- ncu-team-sync.team(nodejs/bots) -->

- [@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

<!-- ncu-team-sync end -->
8 changes: 4 additions & 4 deletions test/fixtures/ncu_team_sync_out.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

<!-- ncu-team-sync.team(nodejs/automation-collaborators) -->

- [@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

<!-- ncu-team-sync end -->

## nodejs/bots

<!-- ncu-team-sync.team(nodejs/bots) -->

- [@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

<!-- ncu-team-sync end -->
6 changes: 3 additions & 3 deletions test/unit/team_info.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 13d7b2d

Please sign in to comment.