# data-weave-grimoire

**Repository Path**: mirrors_mulesoft/data-weave-grimoire

## Basic Information

- **Project Name**: data-weave-grimoire
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-06
- **Last Updated**: 2025-08-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Hello Wise Wizard. Welcome to the magic land of DataWeave.

This grimoire contains a collection of interesting DataWeave spells that can be executed with our [DataWeave CLI](https://github.com/mulesoft-labs/data-weave-native).

You can create your own grimoire and be part of the DataWeave Wizards Secret Club.

Let's start defining some concepts:

## Wizard
A `wizard` is just a user that we trust and we want to have all their `spells` available.

A `wizard` has a `grimoire`, a GitHub repository that is inferred by `https://github.com/${wizard_name}/${wizard_name}-data-weave-grimoire`, that includes all the `spells` from this `wizard`.

## Grimoire

A `grimoire` is a collection of `spells` created by a `wizard`. The `grimoire` is hosted in a GitHub repository in the default branch. Currently, there is no support for versioning or branching scheme.

## Spells

A `spell` is a DataWeave application that contains one or more DataWeave transformations (entry points) and is hosted in a GitHub repository. 
This makes it very easy to share and distribute across other `wizards` (users).

## DataWeave Grimoire

The DataWeave Grimoire is the default grimoire provided by the DataWeave CLI.

This grimoire contains the following spells:

| Spell        | Description                                                        |
|--------------|--------------------------------------------------------------------|
| HelloWizard  | Just a simple example that shows how to create a very basic spell. |
| CountWizards | Spell to find other DataWeave wizards.                             |
| Playground   | This spell will launch the playground UI.                          |

## How to Add a Wizard

In order to add a new `wizard` use the DataWeave CLI

```bash
dw --add-wizard <wizard_name>
```
The wizard's grimoire is going to be cloned at `{user.home}/.dw/grimoires`

:warning: **Do NOT add wizards you don't trust**

## Listing All the Available Spells

Using the `--list-spells` it will show all the available spells for each wizard with the documentation of each spell.

```bash
dw --list-spells
```

## How to Run a Spell

There are several ways to run a spell using the DataWeave CLI.

:warning: **Do NOT execute spells you don't trust**

### Running a Spell From a Wizard

```bash
dw --spell <wizard_name>/<spell_name>
```
The above command runs the spell located at `{user.home}/.dw/grimoires/<wizard_name>-grimoire/<spell_name>/src/Main.dwl`

### Running a Spell From the DataWeave Grimoire

```bash
dw --spell <spell_name>
```

The above command runs the spell located at `{user.home}/.dw/grimoires/data-weave-grimoire/<spell_name>/src/Main.dwl`

### Running a Spell From a Local Grimoire Folder

```bash
dw --local-spell <spell_name>
```

The above command runs the spell based on your current path location. The spell to run is located at `<current_path>/<spell_name>/src/Main.dwl`

## Becoming a DataWeave Wizard

### Step 1: Create Your GitHub Repository

In order to become a `wizard` first create your GitHub repository

```bash
https://github.com/${wizard_name}/${wizard_name}-data-weave-grimoire
```

Your wizard name is going to be your GitHub user id

### Step 2: Clone GitHub Repository

```bash
git clone https://github.com/${wizard_name}/${wizard_name}-data-weave-grimoire
```

### Step 3: Create a Spell

Inside your cloned repository run

```bash
dw --new-spell <spell_name>
```

### Step 3: Edit Your Spell

Use [DataWeave VSCode Plugin](https://marketplace.visualstudio.com/items?itemName=MuleSoftInc.dataweave) to develop your script.

```bash
code <spell_name>
```

### Step 4: Try it out

In order to test a local spell you can use

```bash
dw --local-spell <spell_name>
```

### Step 5: Push It and Distribute

Once your spell is finished push it to your repository and tell your friends to try it out.

## Running the DataWeave Playground Locally

The following example shows how run a DataWeave Playground locally:

```bash 
dw --eval --spell Playground
```

It is going to execute the `Playground` spell that is going to be located in `{user.home}/.dw/grimoires/data-weave-grimoire/Playground/src/Main.dwl`


## Contributions Welcome

Contributions to this project can be made through Pull Requests and Issues on the
[GitHub Repository](https://github.com/mulesoft-labs/data-weave-grimoire).

Before creating a pull request review the following:

* [LICENSE](LICENSE.txt)
* [SECURITY](SECURITY.md)
* [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md)

When you submit your pull request, you are asked to sign a contributor license agreement (CLA) if we don't have one on file for you