Skip to content

Parser for experimental language named Chearmyp

License

Notifications You must be signed in to change notification settings

KennethTrecy/chearmyp_parser

Repository files navigation

Library Tests GitHub lines GitHub release (latest SemVer) GitHub closed issues count GitHub pull request count Commits since latest version Lines of code GitHub code size in bytes

Chearmyp

This is an experimental, general purpose, human-readable, language. In this context, general purpose means that it can be used as a markup, programming, command, and more.

Origin

Some parts of the repository was based from filled_bare_metal branch of Feo Template.

The mechanism of the parser was based on Chearmyp reference.

Parser

This repository contains a parser library for Chearmyp which represents the source as syntax tree.

Lexer

The lexer has been forked. Visit the repository of the lexer for more details.

Usage

Installation

Add it to the dependencies:

[dependencies.chearmyp_parser]
git = "https://github.com/KennethTrecy/chearmyp_parser"
tag = "v1.0.0"

You may also activate all the features:

[dependencies.chearmyp_parser]
git = "https://github.com/KennethTrecy/chearmyp_parser"
tag = "v1.0.0"
features = ["no_std"]

You generate the documentation by the running following code below:

cargo doc --all-features --open

Initialization

If you want to contribute, this repository should be initialized to adhere in Conventional Commits specification for organize commits and automated generation of change log.

Prerequisites

Instructions

By running the command below, all your commits will be linted to follow the Conventional Commits specification.

$ npm install

Or if you have installed pnpm, run the following command:

$ pnpm install

To generate the change log automatically, run the command below:

$ npx changelogen --from=[tag name or branch name or commit itself] --to=master

Notes

License

The repository is licensed under MIT.

Want to contribute?

Read the contributing guide for different ways to contribute in the project.

Author

Chearmyp Parser was created by Kenneth Trecy Tobias.