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

Added README for esbuild package #1416

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

Conversation

porhkz
Copy link

@porhkz porhkz commented Dec 19, 2024

Description of the proposed changes

Added initial README for esbuild, backwards engineering the definitions from the code. README includes:

  • A description including the purpose of this construct
  • Package name
  • Package version (using badges)
  • Example code
  • Links to esbuild API manual

Screenshots (if applicable)

Other solutions considered (if any)

Notes to PR author

Notes to reviewers

@porhkz porhkz requested review from a team, TheOrangePuff and finnholland and removed request for a team December 19, 2024 02:02
@porhkz porhkz changed the title Chore/do 1759 add readme edbuild Added README for esbuild package Dec 19, 2024
Copy link
Contributor

@TheOrangePuff TheOrangePuff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just a few minor things

@@ -0,0 +1,140 @@
# ESbuild
Esbuild is a module bundler and minifier for JavaScript and CSS.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this might work with CSS, we don't use that here. We just use it to bundle JS and TS 🙂

},
});
```
where `process.env.EXAMPLE_VAR` is replace with `exampleValue`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replace -> replaced

Default: **info**

### `sourcemap` (boolean, default)
Source maps encode the information necessary to translate from a line/column offset in a generate output file back to a line/column offset in the corresponding original input file. Supported for both Javascript and CSS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again I'd just remove the reference to CSS

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants