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.

Sign up for GitHub

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

Jump to bottom

[babel 8] Add docs for minimal/smart pipeline modes removal #2964

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[babel 8] Add docs for minimal/smart pipeline modes removal #2964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53e81ac
[babel 8] Add docs for minimal/smart pipeline modes removal
nicolo-ribaudo Sep 16, 2024
7624ac9
Also parser docs
nicolo-ribaudo Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/parser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,11 +378,21 @@ When a plugin is specified multiple times, only the first options are considered

- `pipelineOperator`:

- `proposal` (required, accepted values: `minimal`, `fsharp`, `hack`, ~~`smart`~~ (deprecated))
:::babel7
- `proposal` (required, accepted values: `fsharp`, `hack`, ~~`minimal`~~, ~~`smart`~~ (deprecated))
There are several different proposals for the pipeline operator.
This option chooses which proposal to use.
See [plugin-proposal-pipeline-operator](plugin-proposal-pipeline-operator.md)
for more information, including a table comparing their behavior.
:::

:::babel8
- `proposal` (required, accepted values: `fsharp`, `hack`)
There are several different proposals for the pipeline operator.
This option chooses which proposal to use.
See [plugin-proposal-pipeline-operator](plugin-proposal-pipeline-operator.md)
for more information, including a table comparing their behavior.
:::

- `topicToken` (required when `proposal` is `hack`, accepted values: `%`, `#`, `^`, `@@`, `^^`)
The `hack` proposal uses a “topic” placeholder in its pipe.
Expand Down
21 changes: 19 additions & 2 deletions docs/plugin-proposal-pipeline-operator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,33 @@ The pipeline operator has several competing proposals.
Configure which proposal to use with the required `"proposal"` option.
Its value is `"hack"` by default.

:::babel7

| Value | Proposal | Version added |
| ----- | -------- | ------------- |
| `"hack"` | [Hack-style pipes](https://github.com/tc39/proposal-pipeline-operator) | `v7.15.0`
| ~~`"fsharp"`~~ | [F#-style pipes with `await`](https://github.com/valtech-nyc/proposal-fsharp-pipelines) | `v7.5.0`
| `"fsharp"` | [F#-style pipes with `await`](https://github.com/valtech-nyc/proposal-fsharp-pipelines) | `v7.5.0`
| ~~`"minimal"`~~ | [Minimal F#-style pipes](https://github.com/tc39/proposal-pipeline-operator/tree/abb51b3aef5c17d5971808aee49ebe6b75d7280f) | `v7.0.0`
| ~~`"smart"`~~ | [Smart-mix pipes](https://github.com/js-choi/proposal-smart-pipelines) (deprecated) | `v7.3.0`

:::

:::babel8

| Value | Proposal |
| ----- | -------- |
| `"hack"` | [Hack-style pipes](https://github.com/tc39/proposal-pipeline-operator) |
| `"fsharp"` | [F#-style pipes with `await`](https://github.com/valtech-nyc/proposal-fsharp-pipelines) |

:::

If `"proposal"` is omitted, or if `"proposal": "hack"` is used, then a `"topicToken"` option must be included. The `topicToken` must be one of `"%"`, `"^^"`, `"@@"`, `"^"`, or `"#"`.

The `"proposal": "minimal"`, `"fsharp"`, and `"smart"` options are **deprecated** and subject to removal in a future major version.
:::babel7

The `"proposal": "minimal"` and `"smart"` options are **deprecated** and subject to removal in a future major version.

:::

### Examples
The following examples use `topicToken: "^^"`.
Expand Down