[WIP] Plugin Ordering #5735

hzoo · 2017-05-15T19:30:16Z

Summary

TL;DR - basic topological ordering of plugins.

Currently this is just the minimal change necessary to make class properties and decorators work (not a final approach or anything and not done yet)

This PR adds 2 more properties to the Plugin object:

capabilities: an array of values (currently a string, maybe better as a number/semver like in package.json) to represent what a plugin can transform
~~dependencies: an array of values to represent which syntax needs to be transformed after this plugin is run (it depends on that syntax being there beforehand so it should go first)~~
before/after: an array of values to represent which plugin capabilities should be run before/after

This is technically not a breaking change since it's opt-in by the plugins but it would be easier done in 7.x?

TODO

can defer to separate discussion: how to specify dependencies and standardize on them (a string, package.json, semver)
- ~~maybe expose some symbols instead of a string? like babel.capabilities.arrowFunctions = Symbol()~~
~~handle cycles (dep A -> dep B -> dep C -> dep A) - just error with a good error message~~ this probably isn't an issue and/or we will fix it when it's reported
do we need to handle presets? seems ok
later: handle multiple plugins providing the same capability - error with a good message because the plugin/preset is being included multiple times
add dependencies/capabilities for all internal plugins
how to handle multiple passes (deprecate passPerPreset and introduce a new option to enable it per preset individually?) - maybe not as important
how does this tie into preset-env (native environments provide the same capabilities and we need to use the same interface) https://github.com/babel/babel-preset-env/blob/master/data/plugin-features.js

Use case

plugin ordering of official plugins (both in spec and proposals)
third party plugins ordering
fork on outputting syntax based on capabilities
better config validation

cc @benjamn, @rwjblue

mention-bot · 2017-05-15T19:30:17Z

@hzoo, thanks for your PR! By analyzing the history of the files in this pull request, we identified @loganfsmyth, @Alxpy and @existentialism to be potential reviewers.

hzoo · 2017-05-15T21:04:12Z

packages/babel-plugin-transform-class-properties/src/index.js

@@ -42,6 +42,8 @@ export default function ({ types: t }) {
  return {
    inherits: syntaxClassProperties,

+    capabilities: ["classProperties"],


Opt-in so 3rd party plugins can also provide capabilities/dependencies. Right now it's just a string but maybe it should be a versioned number?

rwjblue · 2017-05-16T17:42:16Z

I like it, thanks for working on this! As I reviewed the sortPlugins logic I thought you might be able to take advantage of dag-map which is what ember-cli uses for a similar purpose.

hzoo · 2017-05-16T21:04:50Z

Thinking about it now, it's probably fine to not have every plugin have to have a capability anyway since it's opt-in and can be incremented added if someone needs it. It's easiest to do for proposals ironically.

hzoo · 2017-05-17T15:40:09Z

Ok as discussed on slack, maybe dependencies isn't a good word for this because for this specific case. as @rwjblue describes:

plugin-a literally requires that plugin-b exists (currently what inherits already does)
plugin-a wants to know that it is ran before plugin-b if it happens to exist (kinda like an optionalDependency and specifying order)

ok maybe as a first pass "dependencies" are optional, we keep inherits

node_modules are required to exists so that flow can inference the types

codecov · 2017-06-13T15:03:50Z

Codecov Report

Merging #5735 into 7.0 will increase coverage by 0.04%.
The diff coverage is 88.31%.

@@            Coverage Diff             @@
##              7.0    #5735      +/-   ##
==========================================
+ Coverage   85.09%   85.14%   +0.04%     
==========================================
  Files         284      284              
  Lines        9911     9942      +31     
  Branches     2768     2769       +1     
==========================================
+ Hits         8434     8465      +31     
+ Misses        976      974       -2     
- Partials      501      503       +2

Impacted Files	Coverage Δ
...ges/babel-plugin-transform-decorators/src/index.js	`94.28% <ø> (+0.95%)`	⬆️
packages/babel-core/src/config/index.js	`50% <ø> (ø)`	⬆️
...bel-plugin-transform-class-properties/src/index.js	`94.59% <ø> (ø)`	⬆️
packages/babel-core/src/config/plugin.js	`36.36% <33.33%> (-1.14%)`	⬇️
packages/babel-core/src/config/option-manager.js	`78.12% <92.15%> (+1.93%)`	⬆️
...ckages/babel-core/src/transformation/file/index.js	`87.25% <95%> (+0.05%)`	⬆️
packages/babel-traverse/src/visitors.js	`86.66% <0%> (+0.95%)`	⬆️
packages/babel-traverse/src/path/modification.js	`73.07% <0%> (+0.96%)`	⬆️
packages/babel-traverse/src/path/context.js	`87.06% <0%> (+1.72%)`	⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5cc1cbf...3e27d17. Read the comment docs.

sarupbanskota · 2017-06-30T06:46:36Z

packages/babel-core/src/config/option-manager.js

+  plugins.forEach((pluginTuple, index) => {
+    const plugin = pluginTuple[0];
+    if (!plugin.key) { plugin.key = `${unnamedPluginPrefix}${index}`; }
+  });


we probably don't need this bit anymore, given that we're making name compulsory. i'll remove it in my naming PR

sarupbanskota · 2017-06-30T07:22:11Z

packages/babel-core/src/config/option-manager.js

+    if (plugin.capabilities) {
+      plugin.capabilities.forEach((capability) => {
+        const existingPluginName = capabilitiesToPluginIdMap[capability];
+        if (existingPluginName !== undefined) {


prob safer to just say if (existingPluginName), this way empty strings can also be caught. (although that shouldn't be allowed in the first place).

sarupbanskota · 2017-07-03T23:46:24Z

packages/babel-core/src/config/plugin.js

+      throw new Error("Plugin .after must be an array");
+    }
+    if (!Array.isArray(plugin.before)) {
+      throw new Error("Plugin .before must be an array");


Naive thinking perhaps, but judging by the conditionals above this one, it may freak out if plugin.before / plugin.after isn't present.

sarupbanskota · 2017-07-03T23:47:20Z

packages/babel-core/src/config/plugin.js

@@ -31,7 +34,8 @@ export default class Plugin {
    this.pre = plugin.pre;
    this.visitor = plugin.visitor;
    this.capabilities = plugin.capabilities;
-    this.dependencies = plugin.dependencies;
+    this.after = plugin.after;
+    this.before = plugin.before;


based on my prev comment, might wanna do a this.x = plugin.x || []; to account for cases where its not present?

sarupbanskota · 2017-07-06T18:31:41Z

hi @hzoo, on #5911, I've synced work on this branch with 7.0. Went a little nuts trying to rebase, so I just did a merge. Would you pls review and merge it since I can't push directly to this branch?

Once that's done, I can get #5842 ready too - it's essentially good to go, but is failing because it depends on this branch which is currently failing.

cc @nathanhammond

hulkish

I feel like maybe a stronger approach here could be to introduce some kind of lifecycle hooks concept... to start with would be those known plugins which require one in particular to come before the other.

swyxio · 2019-02-05T02:20:02Z

hello, trying to catch up on this. What's blocking this today? is the TODO at the top up to date?

WIP plugin ordering

667a714

hzoo added PR: New Feature 🚀 A type of pull request used for our changelog categories WIP labels May 15, 2017

hzoo requested a review from loganfsmyth May 15, 2017 19:39

hzoo changed the title ~~WIP plugin ordering~~ [WIP] Plugin Ordering May 15, 2017

hzoo requested a review from danez May 15, 2017 21:00

hzoo mentioned this pull request May 15, 2017

Discussion: Fix Plugin Ordering #5623

Closed

hzoo requested a review from gaearon May 15, 2017 21:02

hzoo commented May 15, 2017

View reviewed changes

hzoo removed the request for review from gaearon May 15, 2017 22:23

vigneshshanmugam mentioned this pull request May 18, 2017

Multiple passes? babel/minify#61

Open

This was referenced May 19, 2017

Transform do-expressions on exit #5694

Merged

Numeric Separator: Stage 1 babel/babylon#538

Closed

xtuc mentioned this pull request May 31, 2017

flowtype "declare var module" causes transform-flow-strip-types to transpile module to _module #5718

Open

hzoo mentioned this pull request May 31, 2017

Support for NumericLiteralSeparator, Stage 1 feature #5793

Merged

sarupbanskota mentioned this pull request Jun 2, 2017

Use dagMap to improve plugin ordering #5814

Merged

sarupbanskota and others added 9 commits June 3, 2017 10:04

Use dagMap to improve plugin ordering

042c2b6

Remove unnecessary plugin.

d81721d

Handle all plugins in a single pass.

a51eb7e

Ensure that sortPlugins is only called once.

88da829

Port complex ordering test to dag-map.

b265e41

Deduplicate plugins by plugin name. Use the first-encountered.

4cc41ec

Use Object.keys to generate values, to work around Node 6

761226b

Fix one flow error

3ef4031

Run bootstrap before running flow

42e2721

node_modules are required to exists so that flow can inference the types

MarckK mentioned this pull request Jun 6, 2017

[WIP] deprecates unnamed plugins and adds error message #5827

Closed

4 tasks

use before/after instead of dependencies (#5853)

3e27d17

hzoo mentioned this pull request Jun 13, 2017

Plugin Ordering (Part 2) #5854

Open

9 tasks

sarupbanskota reviewed Jun 30, 2017

View reviewed changes

sarupbanskota mentioned this pull request Jul 3, 2017

make test-ci-coverage & make test-only seem to install deps differently #5910

Closed

sarupbanskota reviewed Jul 3, 2017

View reviewed changes

sarupbanskota mentioned this pull request Jul 3, 2017

Attempt to fix tests on plugin ordering + cleanup #5911

Closed

hzoo requested a review from jridgewell July 21, 2017 00:23

danez closed this Aug 31, 2017

danez reopened this Aug 31, 2017

danez changed the base branch from 7.0 to master August 31, 2017 18:19

hulkish reviewed Nov 16, 2017

View reviewed changes

hzoo added the Priority: High label Nov 29, 2017

nicolo-ribaudo mentioned this pull request Jan 18, 2018

Flow property declarations are not removed #7233

Closed

swernerx mentioned this pull request Apr 26, 2018

Plugins are not executed before Presets (doc/impl error) + Exception combining preset-env+fast-async #7815

Open

alecmev mentioned this pull request Apr 28, 2018

Duplicate declaration "React" airbnb/babel-plugin-inline-react-svg#31

Closed

hzoo mentioned this pull request May 8, 2018

Babel Config Linter #7880

Open

daniel-nagy mentioned this pull request Dec 21, 2018

[Bug]: Decorators Conflict With Function Overloading #9220

Closed

armano2 mentioned this pull request Dec 24, 2018

Typescript: is not converting BooleanLiteral in types with [plugin, estree] #9228

Closed

JLHwung removed the Has PR label Nov 14, 2019

loganfsmyth removed their request for review February 16, 2021 18:59

danez removed their request for review July 7, 2022 21:45

jridgewell removed their request for review August 31, 2022 21:03

nicolo-ribaudo closed this Jul 20, 2023

nicolo-ribaudo deleted the plugin-ordering branch July 20, 2023 13:42

github-actions bot added the outdated A closed issue/PR that is archived due to age. Recommended to make a new issue label Oct 20, 2023

github-actions bot locked as resolved and limited conversation to collaborators Oct 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Plugin Ordering #5735

[WIP] Plugin Ordering #5735

hzoo commented May 15, 2017 •

edited

Loading

mention-bot commented May 15, 2017

hzoo May 15, 2017

rwjblue commented May 16, 2017

hzoo commented May 16, 2017 •

edited

Loading

hzoo commented May 17, 2017 •

edited

Loading

codecov bot commented Jun 13, 2017 •

edited

Loading

sarupbanskota Jun 30, 2017

sarupbanskota Jun 30, 2017 •

edited

Loading

sarupbanskota Jul 3, 2017

sarupbanskota Jul 3, 2017

sarupbanskota commented Jul 6, 2017 •

edited

Loading

hulkish left a comment

swyxio commented Feb 5, 2019

[WIP] Plugin Ordering #5735

[WIP] Plugin Ordering #5735

Conversation

hzoo commented May 15, 2017 • edited Loading

Summary

TODO

Use case

mention-bot commented May 15, 2017

hzoo May 15, 2017

Choose a reason for hiding this comment

rwjblue commented May 16, 2017

hzoo commented May 16, 2017 • edited Loading

hzoo commented May 17, 2017 • edited Loading

codecov bot commented Jun 13, 2017 • edited Loading

Codecov Report

sarupbanskota Jun 30, 2017

Choose a reason for hiding this comment

sarupbanskota Jun 30, 2017 • edited Loading

Choose a reason for hiding this comment

sarupbanskota Jul 3, 2017

Choose a reason for hiding this comment

sarupbanskota Jul 3, 2017

Choose a reason for hiding this comment

sarupbanskota commented Jul 6, 2017 • edited Loading

hulkish left a comment

Choose a reason for hiding this comment

swyxio commented Feb 5, 2019

hzoo commented May 15, 2017 •

edited

Loading

hzoo commented May 16, 2017 •

edited

Loading

hzoo commented May 17, 2017 •

edited

Loading

codecov bot commented Jun 13, 2017 •

edited

Loading

sarupbanskota Jun 30, 2017 •

edited

Loading

sarupbanskota commented Jul 6, 2017 •

edited

Loading