https://github.com/thesharks/jagtag-js

A JavaScript port of the JagTag text parsing language.
https://github.com/thesharks/jagtag-js

discord jagtag jagtag-js jagtag-notation javascript

Last synced: 21 days ago
JSON representation

A JavaScript port of the JagTag text parsing language.

• Host: GitHub
• URL: https://github.com/thesharks/jagtag-js
• Owner: TheSharks
• License: mit
• Created: 2018-03-25T19:54:37.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-20T07:01:48.000Z (almost 2 years ago)
• Last Synced: 2024-07-31T09:35:00.864Z (5 months ago)
• Topics: discord, jagtag, jagtag-js, jagtag-notation, javascript
• Language: TypeScript
• Homepage: https://thesharks.github.io/JagTag-JS
• Size: 31.7 MB
• Stars: 17
• Watchers: 3
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# JagTag-JS

![Codecov](https://img.shields.io/codecov/c/github/thesharks/jagtag-js.svg) ![License](https://img.shields.io/github/license/thesharks/jagtag-js.svg) 

A JavaScript port of the [JagTag text parsing language](https://github.com/jagrosh/JagTag), originally written in Java by [@jagrosh](https://github.com/jagrosh).

This readme only covers technical information about JagTag-JS, for more comprehensive documentation about JagTag itself please see [the Spectra wiki](https://github.com/jagrosh/Spectra/wiki/JagTag) and the [original JagTag repo](https://github.com/jagrosh/JagTag)

## What is JagTag?

JagTag is, in the author's own words, a simple yet powerful and customisable interpreted text parsing language. In practice, JagTag notation is used to customise user input with tags which use the format **{name:arg1|arg2}**.

## How does this differ?

First of all, the implementation of JagTag has been ported to JavaScript. The key thing to note here is that the actual code has not been ported due to language limitations. Instead, this system is essentially JagTag notation implemented in JavaScript with a slightly different methodology.

Due to language-level limitations, some of the methods are also not fully compatible. This project has been developed with maximum compatibility in mind, but some minor changes have been made. More details can be found in the documentation.

It's worth noting that the Discord-related tag functions have been developed to suit [Eris](https://github.com/abalabahaha/eris) and have not been tested with other libraries. For now it's recommended to use Eris in conjunction with the Discord-related tags, if you wish to use those.

## Installation and usage

JagTag-JS is available on NPM and you can install it with `npm i @thesharks/jagtag-js`. Make sure you have Node.js >= 8 installed.

Basic syntax:

```js

import JagTagParser from '@thesharks/jagtag-js'

JagTagParser('string to parse', argsObject)

```

For more information about the args object, see the [API reference](https://thesharks.github.io/JagTag-JS/interfaces/interfaces_iparserarguments.iparserarguments.html).

### Simple example

At its most basic level, JagTag-JS can be used to perform simple string-related operations without any complications.

```js

import JagTagParser from '@thesharks/jagtag-js'

JagTagParser('change {upper:this} to uppercase')

// Returns 'change THIS to uppercase'

```

### Advanced example

More advanced operations may require you to pass arguments to the parser in order to function correctly. Please check the [documentation](https://thesharks.github.io/JagTag-JS/interfaces/interfaces_iparserarguments.iparserarguments.html) for information on what parser-level arguments need to be passed for which method.

```js

import JagTagParser from '@thesharks/jagtag-js'

JagTagParser('{argslen} arguments were passed to this tag', { tagArgs: [ 'item1', 'item2', 'item3' ] })

// Returns '3 arguments were passed to this tag'

```

### String interpolation

Since Javascript will attempt to interpret strings such as `'\d'` as character escapes, it's recommended to call the parser using `String.raw`.

```js

import JagTagParser from '@thesharks/jagtag-js'

JagTagParser('{replaceregex:\d|with:#|in:I have 5 cats and 23 shirts}')

// Returns: "I have 5 cats an# 23 shirts"

// Probably not what you wanted!

JagTagParser(String.raw`{replaceregex:\d|with:#|in:I have 5 cats and 23 shirts}`)

// Returns: "I have # cats and ## shirts"

```

## Contributing

See [CONTRIBUTING.md](.github/CONTRIBUTING.md).