Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link references should be allowed #161

Open
mgrojo opened this issue Mar 4, 2023 · 5 comments
Open

Link references should be allowed #161

mgrojo opened this issue Mar 4, 2023 · 5 comments

Comments

@mgrojo
Copy link

mgrojo commented Mar 4, 2023

- [gtkada] - Ada graphical toolkit based on Gtk3 components.

 [gtkada]: https://github.com/AdaCore/gtkada

Why does this format not work? For the end user will be the same. We want the reference to be able to link to the same URL in the description of applications using this library.

See the workaround I had to do in https://github.com/ohenley/awesome-ada/pull/111/files. We'd like to not have to repeat the URL anywhere. See ohenley/awesome-ada#109 (comment)

@sindresorhus
Copy link
Owner

Can you include the lint error you get?

@mgrojo
Copy link
Author

mgrojo commented Mar 4, 2023

Can you include the lint error you get?

Invalid list item link remark-lint:awesome-list-item

https://github.com/mgrojo/awesome-ada/actions/runs/4331204896/jobs/7562895908#step:3:26

@mgrojo
Copy link
Author

mgrojo commented Mar 11, 2023

Is it possible to disable only this specific check? I tried with this:

<!--lint disable awesome-list-item-->

but it disables some other checks that I wouldn't like to lose, like starting a description with a lower-case letter.

@WillForan
Copy link
Contributor

WillForan commented Dec 31, 2023

getting this to pass looks easy enough -- instead of a link the first child element is a linkReference, in list-item.js that could look like

function validateListItemLink(link, file) {

	// TODO: confirm reference exists
	if (link.type === "linkReference") {
		return true;
	}

....

but then there's no guarantee the reference is actually defined. I've no idea how that could or should be done

- [gtkada] - Ada graphical toolkit based on Gtk3 components.
- [neverlinked] - This won't get flagged even though the reference is meaningless.

 [gtkada]: https://github.com/AdaCore/gtkada

@WillForan
Copy link
Contributor

oh maybe undefined references will be caught by noUndefinedReferences already used in config.js!

WillForan added a commit to WillForan/awesome-lint that referenced this issue Dec 31, 2023
WillForan added a commit to WillForan/awesome-lint that referenced this issue Dec 31, 2023
WillForan added a commit to WillForan/awesome-lint that referenced this issue Dec 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants