Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Local-executor generation of plugin for "Write a Simple Executor" #25191

Closed
3 tasks
cdwheatley opened this issue May 22, 2024 · 1 comment · Fixed by #27139
Closed
3 tasks

Local-executor generation of plugin for "Write a Simple Executor" #25191

cdwheatley opened this issue May 22, 2024 · 1 comment · Fixed by #27139

Comments

@cdwheatley
Copy link
Contributor

cdwheatley commented May 22, 2024

Documentation issue

  • Reporting a typo
  • [ x] Reporting a documentation bug
  • Documentation improvement
  • Documentation feedback

Is there a specific documentation page you are reporting?

Enter the URL or documentation section here.
https://nx.dev/extending-nx/recipes/local-executors

Additional context or description

When generating a new plugin there is the following line:
nx g @nx/plugin:plugin my-plugin
This generates the plugin my-plugin in the root of the project, but in the next code section the path libs/my-plugin is used:
nx generate @nx/plugin:executor echo --directory=libs/my-plugin/src/executors/echo

It would be helpful to update the documentation for the generation of the plugin to be like:
nx g @nx/plugin:plugin libs/my-plugin
or whatever the best practice is for generating a plugin

Provide any additional details here as needed.

jaysoo pushed a commit that referenced this issue Jul 26, 2024
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
Some plugin docs don't make sense after project name and root changes

## Expected Behavior
They've been touched up

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #25191
FrozenPandaz pushed a commit that referenced this issue Jul 30, 2024
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
Some plugin docs don't make sense after project name and root changes

## Expected Behavior
They've been touched up

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #25191

(cherry picked from commit 97b0084)
Copy link

This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants