feat(devkit): prefer strings over Linter enum #27209
Merged
+117
−105
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 6db094f. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 5 targets
Sent with 💌 from NxCloud. |
There was a problem hiding this comment.
This makes sense to me. It makes the generators more straightforward to extend.
We'll need to make a similar change in many other generators from other plugins, and we probably want to deprecate the Linter enum. Could you expand this PR with those changes? Let me know if you're busy with other things and I can help.
isaacplmann
force-pushed
the
plugins/prefer-strings
branch
from
a01f75f to
b47c47d
Compare
AgentEnder
approved these changes
Aug 15, 2024
leosvelperez
approved these changes
Aug 16, 2024
Coly010
approved these changes
Aug 16, 2024
isaacplmann
force-pushed
the
plugins/prefer-strings
branch
from
8334476 to
a13bf49
Compare
FrozenPandaz
pushed a commit
that referenced
this pull request
Aug 21, 2024
We should be consistent about how options are defined in our plugins.
Currently, there are some options that use `enum`s and some that use
typed strings. I think typed strings are preferable because someone
extending a generator only needs to import the main generator that
they're extending, not all the transitive dependencies of that
generator.
Current extending code:
```
// ...
import { applicationGenerator as reactApplicationGenerator } from '@nx/react';
import { Linter } from '@nx/eslint';
export async function applicationGenerator(
tree: Tree,
options: ApplicationGeneratorSchema
) {
reactApplicationGenerator(tree, {
...options,
linter: Linter.EsLint,
});
}
```
Desired extending code:
```
// ...
import { applicationGenerator as reactApplicationGenerator } from '@nx/react';
export async function applicationGenerator(
tree: Tree,
options: ApplicationGeneratorSchema
) {
reactApplicationGenerator(tree, {
...options,
linter: 'eslint',
});
}
```
The problem is not just an extra line of code, the person extending the
`reactApplicationGenerator` has to dig into the implementation details
of the generator itself in order to know where to find the `Linter`
enum. The `e2eTestRunner` is already a typed string and is easily
extended.
The solution I'm proposing in this PR would define a typed string in the
same file as the existing enum. None of the implementations need to
change. No community plugin code will be broken.
(cherry picked from commit 839dc15)
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
We should be consistent about how options are defined in our plugins. Currently, there are some options that use
enums and some that use typed strings. I think typed strings are preferable because someone extending a generator only needs to import the main generator that they're extending, not all the transitive dependencies of that generator.Current extending code:
Desired extending code:
The problem is not just an extra line of code, the person extending the
reactApplicationGeneratorhas to dig into the implementation details of the generator itself in order to know where to find theLinterenum. Thee2eTestRunneris already a typed string and is easily extended.The solution I'm proposing in this PR would define a typed string in the same file as the existing enum. None of the implementations need to change. No community plugin code will be broken.