{"id":24587935,"url":"https://github.com/ronin-co/syntax","last_synced_at":"2025-04-28T17:44:27.921Z","repository":{"id":268740444,"uuid":"904233309","full_name":"ronin-co/syntax","owner":"ronin-co","description":"Allows for defining RONIN queries and models in code.","archived":false,"fork":false,"pushed_at":"2025-03-26T12:54:59.000Z","size":339,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-26T13:36:01.151Z","etag":null,"topics":["database","primitives","queries"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/@ronin/syntax","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ronin-co.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-16T13:54:06.000Z","updated_at":"2025-03-26T12:39:49.000Z","dependencies_parsed_at":"2024-12-18T16:39:43.793Z","dependency_job_id":"549a4af8-f91b-49ab-871a-9194bb372ddb","html_url":"https://github.com/ronin-co/syntax","commit_stats":null,"previous_names":["ronin-co/schema","ronin-co/syntax"],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronin-co%2Fsyntax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronin-co%2Fsyntax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronin-co%2Fsyntax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronin-co%2Fsyntax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ronin-co","download_url":"https://codeload.github.com/ronin-co/syntax/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251357791,"owners_count":21576772,"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":["database","primitives","queries"],"created_at":"2025-01-24T07:13:46.424Z","updated_at":"2025-04-28T17:44:27.904Z","avatar_url":"https://github.com/ronin-co.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RONIN Syntax\n\n[![tests](https://img.shields.io/github/actions/workflow/status/ronin-co/syntax/validate.yml?label=tests)](https://github.com/ronin-co/syntax/actions/workflows/validate.yml)\n[![code coverage](https://img.shields.io/codecov/c/github/ronin-co/syntax)](https://codecov.io/github/ronin-co/syntax)\n[![install size](https://packagephobia.com/badge?p=@ronin/syntax)](https://packagephobia.com/result?p=@ronin/syntax)\n\nThis package makes it possible to define [RONIN](https://ronin.co) queries and schemas in TypeScript code.\n\n## Setup\n\nYou don't need to install this package explicitly, as it is already included in the [RONIN client](https://github.com/ronin-co/client).\n\nHowever, we would be excited to welcome your feature suggestions or bug fixes for the RONIN schema. Read on to learn more about how to suggest changes.\n\n## Contributing\n\nTo start contributing code, first make sure you have [Bun](https://bun.sh) installed, which is a JavaScript runtime.\n\nNext, [clone the repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) and install its dependencies:\n\n```bash\nbun install\n```\n\nOnce that's done, link the package to make it available to all of your local projects:\n\n```bash\nbun link\n```\n\nInside your project, you can then run the following command, which is similar to `bun add @ronin/syntax` or `npm install @ronin/syntax`, except that it doesn't install `@ronin/syntax` from npm, but instead uses your local clone of the package:\n\n```bash\nbun link @ronin/syntax\n```\n\nIf your project is not yet compatible with [Bun](https://bun.sh), feel free to replace all of the occurrences of the word `bun` in the commands above with `npm` instead.\n\nYou will just need to make sure that, once you [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#creating-the-pull-request) on the current repo, it will not contain a `package-lock.json` file, which is usually generated by npm. Instead, we're using the `bun.lockb` file for this purpose (locking sub dependencies to a certain version).\n\n### Transpilation\n\nIn order to be compatible with a wide range of projects, the source code of the `schema` repo needs to be compiled (transpiled) whenever you make changes to it. To automate this, you can keep this command running in your terminal:\n\n```bash\nbun run dev\n```\n\nWhenever you make a change to the source code, it will then automatically be transpiled again.\n\n### Running Tests\n\nThe RONIN schema has 100% test coverage, which means that every single line of code is tested automatically, to ensure that any change to the source code doesn't cause a regression.\n\nBefore you create a pull request on the `schema` repo, it is therefore advised to run those tests in order to ensure everything works as expected:\n\n```bash\n# Run all tests\nbun test\n\n# Alternatively, run a single test\nbun test -t 'your test name'\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fronin-co%2Fsyntax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fronin-co%2Fsyntax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fronin-co%2Fsyntax/lists"}