{"id":18076753,"url":"https://github.com/gooroo/qbs-sketch","last_synced_at":"2025-04-12T08:40:37.050Z","repository":{"id":147825514,"uuid":"486776555","full_name":"GooRoo/qbs-sketch","owner":"GooRoo","description":"Qbs module to export Sketch documents","archived":false,"fork":false,"pushed_at":"2023-09-14T22:42:40.000Z","size":1482,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-26T03:41:46.804Z","etag":null,"topics":["assets","build-system","module","pipeline","qbs","qbs-module","sketch","sketch-app","sketchapp","sketchtool"],"latest_commit_sha":null,"homepage":"https://gooroo.github.io/qbs-sketch/","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/GooRoo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["GooRoo"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2022-04-28T23:24:03.000Z","updated_at":"2023-02-20T16:33:07.000Z","dependencies_parsed_at":"2024-10-31T11:11:13.826Z","dependency_job_id":"a1a6c992-4b8c-46a0-b8aa-44373d369d7a","html_url":"https://github.com/GooRoo/qbs-sketch","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/GooRoo%2Fqbs-sketch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GooRoo%2Fqbs-sketch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GooRoo%2Fqbs-sketch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GooRoo%2Fqbs-sketch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GooRoo","download_url":"https://codeload.github.com/GooRoo/qbs-sketch/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248542985,"owners_count":21121827,"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":["assets","build-system","module","pipeline","qbs","qbs-module","sketch","sketch-app","sketchapp","sketchtool"],"created_at":"2024-10-31T11:11:03.254Z","updated_at":"2025-04-12T08:40:37.029Z","avatar_url":"https://github.com/GooRoo.png","language":"JavaScript","funding_links":["https://github.com/sponsors/GooRoo"],"categories":[],"sub_categories":[],"readme":"# qbs-sketch\n\n[![Made by Ukrainian](https://img.shields.io/static/v1?label=Made%20by\u0026message=Ukrainian\u0026labelColor=1f5fb2\u0026color=fad247\u0026style=flat-square)](https://github.com/GooRoo/ukrainian-shields)\n\nThis [Qbs][qbs] module integrates [Sketch][sketch] into your build process allowing you to automate the pipeline of assets delivery.\n\nSince **Sketch** is available only on Apple **macOS**, the module works only on macOS as the [host system](https://doc.qt.io/qbs/qml-qbsmodules-qbs.html#hostOS-prop) too. It requires the **Sketch** application to be installed in your system.\n\n## Example\n\n```qml\nimport qbs\n\nSketchExport {\n\tname: 'sketch-assets'\n\n\tSketch.export.mode: [\n\t\t'layers',\n\t\t'pages',\n\t]\n\n\tSketch.layers.outputDir: 'assets'\n\tSketch.layers.scales: [1, 2]  // produces .png, @2x.png\n\tSketch.layers.formats: 'png'\n\n\tSketch.pages.outputDir: 'reference'\n\tSketch.pages.formats: ['pdf', 'svg']\n\tSketch.pages.items: [\n\t\t'Colors',\n\t\t'Typography'\n\t]\n\n\tfiles: '*.sketch'\n}\n```\nThis produces a folder structure similar to this (depending on the contents of your sketch-file of course, so this is just an example):\n```\n\u003cbuild-folder\u003e/\n├─ assets/\n│  ├─ button.png\n│  ├─ button@2x.png\n│  ├─ input-field.png\n│  ├─ input-field@2x.png\n│  └─ ...\n└─ reference/\n   ├─ Colors.pdf\n   ├─ Colors.svg\n   ├─ Typography.pdf\n   └─ Typography.svg\n```\nAll exported files are [tagged](https://doc.qt.io/qbs/language-introduction.html#file-tags-and-taggers) as `sketch.export` and can be used in further products as input.\n\n### Fun fact\n\nBy the way, the logo for this microproject was also generated using this module. Just go to the project's root folder and type\n```sh\nqbs install --install-root .\n```\n\n## Documentation\n\nTo check the full reference, go to the [documentation](https://gooroo.github.io/qbs-sketch/).\n\n[qbs]: https://doc.qt.io/qbs/\n[sketch]: https://www.sketch.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgooroo%2Fqbs-sketch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgooroo%2Fqbs-sketch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgooroo%2Fqbs-sketch/lists"}