Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yukihirop/babel-udf-helpers

A tool to create user-defined helpers that can be used in your babel plugin.
https://github.com/yukihirop/babel-udf-helpers

babel babel-plugin typescript-library

Last synced: 2 months ago
JSON representation

A tool to create user-defined helpers that can be used in your babel plugin.

Awesome Lists containing this project

README

        

# babel-udf-helpers

[![npm version](https://badge.fury.io/js/babel-udf-helpers.svg)](https://badge.fury.io/js/babel-udf-helpers)
![deploy docs](https://github.com/yukihirop/babel-udf-helpers/workflows/deploy%20docs/badge.svg)
[![CircleCI](https://circleci.com/gh/yukihirop/babel-udf-helpers.svg?style=svg)](https://circleci.com/gh/yukihirop/babel-udf-helpers)

A tool to create user-defined helpers that can be used in your babel plugin.
The usability is like that of @babel/helpers.

![image](https://user-images.githubusercontent.com/11146767/126738595-17935bce-8caf-4d39-a3dd-573cb15bde8a.png)

## 📦 Installation

```js
npm install --save-dev babel-udf-helpers
```

## ❤️ Support Version

- node.js (>=10.15)
- typescript target (ES2018)

## 📖 Usage

Use in your babel plugin as follows.
It works the same as babel-helpers addHelper, so you can use it anywhere in your visitor.

```js
import { useDangerousUDFHelpers } from 'babel-udf-helpers';
import helpers from './helpers';

export default function({types: t}){
pre(){
useDangerousUDFHelpers(this, { helpers });
},
visitor: {
Program(path){
this.addUDFHelper("programHelper")
},
ImportDeclaration(path) {
this.addUDFHelper("importHelper")
}
}
}
```

`helpers.js` looks like the following.

```js
import { helper } from 'babel-udf-helpers';

const helpers = Object.create(null);
export default helpers;

helpers.programHelper = helper`
export default function _programHelper(){
return "programHelper";
};
`

helpers.importHelper = helper`
export default function _importHelper(){
return "importHelper";
};
`
```

## 📚 Documents

Full docs are available at https://yukihirop.github.io/babel-udf-helpers

## ⚽ Example

Run the plugin test with `babel-udf-helpers` in typescript and javascript.

```bash
{
make all-deps
make example-test
}
```

## 📝 License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## 🤝 Contributing

1. Fork it ( http://github.com/yukihirop/babel-udf-helpers/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request