Change linter (#10614)

JabRef · Nov 6, 2023 · 837fc1e · 837fc1e
1 parent 245e75e
commit 837fc1e
Show file tree

Hide file tree

Showing 21 changed files with 96 additions and 112 deletions.
diff --git a/.github/workflows/check-links.yaml b/.github/workflows/check-links.yaml
diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml
@@ -0,0 +1,35 @@
+name: Check external href links in the documentation
+
+on:
+  push:
+    paths:
+      - '.github/workflows/check-links.yml'
+      - '**/*.md'
+  schedule:
+    # Run on the first of each month at 9:00 AM (See https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07)
+    - cron: "0 9 1 * *"
+  workflow_dispatch:
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.head_ref }}"
+  cancel-in-progress: true
+
+jobs:
+  lychee:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          show-progress: 'false'
+      - name: Restore lychee cache
+        uses: actions/cache@v3
+        with:
+          path: .lycheecache
+          key: cache-lychee-${{ github.sha }}
+          restore-keys: cache-lychee-
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v1.8.0
+        with:
+          fail: true
+          args: --max-concurrency 1 --cache --no-progress --exclude-all-private './**/*.md'
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,8 @@ src/main/gen/
 src/main/generated/
 src-gen/
 
+.lycheecache
+
 # generated by https://plugins.jetbrains.com/plugin/15991-plantuml-diagram-generator
 *.puml
 

diff --git a/.lycheeignore b/.lycheeignore
@@ -0,0 +1,14 @@
+https://arxiv.org/
+https://contribute.jabref.org/
+https://donations.jabref.org/
+https://pubs.acs.org/
+https://web.archive.org/
+https://www.researchgate.net/privacy-policy
+https://www.sciencedirect.com/
+
+https://github.com/koppor/jabref/issue
+https://github.com/koppor/jabref/pull
+https://github.com/JabRef/jabref/issue
+https://github.com/JabRef/jabref/pull
+
+0005-example.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -92,7 +92,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added "Attach file from URL" to right-click context menu to download and store a file with the reference library. [#9646](https://github.com/JabRef/jabref/issues/9646)
 - We enabled updating an existing entry with data from InspireHEP. [#9351](https://github.com/JabRef/jabref/issues/9351)
 - We added a fetcher for the Bibliotheksverbund Bayern (experimental). [#9641](https://github.com/JabRef/jabref/pull/9641)
-- We added support for more biblatex date formats for parsing dates. [#2753](https://github.com/JabRef/issues/2753)
+- We added support for more biblatex date formats for parsing dates. [#2753](https://github.com/JabRef/jabref/issues/2753)
 - We added support for multiple languages for exporting to and importing references from MS Office. [#9699](https://github.com/JabRef/jabref/issues/9699)
 - We enabled scrolling in the groups list when dragging a group on another group. [#2869](https://github.com/JabRef/jabref/pull/2869)
 - We added the option to automatically download online files when a new entry is created from an existing ID (e.g., DOI). The option can be disabled in the preferences under "Import and Export". [#9756](https://github.com/JabRef/jabref/issues/9756)
@@ -686,7 +686,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We fixed an issue with toggle of special fields does not work for sorted entries [#7016](https://github.com/JabRef/jabref/issues/7016)
 - We fixed an issue with the default path of external application. [#7641](https://github.com/JabRef/jabref/issues/7641)
 - We fixed an issue where urls must be embedded in a style tag when importing EndNote style Xml files. Now it can parse url with or without a style tag. [#6199](https://github.com/JabRef/jabref/issues/6199)
-- We fixed an issue where the article title with colon fails to download the arXiv link (pdf file). [#7660](https://github.com/JabRef/issues/7660)
+- We fixed an issue where the article title with colon fails to download the arXiv link (pdf file). [#7660](https://github.com/JabRef/jabref/issues/7660)
 - We fixed an issue where the keybinding for delete entry did not work on the main table [7580](https://github.com/JabRef/jabref/pull/7580)
 - We fixed an issue where the RFC fetcher is not compatible with the draft [7305](https://github.com/JabRef/jabref/issues/7305)
 - We fixed an issue where duplicate files (both file names and contents are the same) is downloaded and add to linked files [#6197](https://github.com/JabRef/jabref/issues/6197)
@@ -788,7 +788,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 ### Added
 
 - We added a new fetcher to enable users to search mEDRA DOIs [#6602](https://github.com/JabRef/jabref/issues/6602)
-- We added a new fetcher to enable users to search "[Collection of Computer Science Bibliographies](https://liinwww.ira.uka.de/bibliography/index.html)". [#6638](https://github.com/JabRef/jabref/issues/6638)
+- We added a new fetcher to enable users to search "[Collection of Computer Science Bibliographies](https://en.wikipedia.org/wiki/Collection_of_Computer_Science_Bibliographies)". [#6638](https://github.com/JabRef/jabref/issues/6638)
 - We added default values for delimiters in Add Subgroup window [#6624](https://github.com/JabRef/jabref/issues/6624)
 - We improved responsiveness of general fields specification dialog window. [#6604](https://github.com/JabRef/jabref/issues/6604)
 - We added support for importing ris file and load DOI [#6530](https://github.com/JabRef/jabref/issues/6530)
@@ -881,7 +881,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We fixed an issue about duplicated group color indicators [#6175](https://github.com/JabRef/jabref/issues/6175)
 - We fixed an issue where entries with the entry type Misc from an imported aux file would not be saved correctly to the bib file on disk [#6405](https://github.com/JabRef/jabref/issues/6405)
 - We fixed an issue where percent sign ('%') was not formatted properly by the HTML formatter [#6753](https://github.com/JabRef/jabref/issues/6753)
-- We fixed an issue with the [SAO/NASA Astrophysics Data System](https://docs.jabref.org/collect/import-using-online-bibliographic-database/ads) fetcher where `\textbackslash` appeared at the end of the abstract.
+- We fixed an issue with the [SAO/NASA Astrophysics Data System](https://docs.jabref.org/collect/add-entry-using-an-id#sao-nasa-a-ds) fetcher where `\textbackslash` appeared at the end of the abstract.
 - We fixed an issue with the Science Direct fetcher where PDFs could not be downloaded. Fixes [#5860](https://github.com/JabRef/jabref/issues/5860)
 - We fixed an issue with the Library of Congress importer.
 - We fixed the [link to the external libraries listing](https://github.com/JabRef/jabref/blob/master/external-libraries.md) in the about dialog
@@ -891,7 +891,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 
 - We removed the option of the "enforce legal key". [#6295](https://github.com/JabRef/jabref/issues/6295)
 - We removed the obsolete `External programs / Open PDF` section in the preferences, as the default application to open PDFs is now set in the `Manage external file types` dialog. [#6130](https://github.com/JabRef/jabref/pull/6130)
-- We removed the option to configure whether a `.bib.bak` file should be generated upon save. It is now always enabled. Documentation at <https://docs.jabref.org/general/autosave>. [#6092](https://github.com/JabRef/jabref/issues/6092)
+- We removed the option to configure whether a `.bib.bak` file should be generated upon save. It is now always enabled. Documentation at <https://docs.jabref.org/advanced/autosave>. [#6092](https://github.com/JabRef/jabref/issues/6092)
 - We removed the built-in list of IEEE journal abbreviations using BibTeX strings. If you still want to use them, you have to download them separately from <https://abbrv.jabref.org>.
 
 ## [5.0] – 2020-03-06
@@ -1021,7 +1021,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 ### Removed
 
 - We removed some obsolete notifications. [#5555](https://github.com/JabRef/jabref/issues/5555)
-- We removed an internal step in the [ISBN-to-BibTeX fetcher](https://docs.jabref.org/import-using-publication-identifiers/isbntobibtex): The [ISBN to BibTeX Converter](https://manas.tungare.name/software/isbn-to-bibtex) by [@manastungare](https://github.com/manastungare) is not used anymore, because it is offline: "people using this tool have not been generating enough sales for Amazon."
+- We removed an internal step in the [ISBN-to-BibTeX fetcher](https://docs.jabref.org/collect/add-entry-using-an-id#isbn): The [ISBN to BibTeX Converter](https://manas.tungare.name/software/isbn-to-bibtex) by [@manastungare](https://github.com/manastungare) is not used anymore, because it is offline: "people using this tool have not been generating enough sales for Amazon."
 - We removed the option to control the default drag and drop behaviour. You can use the modifier keys (like CtrL or Alt) instead.
 
 ## [5.0-alpha] – 2019-08-25
@@ -1054,7 +1054,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - Change default icon for groups to a circle because a colored version of the old icon was hard to distinguish from its black counterpart.
 - In the main table, the context menu appears now when you press the "context menu" button on the keyboard. [feature request in the forum](https://discourse.jabref.org/t/how-to-enable-keyboard-context-key-windows)
 - We added icons to the group side panel to quickly switch between `union` and `intersection` group view mode. [#3269](https://github.com/JabRef/jabref/issues/3269).
-- We use `https` for [fetching from most online bibliographic database](https://docs.jabref.org/import-using-online-bibliographic-database).
+- We use `https` for [fetching from most online bibliographic database](https://docs.jabref.org/collect/import-using-online-bibliographic-database).
 - We changed the default keyboard shortcuts for moving between entries when the entry editor is active to ̀<kbd>alt</kbd> + <kbd>up/down</kbd>.
 - Opening a new file now prompts the directory of the currently selected file, instead of the directory of the last opened file.
 - Window state is saved on close and restored on start.

diff --git a/PRIVACY.md b/PRIVACY.md
@@ -46,7 +46,7 @@ These third-party services are the following:
 | [arXiv.org](https://arxiv.org/)                                                                                 | <https://info.arxiv.org/help/policies/privacy_policy.html> |
 | [Bibliotheksverbund Bayern](https://www.bib-bvb.de/)                                                            | <https://www.bib-bvb.de/web/guest/datenschutzerklaerung-bvb-homepage> |
 | [Biodiversity Heritage Library](https://www.biodiversitylibrary.org/)                                           | <https://www.si.edu/Privacy> |
-| [Collection of Computer Science Bibliographies](http://liinwww.ira.uka.de/)                                     | **currently unavailable**, offline  |
+| [Collection of Computer Science Bibliographies](https://en.wikipedia.org/wiki/Collection_of_Computer_Science_Bibliographies)                                     | **currently unavailable**, offline  |
 | [CrossRef](https://www.crossref.org/)                                                                           | <https://www.crossref.org/operations-and-sustainability/privacy/> |
 | [dblp](https://dblp.uni-trier.de/)                                                                              | <https://dblp.uni-trier.de/db/about/privacy.html> |
 | [Directory of Open Access Books](https://www.doabooks.org/)                                                     | <https://www.doabooks.org/en/resources/accessibility> |
@@ -62,7 +62,7 @@ These third-party services are the following:
 | [Library of Congress](https://lccn.loc.gov/)                                                                    | <https://www.loc.gov/legal/> |
 | [National Library of Medicine](https://www.ncbi.nlm.nih.gov/)                                                   | <https://www.nlm.nih.gov/web_policies.html> |
 | [MathSciNet](http://www.ams.org/mathscinet)                                                                     | <https://www.ams.org/about-us/privacy> |
-| [mEDRA](https://medra.org/)                                                                                     | <https://www.medra.org/stdoc/en/Servizio_DOI_Informativa_ENG.pdf> |
+| [mEDRA](https://www.medra.org/)                                                                                     | <https://<https://www.medra.org/stdoc/en/Servizio_DOI_Informativa_ENG.pdf> |
 | [Mr. DLib](https://mr-dlib.org/) [1]                                                                            | <https://support.dataverse.harvard.edu/harvard-dataverse-privacy-policy> |
 | [Openlibrary](https://openlibrary.org)                                                                          | <https://archive.org/about/terms.php> |
 | [ResearchGate](https://www.researchgate.net/)                                                                   | <https://www.researchgate.net/privacy-policy> |

diff --git a/buildres/LICENSE_with_Privacy.md b/buildres/LICENSE_with_Privacy.md
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright © 2003-2021 [JabRef Authors](https://github.com/JabRef/jabref/blob/master/AUTHORS)
+Copyright © 2003-2021 JabRef Authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -89,7 +89,7 @@ Service;Privacy Policy
 [arXiv.org](https://arxiv.org/);<https://info.arxiv.org/help/policies/privacy_policy.html>
 [Bibliotheksverbund Bayern](https://www.bib-bvb.de/);<https://www.bib-bvb.de/web/guest/datenschutzerklaerung-bvb-homepage>
 [Biodiversity Heritage Library](https://www.biodiversitylibrary.org/);<https://www.si.edu/Privacy>
-[Collection of Computer Science Bibliographies](http://liinwww.ira.uka.de/);**currently unavailable**, offline
+[Collection of Computer Science Bibliographies](https://en.wikipedia.org/wiki/Collection_of_Computer_Science_Bibliographies);**currently unavailable**, offline
 [CrossRef](https://www.crossref.org/);<https://www.crossref.org/operations-and-sustainability/privacy/>
 [dblp](https://dblp.uni-trier.de/);<https://dblp.uni-trier.de/db/about/privacy.html>
 [Directory of Open Access Books](https://www.doabooks.org/);<https://www.doabooks.org/en/resources/accessibility>
@@ -105,7 +105,7 @@ Service;Privacy Policy
 [Library of Congress](https://lccn.loc.gov/);<https://www.loc.gov/legal/>
 [National Library of Medicine](https://www.ncbi.nlm.nih.gov/);<https://www.nlm.nih.gov/web_policies.html>
 [MathSciNet](http://www.ams.org/mathscinet);<https://www.ams.org/about-us/privacy>
-[mEDRA](https://medra.org/);<https://www.medra.org/stdoc/en/Servizio_DOI_Informativa_ENG.pdf>
+[mEDRA](https://www.medra.org/);<https://www.medra.org/stdoc/en/Servizio_DOI_Informativa_ENG.pdf>
 [Mr. DLib](https://mr-dlib.org/) [1];<https://support.dataverse.harvard.edu/harvard-dataverse-privacy-policy>
 [Openlibrary](https://openlibrary.org);<https://archive.org/about/terms.php>
 [ResearchGate](https://www.researchgate.net/);<https://www.researchgate.net/privacy-policy>

diff --git a/docs/code-howtos/IntelliJ.md b/docs/code-howtos/IntelliJ.md
@@ -17,7 +17,7 @@ Did you know that [IntelliJ allows for reformatting selected code](https://www.j
 
 ## Show variable values in IntelliJ
 
-1. Go to a test case (example: [`org.jabref.model.entry.BibEntryTest#settingTypeToNullThrowsException`](https://github.com/JabRef/jabref/blob/refine-intellij-howto/src/test/java/org/jabref/model/entry/BibEntryTest.java#L52-L52)
+1. Go to a test case (example: [`org.jabref.model.entry.BibEntryTest#settingTypeToNullThrowsException`](https://github.com/JabRef/jabref/blob/main/src/test/java/org/jabref/model/entry/BibEntryTest.java#L52-L52)
 2. Set the breakpoint to the first line
 3. Execute the test
 4. Go to the settings of the debugger and activate "Show Variable Values in Editor" and "Show Method Return Values"

diff --git a/docs/code-howtos/index.md b/docs/code-howtos/index.md
@@ -5,7 +5,7 @@ has_children: true
 # Code Howtos
 
 This page provides some development support in the form of howtos.
-See also [High Level Documentation](../getting-into-thecode/high-level-documentation.md).
+See also [High Level Documentation](../getting-into-the-code/high-level-documentation.md).
 
 ## Generic code how tos
 

diff --git a/docs/code-howtos/javafx.md b/docs/code-howtos/javafx.md
@@ -62,7 +62,7 @@ The goal of the MVVM architecture is to separate the state/behavior from the app
 
 The only class which access model and logic classes is the ViewModel. Controller and View have only access the ViewModel and never the backend. The ViewModel does not know the Controller or View.
 
-More details about the MVVM pattern can be found in [an article by Microsoft](https://msdn.microsoft.com/en-us/magazine/dd419663.aspx) and in [an article focusing on the implementation with JavaFX](http://blog.buildpath.de/javafx-decouple-the-view-and-its-behavior-to-create-a-testable-ui/).
+More details about the MVVM pattern can be found in [an article by Microsoft](https://msdn.microsoft.com/en-us/magazine/dd419663.aspx) and in [an article focusing on the implementation with JavaFX](https://web.archive.org/web/20140825151304/http://blog.buildpath.de/javafx-decouple-the-view-and-its-behavior-to-create-a-testable-ui/).
 
 ## An example