Repository: UmbrellaDocs/linkspector
Pull request #67 (2024-06-23 23:34:49)

Added configuration values table
## Description

Added a table for configuration options in README.

## Type of Change
- documentation update

## Checklist:

- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my feature works
- [x] New and existing unit tests pass locally with my changes




Patch:
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 551afb8..ffa9c4a 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,8 +1,6 @@
-# Pull Request Template
-
 ## Description
 
-Please include a summary of the change and which issue is fixed. Also include relevant motivation and context. List any dependencies that are required for this change.
+Please include a summary of the change and which issue is fixed. Also include relevant motivation and context. List any dependencies that are required for this change. Delete any other sections or text that are not relevant.
 
 Fixes # (issue number)
 
@@ -17,7 +15,6 @@ Please delete options that are not relevant.
 
 ## Checklist:
 
-- [ ] My code follows the style guidelines of this project
 - [ ] I have performed a self-review of my own code
 - [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation
diff --git a/README.md b/README.md
index fe2200d..44f8aca 100644
--- a/README.md
+++ b/README.md
@@ -83,8 +83,23 @@ dirs:
 useGitIgnore: true
 ```
 
+If you are defining a custom configuration, you must include the `dirs` or `files` section in the configuration file.
+
 Following are the available configuration options:
 
+| Option                                            | Description                                                                                           | Required                          |
+| ------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | --------------------------------- |
+| [`files`](#files-to-check)                        | The list of Markdown files to check for broken links.                                                 | Yes, if `dirs` is not specified.  |
+| [`dirs`](#directories-to-search)                  | The list of directories to search for Markdown files.                                                 | Yes, if `files` is not specified. |
+| [`excludedFiles`](#excluded-files)                | The list of Markdown files to exclude from the link checking process.                                 | No                                |
+| [`excludedDirs`](#excluded-directories)           | The list of directories to exclude from the link checking process.                                    | No                                |
+| [`baseUrl`](#base-url)                            | The base URL to use when checking relative links in Markdown files.                                   | No                                |
+| [`ignorePatterns`](#ignore-patterns)              | The list of regular expressions that match URLs to be ignored during link checking.                   | No                                |
+| [`replacementPatterns`](#replacement-patterns)    | The list of regular expressions and replacement strings to modify URLs during link checking.          | No                                |
+| [`aliveStatusCodes`](#alive-status-codes)         | The list of HTTP status codes that are considered as "alive" links.                                   | No                                |
+| [`useGitIgnore`](#use-gitignore)                  | Indicates whether to use the rules defined in the `.gitignore` file to exclude files and directories. | No                                |
+| [`modifiedFilesOnly`](#check-modified-files-only) | Indicates whether to check only the files that have been modified in the last git commit.             | No                                |
+
 ### Files to Check
 
 The `files` section specifies the Markdown files that Linkspector should check for broken links. You can add the file paths you want to include in this list. For example:


Test patch:
diff --git a/index.test.js b/index.test.js
index 55e273a..1b5de6d 100644
--- a/index.test.js
+++ b/index.test.js
@@ -110,7 +110,7 @@ test('linkspector should check top-level relative links in Markdown file', async
   }
 
   expect(hasErrorLinks).toBe(false)
-  expect(results.length).toBe(7)
+  expect(results.length).toBe(17)
 })
 
 test('linkspector should add back the removed duplicates when returning the results', async () => {