feat(custom-esbuild): add support for plugin configuration #1683

spike-rabbit · 2024-02-20T15:28:18Z

PR Checklist

Please check if your PR fulfills the following requirements:

Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

esbuild plugin options cannot be provided

Issue Number: #1661

What is the new behavior?

esbuild plugin options can be provided using

{
   "plugins": ["without-options",  { "path" : "with-options", "options" : {}}]
}

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

examples/custom-esbuild/sanity-esbuild-app-esm/esbuild/define-text-by-option-plugin.cjs

spike-rabbit · 2024-02-20T15:31:55Z

Can you give me a hint, how I can actually run the examples without copying things around?

just-jeb · 2024-02-20T22:08:22Z

@spike-rabbit Once you run yarn everything should be linked, so if you built, for example, custom-webpack, you should be able to go to the folder with examples and run their build/test targets.
If you just want to run the whole set of tests then you can run yarn ci in custom-webpack package's root folder.

Did I answer your question or you meant something else?

spike-rabbit · 2024-02-22T08:24:01Z

Thx, I solved my problem. I should have run build before running the examples. Now it works

examples/custom-esbuild/sanity-esbuild-app-esm/esbuild/define-text-by-option-plugin.cjs

just-jeb · 2024-02-26T10:01:31Z

examples/custom-esbuild/sanity-esbuild-app-esm/esbuild/define-text-by-option-plugin.js

+    name: 'define-title',
+    setup(build) {
+      const options = build.initialOptions;
+      options.define.titleByOption = JSON.stringify(pluginOptions.title);


Same here (remove JSON.stringify)

examples/custom-esbuild/sanity-esbuild-app-esm/esbuild/define-text-by-option-plugin.ts

examples/custom-esbuild/sanity-esbuild-app/esbuild/define-text-by-option-plugin.js

examples/custom-esbuild/sanity-esbuild-app/esbuild/define-text-by-option-plugin.mjs

just-jeb · 2024-02-26T10:29:52Z

packages/custom-esbuild/README.md

@@ -112,7 +112,7 @@ Builder options:

 In the above example, we specify the list of `plugins` that should implement the ESBuild plugin schema. These plugins are custom user plugins and are added to the original ESBuild Angular configuration. Additionally, the `indexHtmlTransformer` property is used to specify the path to the file that exports the function used to modify the `index.html`.

-The plugin file can export either a single plugin or a list of plugins:
+The plugin file can export either a single plugin, a single plugin with configuration or a list of plugins:


I'd rephrase to:

The plugin file can export either a single plugin or a list of plugins. If a plugin accepts configuration then the config should be provided in `angular.json`:

spike-rabbit · 2024-03-04T08:26:35Z

@just-jeb I changed everything as requested.

Can you release the changes once this is merged?

arturovt · 2024-03-04T08:55:48Z

packages/custom-esbuild/README.md

@@ -100,7 +100,7 @@ Builder options:
  "build": {
    "builder": "@angular-builders/custom-esbuild:application",
    "options": {
-      "plugins": ["./esbuild/plugins.ts", "./esbuild/plugin-2.js"],
+      "plugins": ["./esbuild/plugins.ts", { "path": "./esbuild/plugin-2.js", "options": { "key": "value" } }],


Could we please have a more practical example demonstrating its usefulness? For instance, could you provide an example involving a real plugin that necessitates options, or perhaps share a scenario from your own application illustrating why it's essential?

makes sense for me, but I found a bug which makes using 3rd party plugins (almost) impossible.

Paths are always joined with the workspaceRoot loadModule<Plugin | Plugin[]>(path.join(workspaceRoot, pluginPath), tsConfig, logger). This makes it impossible to load modules by the package name.

I would propose to remove this and just use the plugin path without the workspace root. Unless I missed something, this would be inline with the behavior of custom-webpack.
If you agree, I can do this in another MR.

How about we merge it and have a separate PR for 3rd party plugins (and then update the example)?

@spike-rabbit Hmmm I wonder if that's the reason for JSON.stringify (CI fails now):

JSON stringify is back

updated the README

arturovt · 2024-03-07T15:33:47Z

packages/custom-esbuild/README.md

+// esbuild/plugins.ts
+import type { Plugin, PluginBuild } from 'esbuild';
+
+function defineRewritePathPlugin(options: { text: string }): Plugin {


This should be the esbuild/define-env.ts example, along with a practical illustration of how the stage parameter could be utilized. Please avoid providing text examples, as they are unnecessary.

The define.buildText only shows how to define the global compile-time constant, but the current showcase should illustrate how options are useful.

just-jeb · 2024-03-19T11:03:33Z

@arturovt is it all good from your perspective? Can we merge?

HazzMan2409 · 2024-11-05T15:17:55Z

Is there any update on this? As a consumer I would LOVE to be able to pass in configuration via the angular.json

spike-rabbit · 2024-11-11T10:05:58Z

Would indeed be nice having this merged. I am still available to do changes if needed

arturovt · 2024-11-11T10:27:57Z

@spike-rabbit can you rebase on master?

spike-rabbit · 2024-11-11T10:30:45Z

rebase done

spike-rabbit force-pushed the feat/support-esbuild-plugin-config branch from 81890a5 to aa53635 Compare February 20, 2024 15:30

spike-rabbit commented Feb 20, 2024

View reviewed changes

examples/custom-esbuild/sanity-esbuild-app-esm/esbuild/define-text-by-option-plugin.cjs Show resolved Hide resolved

spike-rabbit force-pushed the feat/support-esbuild-plugin-config branch 2 times, most recently from 8516e5d to 239abb4 Compare February 22, 2024 08:20

spike-rabbit force-pushed the feat/support-esbuild-plugin-config branch from 239abb4 to 6359159 Compare February 22, 2024 08:24

just-jeb approved these changes Feb 26, 2024

View reviewed changes

spike-rabbit force-pushed the feat/support-esbuild-plugin-config branch from 6359159 to cefcaf9 Compare March 4, 2024 08:20

arturovt reviewed Mar 4, 2024

View reviewed changes

spike-rabbit force-pushed the feat/support-esbuild-plugin-config branch from cefcaf9 to 6819f24 Compare March 7, 2024 07:32

arturovt reviewed Mar 7, 2024

View reviewed changes

spike-rabbit force-pushed the feat/support-esbuild-plugin-config branch from 6819f24 to 81f145d Compare March 13, 2024 07:59

arturovt approved these changes Nov 11, 2024

View reviewed changes

feat(custom-esbuild): add support for plugin configuration

fca7cfb

spike-rabbit force-pushed the feat/support-esbuild-plugin-config branch from 81f145d to fca7cfb Compare November 11, 2024 10:30

arturovt merged commit 9fbd32b into just-jeb:master Nov 11, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(custom-esbuild): add support for plugin configuration #1683

feat(custom-esbuild): add support for plugin configuration #1683

spike-rabbit commented Feb 20, 2024 •

edited

Loading

spike-rabbit commented Feb 20, 2024

just-jeb commented Feb 20, 2024

spike-rabbit commented Feb 22, 2024

just-jeb Feb 26, 2024

just-jeb Feb 26, 2024

spike-rabbit commented Mar 4, 2024

arturovt Mar 4, 2024

spike-rabbit Mar 4, 2024

just-jeb Mar 5, 2024

just-jeb Mar 6, 2024

spike-rabbit Mar 7, 2024

arturovt Mar 7, 2024 •

edited

Loading

spike-rabbit Mar 13, 2024

just-jeb commented Mar 19, 2024

HazzMan2409 commented Nov 5, 2024

spike-rabbit commented Nov 11, 2024

arturovt commented Nov 11, 2024

spike-rabbit commented Nov 11, 2024

feat(custom-esbuild): add support for plugin configuration #1683

feat(custom-esbuild): add support for plugin configuration #1683

Conversation

spike-rabbit commented Feb 20, 2024 • edited Loading

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

spike-rabbit commented Feb 20, 2024

just-jeb commented Feb 20, 2024

spike-rabbit commented Feb 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spike-rabbit commented Mar 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arturovt Mar 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

just-jeb commented Mar 19, 2024

HazzMan2409 commented Nov 5, 2024

spike-rabbit commented Nov 11, 2024

arturovt commented Nov 11, 2024

spike-rabbit commented Nov 11, 2024

spike-rabbit commented Feb 20, 2024 •

edited

Loading

arturovt Mar 7, 2024 •

edited

Loading