Skip to content

KennethTrecy/chearmyp_lexer

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 Lexer

A lexer for Chearmyp language.

This library represents the source as a queue of tokens.

Installation

Add it to the dependencies:

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

You may also activate all the features:

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

Origin

It was in a repository with the parser library. Yet it has been forked as some possible use cases may not need a parser.

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

Code

Most functions in the library uses abstract tokens and token queues so it can be used with different implementations of Chearmyp token and token queues.

Usage

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 Lexer was created by Kenneth Trecy Tobias.