all-contributors / all-contributors/cli

[BUG]: Markdown provided in `types[key].link` is injected as-is into HTMLAnchorElement's href attribute

Open
#520 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
425
Forks
149
PR merge metrics
No merged PRs in 30d

Description

### 📝 Describe the bug

When using the recommended setup when defining custom types, the following configuration:

```json
"types": {
"core": {
"symbol": "🏵️",
"description": "Core team",
"link": "[<%= symbol %>](https://github.com/bl-portal-bot)"
}
}
```

...ends up generating the following cell:

```html


Terry Mun-Andersen


Terry Mun-Andersen





🏵️

💻
```

...which is incorrect, as the markdown is injected as-is into the `href` attribute of the HTMLAnchorElement. Updating the `link` field to just contain the URL will then generate the correct output:

```json
"types": {
"core": {
"symbol": "🏵️",
"description": "Core team",
"link": "https://github.com/bl-portal-bot"
}
}
```

```html


Terry Mun-Andersen


Terry Mun-Andersen





🏵️

💻

```

### 👣 Steps to Reproduce

Use the following configuration to add a custom emoji key as [described in the docs](https://allcontributors.org/en/bot/configuration/):

```json
"types": {
"core": {
"symbol": "🏵️",
"description": "Core team",
"link": "[<%= symbol %>](https://github.com/bl-portal-bot)"
}
}
```

This results in the markdown string being inserted as-is into the `href` attribute.

### 🎯 Expected behavior

Using `"link": "[<%= symbol %>](https://github.com/bl-portal-bot)"` should generate the entire HTMLAnchorElement correctly.

### 💡 Additional context

_No response_

### 🤝 Participation

- [ ] I am willing to submit a pull request for this issue.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.