Skip to content

Commit fa2c64b

Browse files
authored
docs: use relative links for internal links (#16631)
1 parent 75276c9 commit fa2c64b

30 files changed

Lines changed: 204 additions & 204 deletions

docs/src/developer-guide/code-conventions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Code conventions for ESLint are determined by
77

88
The rationales for the specific rules in use can be found by looking to the
99
project documentation for any given rule. If the rule is one of our own, see
10-
our own [rule documentation](https://eslint.org/docs/rules/) and otherwise, see
10+
our own [rule documentation](../rules/) and otherwise, see
1111
the documentation of the plugin in which the rule can be found.
1212

1313
If you need to make changes to a `package.json` file, please see the

docs/src/developer-guide/contributing/new-rules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Even though these are the formal criteria for inclusion, each rule is evaluated
2222

2323
## Proposing a Rule
2424

25-
If you want to propose a new rule, please see how to [create a pull request](/docs/developer-guide/contributing/pull-requests) or submit an issue by filling out a [new rule template](https://github.com/eslint/eslint/issues/new/choose).
25+
If you want to propose a new rule, please see how to [create a pull request](pull-requests) or submit an issue by filling out a [new rule template](https://github.com/eslint/eslint/issues/new/choose).
2626

2727
We need all of this information in order to determine whether or not the rule is a good core rule candidate.
2828

docs/src/developer-guide/contributing/reporting-bugs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Reporting Bugs
33

44
---
55

6-
If you think you've found a bug in ESLint, please [create a new issue](https://github.com/eslint/eslint/issues/new/choose) or a [pull request](/docs/developer-guide/contributing/pull-requests) on GitHub.
6+
If you think you've found a bug in ESLint, please [create a new issue](https://github.com/eslint/eslint/issues/new/choose) or a [pull request](pull-requests) on GitHub.
77

88
Please include as much detail as possible to help us properly address your issue. If we need to triage issues and constantly ask people for more detail, that's time taken away from actually fixing issues. Help us be as efficient as possible by including a lot of detail in your issues.
99

docs/src/developer-guide/contributing/rule-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Occasionally, a core ESLint rule needs to be changed. This is not necessarily a
77

88
## Proposing a Rule Change
99

10-
To propose a change to an existing rule, [create a pull request](/docs/developer-guide/contributing/pull-requests) or [new issue](https://github.com/eslint/eslint/issues/new/choose) and fill out the template.
10+
To propose a change to an existing rule, [create a pull request](pull-requests) or [new issue](https://github.com/eslint/eslint/issues/new/choose) and fill out the template.
1111

1212
We need all of this information in order to determine whether or not the change is a good candidate for inclusion.
1313

docs/src/developer-guide/contributing/working-on-issues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Our public [issues tracker](https://github.com/eslint/eslint/issues) lists all o
77

88
## Issue Labels
99

10-
We use labels to indicate the status of issues. The most complete documentation on the labels is found in the [Maintainer Guide](https://eslint.org/docs/maintainer-guide/issues.html#when-an-issue-is-opened), but most contributors should find the information on this page sufficient. The most important questions that labels can help you, as a contributor, answer are:
10+
We use labels to indicate the status of issues. The most complete documentation on the labels is found in the [Maintainer Guide](../../maintainer-guide/issues#when-an-issue-is-opened), but most contributors should find the information on this page sufficient. The most important questions that labels can help you, as a contributor, answer are:
1111

1212
1. Is this issue available for me to work on? If you have little or no experience contributing to ESLint, the [`good first issue`](https://github.com/eslint/eslint/labels/good%20first%20issue) label marks appropriate issues. Otherwise, the [`help wanted`](https://github.com/eslint/eslint/labels/help%20wanted) label is an invitation to work on the issue. If you have more experience, you can try working on other issues labeled [`accepted`](https://github.com/eslint/eslint/labels/accepted). Conversely, issues not yet ready to work on are labeled `triage`, `evaluating`, and/or `needs bikeshedding`, and issues that cannot currently be worked on because of something else, such as a bug in a dependency, are labeled `blocked`.
13-
1. What is this issue about? Labels describing the nature of issues include `bug`, `enhancement`, `feature`, `question`, `rule`, `documentation`, `core`, `build`, `cli`, `infrastructure`, `breaking`, and `chore`. These are documented in the [Maintainer Guide](https://eslint.org/docs/maintainer-guide/issues.html#types-of-issues).
13+
1. What is this issue about? Labels describing the nature of issues include `bug`, `enhancement`, `feature`, `question`, `rule`, `documentation`, `core`, `build`, `cli`, `infrastructure`, `breaking`, and `chore`. These are documented in the [Maintainer Guide](../../maintainer-guide/issues#types-of-issues).
1414
1. What is the priority of this issue? Because we have a lot of issues, we prioritize certain issues above others. The following is the list of priorities, from highest to lowest:
1515

1616
1. **Bugs** - problems with the project are actively affecting users. We want to get these resolved as quickly as possible.

docs/src/developer-guide/nodejs-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -489,8 +489,8 @@ The most important method on `Linter` is `verify()`, which initiates linting of
489489
* **Note**: If you want to lint text and have your configuration be read and processed, use [`ESLint#lintFiles()`][eslint-lintfiles] or [`ESLint#lintText()`][eslint-linttext] instead.
490490
* `options` - (optional) Additional options for this run.
491491
* `filename` - (optional) the filename to associate with the source code.
492-
* `preprocess` - (optional) A function that [Processors in Plugins](/docs/developer-guide/working-with-plugins#processors-in-plugins) documentation describes as the `preprocess` method.
493-
* `postprocess` - (optional) A function that [Processors in Plugins](/docs/developer-guide/working-with-plugins#processors-in-plugins) documentation describes as the `postprocess` method.
492+
* `preprocess` - (optional) A function that [Processors in Plugins](working-with-plugins#processors-in-plugins) documentation describes as the `preprocess` method.
493+
* `postprocess` - (optional) A function that [Processors in Plugins](working-with-plugins#processors-in-plugins) documentation describes as the `postprocess` method.
494494
* `filterCodeBlock` - (optional) A function that decides which code blocks the linter should adopt. The function receives two arguments. The first argument is the virtual filename of a code block. The second argument is the text of the code block. If the function returned `true` then the linter adopts the code block. If the function was omitted, the linter adopts only `*.js` code blocks. If you provided a `filterCodeBlock` function, it overrides this default behavior, so the linter doesn't adopt `*.js` code blocks automatically.
495495
* `disableFixes` - (optional) when set to `true`, the linter doesn't make either the `fix` or `suggestions` property of the lint result.
496496
* `allowInlineConfig` - (optional) set to `false` to disable inline comments from changing ESLint rules.
@@ -686,7 +686,7 @@ Map {
686686
### Linter#defineParser
687687

688688
Each instance of `Linter` holds a map of custom parsers. If you want to define a parser programmatically, you can add this function
689-
with the name of the parser as first argument and the [parser object](/docs/developer-guide/working-with-custom-parsers) as second argument. The default `"espree"` parser will already be loaded for every `Linter` instance.
689+
with the name of the parser as first argument and the [parser object](working-with-custom-parsers) as second argument. The default `"espree"` parser will already be loaded for every `Linter` instance.
690690

691691
```js
692692
const Linter = require("eslint").Linter;
@@ -918,7 +918,7 @@ ruleTester.run("my-rule", myRule, {
918918
---
919919

920920
[configuration object]: ../user-guide/configuring/
921-
[builtin-formatters]: https://eslint.org/docs/user-guide/formatters/
921+
[builtin-formatters]: ../user-guide/formatters/
922922
[third-party-formatters]: https://www.npmjs.com/search?q=eslintformatter
923923
[eslint-lintfiles]: #-eslintlintfilespatterns
924924
[eslint-linttext]: #-eslintlinttextcode-options

docs/src/developer-guide/selectors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ If multiple selectors have equal specificity, their listeners will be called in
9393

9494
### Restricting syntax with selectors
9595

96-
With the [no-restricted-syntax](/docs/rules/no-restricted-syntax) rule, you can restrict the usage of particular syntax in your code. For example, you can use the following configuration to disallow using `if` statements that do not have block statements as their body:
96+
With the [no-restricted-syntax](../rules/no-restricted-syntax) rule, you can restrict the usage of particular syntax in your code. For example, you can use the following configuration to disallow using `if` statements that do not have block statements as their body:
9797

9898
```json
9999
{

docs/src/developer-guide/working-with-custom-formatters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ error semi
376376

377377
### Complex Argument Passing
378378

379-
If you find the custom formatter pattern doesn't provide enough options for the way you'd like to format ESLint results, the best option is to use ESLint's built-in [JSON formatter](https://eslint.org/docs/user-guide/formatters/) and pipe the output to a second program. For example:
379+
If you find the custom formatter pattern doesn't provide enough options for the way you'd like to format ESLint results, the best option is to use ESLint's built-in [JSON formatter](../user-guide/formatters/) and pipe the output to a second program. For example:
380380

381381
```bash
382382
eslint -f json src/ | your-program-that-reads-JSON --option

docs/src/developer-guide/working-with-plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ The plugin support was introduced in ESLint version `0.8.0`. Ensure the `peerDep
222222

223223
### Testing
224224

225-
ESLint provides the [`RuleTester`](/docs/developer-guide/nodejs-api#ruletester) utility to make it easy to test the rules of your plugin.
225+
ESLint provides the [`RuleTester`](nodejs-api#ruletester) utility to make it easy to test the rules of your plugin.
226226

227227
### Linting
228228

docs/src/developer-guide/working-with-rules.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ The `context` object contains additional functionality that is helpful for rules
129129

130130
* `parserOptions` - the parser options configured for this run (more details [here](../user-guide/configuring/language-options#specifying-parser-options)).
131131
* `id` - the rule ID.
132-
* `options` - an array of the [configured options](/docs/user-guide/configuring/rules#configuring-rules) for this rule. This array does not include the rule severity. For more information, see [here](#contextoptions).
133-
* `settings` - the [shared settings](/docs/user-guide/configuring/configuration-files#adding-shared-settings) from configuration.
132+
* `options` - an array of the [configured options](../user-guide/configuring/rules#configuring-rules) for this rule. This array does not include the rule severity. For more information, see [here](#contextoptions).
133+
* `settings` - the [shared settings](../user-guide/configuring/configuration-files#adding-shared-settings) from configuration.
134134
* `parserPath` - the name of the `parser` from configuration.
135135
* `parserServices` - an object containing parser-provided services for rules. The default parser does not provide any services. However, if a rule is intended to be used with a custom parser, it could use `parserServices` to access anything provided by that parser. (For example, a TypeScript parser could provide the ability to get the computed type of a given node.)
136136

@@ -373,7 +373,7 @@ Best practices for fixes:
373373
({ "foo": 1 })
374374
```
375375

376-
* This fixer can just select a quote type arbitrarily. If it guesses wrong, the resulting code will be automatically reported and fixed by the [`quotes`](/docs/rules/quotes) rule.
376+
* This fixer can just select a quote type arbitrarily. If it guesses wrong, the resulting code will be automatically reported and fixed by the [`quotes`](../rules/quotes) rule.
377377

378378
Note: Making fixes as small as possible is a best practice, but in some cases it may be correct to extend the range of the fix in order to intentionally prevent other rules from making fixes in a surrounding range in the same pass. For instance, if replacement text declares a new variable, it can be useful to prevent other changes in the scope of the variable as they might cause name collisions.
379379

@@ -714,7 +714,7 @@ You can access that code path objects with five events related to code paths.
714714

715715
Each bundled rule for ESLint core must have a set of unit tests submitted with it to be accepted. The test file is named the same as the source file but lives in `tests/lib/`. For example, if the rule source file is `lib/rules/foo.js` then the test file should be `tests/lib/rules/foo.js`.
716716

717-
ESLint provides the [`RuleTester`](/docs/developer-guide/nodejs-api#ruletester) utility to make it easy to write tests for rules.
717+
ESLint provides the [`RuleTester`](nodejs-api#ruletester) utility to make it easy to write tests for rules.
718718

719719
## Performance Testing
720720

0 commit comments

Comments
 (0)