{"id":18790245,"url":"https://github.com/chevrotain/quick-start","last_synced_at":"2025-04-13T14:30:40.090Z","repository":{"id":42796586,"uuid":"271669987","full_name":"Chevrotain/quick-start","owner":"Chevrotain","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-15T20:13:27.000Z","size":802,"stargazers_count":2,"open_issues_count":13,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-03-25T20:28:24.301Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Chevrotain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-12T00:02:11.000Z","updated_at":"2022-10-23T15:19:29.000Z","dependencies_parsed_at":"2023-02-05T18:00:58.264Z","dependency_job_id":null,"html_url":"https://github.com/Chevrotain/quick-start","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chevrotain%2Fquick-start","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chevrotain%2Fquick-start/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chevrotain%2Fquick-start/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chevrotain%2Fquick-start/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Chevrotain","download_url":"https://codeload.github.com/Chevrotain/quick-start/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223589110,"owners_count":17169898,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T21:10:44.970Z","updated_at":"2024-11-07T21:10:45.668Z","avatar_url":"https://github.com/Chevrotain.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\n\nThis is the typescript based starter pack npm module to develop a parser/serializer for a language using [Chevortain](https://sap.github.io/chevrotain/docs/)\nparser toolkit.\n\nIt bootstraps following constructs for a super simple sql dsl used in the [Chevrotain Tutorial](https://sap.github.io/chevrotain/docs/tutorial/step0_introduction.html)\n\n- Lexer\n- Parser\n- Visitor\n- Serializer\n- Models\n- Grammar Railroad diagram generation\n- Jest based unit tests\n\n## Usage\n\n- clone this repo\n\n```\ngit clone https://github.com/Chevrotain/quick-start.git chevrotain-quick-start\n```\n\n- Change the package name and other things as appropriate in the `package.json`\n\n- Install dependencies\n\n```\nyarn install\n```\n\n- Start implementing your language.\n\n## Unit Tests\n\nUnit tests are a must when you are developing a new language. As you modify grammar, you want to make sure that new grammar is\nhandling all use cases properly. This quick-starter comes with easy to use unit testing based on Jest.\n\nTo add tests, edit the `dsl-texts.ts` file with new dsl text, model it supposed to parse into and text after\nserializing using couple of format options.\n\nTo run a single test, just add `only: true` property to that entry. This allows you to debug to fix issues.\n\n## Resources\n\nHere are some resources to help with your language development\n\n- [Chevrotain Docs](https://sap.github.io/chevrotain/docs/)\n- [Chevrotain Chat](https://gitter.im/chevrotain-parser/Lobby)\n- [Chevrotain Apis](https://sap.github.io/chevrotain/documentation/7_0_1/globals.html)\n\nHere are some projects using Chevrotain in real world\n\n- [Soql Parser](https://github.com/paustint/soql-parser-js)\n- [Prettier Java Plugin Parser][sample_prettier_java]\n- [JHipster Domain Language][sample_jhipster]\n- [Metabase BI expression Parser][sample_metabase].\n- [Three.js VRML Parser][sample_threejs]\n- [Argdown Parser][sample_argdown]\n- [Stardog Union Parsers (GraphQL/SPARQL/and more...)][sample_stardog]\n- [Bombadil Toml Parser][sample_bombadil]\n- [Eve Interactive Programing Language Parser][sample_eve].\n- [BioModelAnalyzer's ChatBot Parser][sample_biomodel].\n\n[benchmark]: https://sap.github.io/chevrotain/performance/\n[sample_metabase]: https://github.com/metabase/metabase/blob/136dfb17954f4e4302b3bf2fee99ff7b7b12fd7c/frontend/src/metabase/lib/expressions/parser.js\n[sample_jhipster]: https://github.com/jhipster/jhipster-core/blob/master/lib/dsl/jdl_parser.js\n[sample_eve]: https://github.com/witheve/Eve/blob/master/src/parser/parser.ts\n[sample_biomodel]: https://github.com/Microsoft/BioModelAnalyzer/blob/master/ChatBot/src/NLParser/NLParser.ts\n[sample_bombadil]: https://github.com/sgarciac/bombadil/blob/master/src/parser.ts\n[sample_argdown]: https://github.com/christianvoigt/argdown/blob/master/packages/argdown-core/src/parser.ts\n[sample_threejs]: https://github.com/mrdoob/three.js/blob/dev/examples/js/loaders/VRMLLoader.js\n[sample_prettier_java]: https://github.com/jhipster/prettier-java/tree/master/packages/java-parser/src/productions\n[sample_stardog]: https://github.com/stardog-union/millan/tree/master/src\n[languages]: https://github.com/SAP/chevrotain/tree/master/examples/implementation_languages\n[backtracking]: https://github.com/SAP/chevrotain/blob/master/examples/parser/backtracking/backtracking.js\n[custom_apis]: https://sap.github.io/chevrotain/docs/guide/custom_apis.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchevrotain%2Fquick-start","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchevrotain%2Fquick-start","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchevrotain%2Fquick-start/lists"}