{"id":13517002,"url":"https://github.com/supermodel/supermodel","last_synced_at":"2025-03-31T07:30:44.274Z","repository":{"id":35156699,"uuid":"166977205","full_name":"supermodel/supermodel","owner":"supermodel","description":"Supermodel browser library and CLI tool for working with JSON Schema data models","archived":false,"fork":false,"pushed_at":"2022-12-09T11:12:41.000Z","size":2619,"stargazers_count":50,"open_issues_count":28,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-16T20:16:38.619Z","etag":null,"topics":["avro","graphql","json","json-ld","json-schema","openapi","swagger"],"latest_commit_sha":null,"homepage":"http://supermodel.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/supermodel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-22T10:47:00.000Z","updated_at":"2025-02-12T19:32:53.000Z","dependencies_parsed_at":"2023-01-15T15:00:14.515Z","dependency_job_id":null,"html_url":"https://github.com/supermodel/supermodel","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supermodel%2Fsupermodel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supermodel%2Fsupermodel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supermodel%2Fsupermodel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supermodel%2Fsupermodel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/supermodel","download_url":"https://codeload.github.com/supermodel/supermodel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246432911,"owners_count":20776483,"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":["avro","graphql","json","json-ld","json-schema","openapi","swagger"],"created_at":"2024-08-01T05:01:28.372Z","updated_at":"2025-03-31T07:30:43.326Z","avatar_url":"https://github.com/supermodel.png","language":"JavaScript","readme":"# Supermodel npm packages [![CircleCI][supermodel-ci-badge]][supermodel-ci]\n\nCollection of npm packages supporting [supermodel.io](https://supermodel.io)\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Packages](#packages)\n- [Contributing](#contributing)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Local linking](#local-linking)\n- [Principles](#principles)\n- [Publishing](#publishing)\n- [License](#license)\n\n## Introduction\n\n*TODO*\n\n## Packages\n\n**@supermodel/cli** [README](https://github.com/supermodel/supermodel/tree/master/packages/cli#readme) [![Version][supermodel-cli-version]][supermodel-cli-package]\n\nMain package used for installing system wide binary `supermodel` for manipulating schemas\n\n**@supermodel/lib** [README](https://github.com/supermodel/supermodel/tree/master/packages/lib#readme) [![Version][supermodel-lib-version]][supermodel-lib-package]\n\nCollection of utils on top of json schema. Used in **@supermodel/cli** and on [supermodel.io](https://supermodel.io)\n\n**@supermodel/file** [README](https://github.com/supermodel/supermodel/tree/master/packages/file#readme) [![Version][supermodel-file-version]][supermodel-file-package]\n\nUtils for manipulating json schema on file system. Used in **@supermodel/cli**\n\n## Contributing\n\nWe are using [lerna](https://github.com/lerna/lerna) for managing all packages together\n\n### Installation\n\n1. `yarn global add lerna@3.10` (`npm i -g lerna@3.10`) - to install orchstrating tool lerna\n2. `yarn bootstrap` - resolves and install root and packages dependencies\n\n    - ⚠️ use this instead of `yarn [install]`\n    - ensures presence of global installation of **lerna** and install it for you when missing\n\n3. 🤔 *optional* When developing against local supermodel.io instance setup .env for CLI. Choose symlink or copy:\n\n    - symlink: `ln -s ./packages/cli/.env.development ./packages/cli/.env`\n    - copy: `cp ./packages/cli/.env.development ./packages/cli/.env` and change variables for your needs\n\n### Usage\n\n- `yarn build:watch`\n  - should be running while you want to use `./packages/cli/bin/supermodel` or `supermodel` after `yarn local:install`\n- `yarn test:watch` - **watch** tests in all packages at once\n- `yarn build` - make production builds\n- `yarn test` - run lint, type checks and run tests in all packages at once\n  - `yarn test:lint` - code linting\n  - `yarn test:types` - type checks\n  - `yarn test:unit` - unit tests\n\n### Local linking\n\nTo try @supermodel/cli locally with simple `supermodel` command we need to link all packages.\nThere is shortcut to link all packages\n\n- `yarn local:install`\n- `yarn local:uninstall`\n\n### Principes\n\nEvery new module which manipulates with schemas (conversion, resolving, transforming etc.) or helps to work with schemas and environment around should be placed inside **@supermodel/lib**. Exposed modules for outside usage should return a value, or throw an error. Or promise analogy (resolve, reject) for async modules.\n\n*TODO*\n\n### Publishing\n\n`lerna publish`\n\n- useses [lerna publish](https://github.com/lerna/lerna/tree/master/commands/publish#readme)\n- It is most streightforward way to publish. It compile typescript with `yarn build` command, tag changed packages with new versions and publish it to npm\n\n## A Good API Project\n\n[supermodel.io](http://supermodel.io), and [supermodel CLI](https://github.com/supermodel/supermodel/tree/master/packages/cli#readme) are [Good API](http://goodapi.co) non-profit projects, aimed at promoting modern, reusable, and sustainable data modeling.\n\n## License\n\nThe MIT License (MIT) 2020 Good API\n\n\u003c!-- urls --\u003e\n[supermodel-ci-badge]: https://circleci.com/gh/supermodel/supermodel.svg?style=svg\n[supermodel-ci]: https://circleci.com/gh/supermodel/supermodel\n[supermodel-cli-version]: https://img.shields.io/npm/v/@supermodel/cli.svg?style=flat-square\n[supermodel-cli-package]: https://www.npmjs.com/package/@supermodel/cli\n[supermodel-lib-version]: https://img.shields.io/npm/v/@supermodel/lib.svg?style=flat-square\n[supermodel-lib-package]: https://www.npmjs.com/package/@supermodel/lib\n[supermodel-file-version]: https://img.shields.io/npm/v/@supermodel/file.svg?style=flat-square\n[supermodel-file-package]: https://www.npmjs.com/package/@supermodel/file","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupermodel%2Fsupermodel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsupermodel%2Fsupermodel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupermodel%2Fsupermodel/lists"}