feat(eslint-config-fluid): Add how to add a new eslint rule in eslint-plugin-fluid package.
#23004
+86
−0
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
|
🔗 Found some broken links! 💔 Run a link check locally to find them. See linkcheck output |
alexvy86
reviewed
Nov 6, 2024
|
|
||
| Directory structure: | ||
|
|
||
| ```plaintext |
There was a problem hiding this comment.
Need to close this code block before point 3 below. Also, I think all of it and "DIrectory structure" above don't need the extra indentation.
|
|
||
| Once PR 1 is merged, publish the new version of `@fluid-internal/eslint-plugin-fluid` by following the steps: | ||
|
|
||
| 1. **Publish**: Follow the [guide](https://eng.ms/docs/experiences-devices/opg/office-shared/fluid-framework/fluid-framework-internal/fluid-framework/docs/on-call/release/release) to publish the new version of `@fluid-internal/eslint-plugin-fluid`. |
There was a problem hiding this comment.
Let's just point to "the guidance in our internal documentation" but avoid the link. We probably shouldn't link directly to internal documentation from the public repo.
|
|
||
| ### 4. Add New Rule to the Appropriate Config | ||
|
|
||
| Depending on the scope of the rule, add it to one of the following configurations (NOTE: `recommended` extends thre `minimal-deprecated.js`): |
There was a problem hiding this comment.
Suggested change
| Depending on the scope of the rule, add it to one of the following configurations (NOTE: `recommended` extends thre `minimal-deprecated.js`): | |
| Depending on the scope of the rule, add it to one of the following configurations (NOTE: `recommended` extends `minimal-deprecated.js`): |
| ```json | ||
| { | ||
| "pnpmOverrides": { | ||
| "@fluidframework/eslint-config-fluid": "file:<relative-path-to-config-directory>" |
There was a problem hiding this comment.
Suggested change
| "@fluidframework/eslint-config-fluid": "file:<relative-path-to-config-directory>" | |
| "@fluidframework/eslint-config-fluid": "file:<relative-path-to-eslint-config-fluid-package>" |
|
|
||
| ### 5. Publish New Version of `eslint-config-fluid` | ||
|
|
||
| Once the PR is merged, publish the new version of `eslint-config-fluid` following the [guide](https://eng.ms/docs/experiences-devices/opg/office-shared/fluid-framework/fluid-framework-internal/fluid-framework/docs/on-call/release/release). |
There was a problem hiding this comment.
Same as above regarding the link.
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
22739
This PR adds step by step instructions for:
estlint-plugin-fluideslint-plugin-fluidversioneslint-config-fluidversion