Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/americanexpress/babel-preset-amex
✨ Standard babel preset for American Express
https://github.com/americanexpress/babel-preset-amex
babel babel-preset build one-app preset transpile
Last synced: 4 days ago
JSON representation
✨ Standard babel preset for American Express
- Host: GitHub
- URL: https://github.com/americanexpress/babel-preset-amex
- Owner: americanexpress
- License: apache-2.0
- Created: 2017-06-01T17:22:46.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-06-27T16:04:45.000Z (5 months ago)
- Last Synced: 2024-10-28T17:16:56.235Z (16 days ago)
- Topics: babel, babel-preset, build, one-app, preset, transpile
- Language: JavaScript
- Homepage:
- Size: 935 KB
- Stars: 16
- Watchers: 18
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/babel-preset-amex)
> Standard babel preset for American Express
## 👩💻 Hiring 👨💻
Want to get paid for your contributions to `babel-preset-amex`?
> Send your resume to [email protected]
## 📖 Table of Contents
* [Usage](#-usage)
* [Contributing](#-contributing)
* [License](#%EF%B8%8F-license)
* [Code of Conduct](#%EF%B8%8F-code-of-conduct)
## 🤹 Usage
### Installation
```bash
npm install --save-dev babel-preset-amex
```
### Add to your `.babelrc` file
```json
{
"presets": ["amex"]
}
```
#### Options
By default `babel-preset-amex` will transpile for the "last 2 versions", "not dead" browsers, and CommonJS module syntax.
```json
{
"presets": [[
"amex",
{
"serverOnly": true,
"modern": true,
"moduleFormat": "esm"
}
]]
}
```
`serverOnly` - Will transpile only for node.
`modern` - Will transpile for [common browsers](./browserlist.js) n-1.
`moduleFormat` - Will transpile to ECMAScript module syntax. Any string other than `"esm"` will transpile to CommonJS module syntax.
#### Customizing Babel Config
Babel Preset Amex includes the following:
Presets
- [preset-env](https://babeljs.io/docs/en/babel-preset-env)
- [preset-react](https://babeljs.io/docs/en/babel-preset-react)
Plugins
- [plugin-syntax-dynamic-import](https://babeljs.io/docs/en/babel-plugin-syntax-dynamic-import)
- [plugin-proposal-class-properties](https://babeljs.io/docs/en/babel-plugin-proposal-class-properties)
- [plugin-proposal-export-default-from](https://babeljs.io/docs/en/babel-plugin-proposal-export-default-from)
- [plugin-proposal-optional-chaining](https://babeljs.io/docs/en/babel-plugin-proposal-optional-chaining)
- [babel-plugin-transform-react-remove-prop-types](https://www.npmjs.com/package/babel-plugin-transform-react-remove-prop-types)
If you wish to re-configure any of those presets do not redefine them
within your `.babelrc`. Instead you can configure them through the
`amex` preset.
```json
{
"presets": [
[
"amex",
{
"preset-env": {},
"preset-react": {}
}
]
]
}
```
## 🏆 Contributing
We welcome Your interest in the American Express Open Source Community on Github.
Any Contributor to any Open Source Project managed by the American Express Open
Source Community must accept and sign an Agreement indicating agreement to the
terms below. Except for the rights granted in this Agreement to American Express
and to recipients of software distributed by American Express, You reserve all
right, title, and interest, if any, in and to Your Contributions. Please [fill
out the Agreement](https://cla-assistant.io/americanexpress/babel-preset-amex).
Please feel free to open pull requests and see [CONTRIBUTING.md](./CONTRIBUTING.md) to learn how to get started contributing.
## 🗝️ License
Any contributions made under this project will be governed by the [Apache License 2.0](./LICENSE.txt).
## 🗣️ Code of Conduct
This project adheres to the [American Express Community Guidelines](./CODE_OF_CONDUCT.md).
By participating, you are expected to honor these guidelines.