nx/packages/plugin/docs/generators/executor-examples.md
Leosvel Pérez Espinosa 28c53f942b
feat(misc): handle artifact generators' path options including file extensions (#29111)
<!-- 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
<!-- This is the behavior we have today -->

Artifact generators don't handle consistently receiving a file extension
in the `path` option.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

Artifact generators should handle receiving a file extension in the
`path` option. If the file extension is passed, the file path will be
treated as "complete" and used fully as provided. If the `path` provided
doesn't contain a file extension, the default extension will be appended
to it (or the one provided in a related option, e.g. `--language`,
`--js`, etc) together with the suffix for generators that use it.

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

Fixes #
2024-12-09 09:13:15 -05:00

41 lines
959 B
Markdown

## Examples
{% tabs %}
{% tab label="Basic executor" %}
Create a new executor called `build` at `tools/my-plugin/src/executors/build.ts`:
```bash
nx g @nx/plugin:executor tools/my-plugin/src/executors/build.ts
```
{% /tab %}
{% tab label="Without providing the file extension" %}
Create a new executor called `build` at `tools/my-plugin/src/executors/build.ts`:
```bash
nx g @nx/plugin:executor tools/my-plugin/src/executors/build
```
{% /tab %}
{% tab label="With different exported name" %}
Create a new executor called `custom` at `tools/my-plugin/src/executors/build.ts`:
```bash
nx g @nx/plugin:executor tools/my-plugin/src/executors/build.ts --name=custom
```
{% /tab %}
{% tab label="With custom hashing" %}
Create a new executor called `build` at `tools/my-plugin/src/executors/build.ts`, that uses a custom hashing function:
```bash
nx g @nx/plugin:executor tools/my-plugin/src/executors/build --includeHasher
```
{% /tab %}
{% /tabs %}