https://github.com/deathau/cooklang-js
CookLang-JS is a TypeScript library for parsing CookLang.
https://github.com/deathau/cooklang-js
cooklang
Last synced: 17 days ago
JSON representation
CookLang-JS is a TypeScript library for parsing CookLang.
- Host: GitHub
- URL: https://github.com/deathau/cooklang-js
- Owner: deathau
- License: mit-0
- Created: 2021-11-18T05:57:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-20T23:47:53.000Z (about 3 years ago)
- Last Synced: 2025-03-26T06:11:48.177Z (about 1 month ago)
- Topics: cooklang
- Language: TypeScript
- Homepage:
- Size: 114 KB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# CookLang-JS
CookLang-JS is a JavaScript library for parsing CookLang.
## Installation
`npm install cooklang`
## Usage
```javascript
import { Recipe } from 'cooklang'
const recipeString = `` // <- Your CookLang recipe
const recipe = new Recipe(recipeString);
console.log(recipe);
```
## Documentation
For the recipe structure and other documentation, check out cooklang.d.ts
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## Tests
Canonical tests as at https://github.com/cooklang/spec/blob/f67e56c69564369c785a93a28eeda2ed5b51c5ff/tests/canonical.yaml
(in the `__tests__` folder)
TODO: I want to keep the tests up-to-date with the meain branch instead of copying from the repo
## License
[MIT No Attribution](./LICENCE)