[PSC-2029] Add lint rule to prevent trailing forward slashes #2154
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In an attempt to increase consistency across endpoints, Airtasker wants to avoid having endpoints whose path ends with a trailing forward slash. This PR adds a lint rule that rejects contracts containing endpoints with a trailing forward slash. To maintain backwards compatibility, the default `LintConfig` has been updated to only `warn` on such issues. The rule can be enforced by running `spot lint <api.rs> --no-trailing-forward-slash=error` The rule can be fully disabled by running `spot lint <api.ts> --no-trailing-forward-slash=off`.
flavray
commented
Nov 17, 2023
| @@ -12,7 +12,8 @@ export interface LintConfig { | |||
|
|
|||
| const lintConfig: LintConfig = { | |||
| rules: { | |||
| "no-omittable-fields-within-response-bodies": "warn" | |||
| "no-omittable-fields-within-response-bodies": "warn", | |||
| "no-trailing-forward-slash": "warn" | |||
There was a problem hiding this comment.
This is the default configuration used by the lint command. It can be overriden via command-line arguments since #2153
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description, Motivation and Context
In an attempt to increase consistency across endpoints, Airtasker wants to avoid having endpoints whose path ends with a trailing forward slash. This PR adds a lint rule that rejects contracts containing endpoints with a trailing forward slash.
To maintain backwards compatibility, the default
LintConfighas been updated to onlywarnon such issues.The rule can be enforced by running
spot lint <api.rs> --no-trailing-forward-slash=errorThe rule can be fully disabled by running
spot lint <api.ts> --no-trailing-forward-slash=off.Example output:
Checklist: