{"id":23718988,"url":"https://github.com/michaelzaporozhets/abstractconnect","last_synced_at":"2025-09-03T20:32:49.031Z","repository":{"id":40289612,"uuid":"240192247","full_name":"MichaelZaporozhets/abstractconnect","owner":"MichaelZaporozhets","description":"A Design Token extractor for teams using Abstract \u0026 Javascript","archived":false,"fork":false,"pushed_at":"2022-12-06T16:12:13.000Z","size":1508,"stargazers_count":7,"open_issues_count":16,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T11:57:51.785Z","etag":null,"topics":["abstract","design-systems","sketch"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/MichaelZaporozhets.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-02-13T06:25:57.000Z","updated_at":"2023-02-20T16:29:51.000Z","dependencies_parsed_at":"2023-01-24T08:30:20.159Z","dependency_job_id":null,"html_url":"https://github.com/MichaelZaporozhets/abstractconnect","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelZaporozhets%2Fabstractconnect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelZaporozhets%2Fabstractconnect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelZaporozhets%2Fabstractconnect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelZaporozhets%2Fabstractconnect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MichaelZaporozhets","download_url":"https://codeload.github.com/MichaelZaporozhets/abstractconnect/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231916799,"owners_count":18445458,"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":["abstract","design-systems","sketch"],"created_at":"2024-12-30T21:32:58.399Z","updated_at":"2024-12-30T21:32:58.937Z","avatar_url":"https://github.com/MichaelZaporozhets.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AbstractConnect\n### A Design-Token extractor for teams using Abstract \u0026 Javascript\n[![NPM Version and link](https://img.shields.io/npm/v/abstractconnect)](https://www.npmjs.com/package/abstractconnect)\n\nThis package retrieves symbols from a specified sketch file stored in abstract, models the data neatly and transposes sketch format styles into more webdev(tm) friendly values.\n\n### Usage\n\n\n```javascript\nimport { getSymbols } from 'abstractconnect';\n\ngetSymbols({\n  filter: symbol =\u003e symbol.name === 'MySymbol'\n}).then(({ MySymbol }) =\u003e {\n\n  //select your layer by name\n  const MyLayer = MySymbol.layers.MyLayerName\n\n  //do whatever it is you want to do with design information\n  const someCSS = `\n    font-size: ${MyLayer.style.text.fontSize}px;\n    background: ${MyLayer.style.background};\n  `;\n\n  //etc\n});\n\n```\n#### getSymbols\ntakes a single parameter, an object with config:\n- `filter`: expects a standard js filter function\n- `raw`: set to `true` to get the 'raw' symbol data from sketch\n- `fromSHA`: target a specific commit in abstract\n- `withFS`: force download to FS (ends up in the TEMP_PATH setup var below)\n\n### Setup\n\nThis package is configured using environment values. Simplest setup is to drop a `.env` file in your project directory.\n\n```\nABSTRACT_TOKEN=\u003cYOUR DEVELOPER TOKEN\u003e\nABSTRACT_PROJECT_ID=\u003cYOUR PROJECT ID\u003e\nABSTRACT_FILE_NAME=\u003cTHE NAME OF YOUR SKETCH FILE\u003e\nABSTRACT_BRANCH=\u003cOPTIONAL: DEFAULTS TO 'master'\u003e\nLOG_LEVEL=\u003cOPTIONAL: to turn off console info add this to equal 'silent'\u003e\nTEMP_PATH=\u003cOPTIONAL: DEFAULTS TO \u003cYOURPROJECTPATH\u003e/temp\n\n```\n\n**finding your project id**\nThe simplest way to find your project id is to open your project in browser, and collect the id from the url: `https://app.abstract.com/projects/\u003cPROJECT_ID\u003e/`;\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelzaporozhets%2Fabstractconnect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelzaporozhets%2Fabstractconnect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelzaporozhets%2Fabstractconnect/lists"}