Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rwjblue/ember-cli-cjs-transform
https://github.com/rwjblue/ember-cli-cjs-transform
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rwjblue/ember-cli-cjs-transform
- Owner: rwjblue
- License: mit
- Created: 2017-11-17T23:14:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-10-04T08:49:29.000Z (almost 3 years ago)
- Last Synced: 2024-07-12T10:44:04.585Z (3 months ago)
- Language: JavaScript
- Size: 1.17 MB
- Stars: 48
- Watchers: 4
- Forks: 12
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ember - ember-cli-cjs-transform - CommonJS imports. (Packages / Include external JS code)
README
# ember-cli-cjs-transform
This addon allows importing files that are in the CommonJS format via the
standard `app.import` functionality added in ember-cli 2.16.
## Installing
```
ember install ember-cli-cjs-transform
```
## Usage
In your `ember-cli-build.js` file just like the `amd` transform!
For example, add the following to import `some-name`'s `index.js` into your build:
```js
app.import('node_modules/some-name/index.js', {
using: [
{ transformation: 'cjs', as: 'some-name' }
]
});
```
At build time we automatically follow all dependencies (e.g. internal `require`
calls) in the source file, and includes their contents in the final build
output.
This means that even for reasonably complicated things, we can `app.import` the
"entry point" files and everything "just" works.
Examples (used while testing functionality):
Bringing in `showdown` and `showdown-highlight` for usage (without extra "shim" addon packages!):
```js
app.import('node_modules/showdown/dist/showdown.js', {
using: [{ transformation: 'cjs', as: 'showdown' }]
});
app.import('node_modules/showdown-highlight/lib/index.js', {
using: [{ transformation: 'cjs', as: 'showdown-highlight' }]
});
app.import('node_modules/highlight.js/styles/tomorrow-night.css');
```
There may be cases where you need additional rollup plugins in order to import your CommonJs files. For example, you may need to handle builtin node require statements, i.e.
```
var path = require('path');
```
For this, you may want to import the rollup plugin `rollup-plugin-node-builtins`. In order to do this, include the plugin in your `package.json` and use the following syntax in your `ember-cli-build.js` or `index.js`:
```js
const nodeBuiltins = require('rollup-plugin-node-builtins');
app.import('node_modules/some-name/index.js', {
using: [
{ transformation: 'cjs', as: 'some-name', plugins: [ nodeBuiltins() ]}
]
});
```
You can include multiple rollup plugins in the array and pass in options via the arguments to your plugin creation function.
```js
app.import('node_modules/some-name/index.js', {
using: [
{
transformation: 'cjs',
as: 'some-name',
plugins: [
plugin1(),
plugin2({ option1: "value" })
]
}
]
});
```
## Contributing
### Installation
* `git clone ` this repository
* `cd ember-cli-cjs-transform`
* `yarn install`
### Running
* `ember serve`
* Visit your app at [http://localhost:4200](http://localhost:4200).
### Running Tests
* `yarn test` (Runs `ember try:each` to test your addon against multiple Ember versions)
* `ember test`
* `ember test --server`
### Building
* `ember build`
For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).