{"id":17028175,"url":"https://github.com/northword/zotero-plugin-scaffold","last_synced_at":"2025-04-12T12:10:51.458Z","repository":{"id":217140046,"uuid":"743109140","full_name":"northword/zotero-plugin-scaffold","owner":"northword","description":"A scaffold for Zotero plugin development","archived":false,"fork":false,"pushed_at":"2024-08-01T06:42:57.000Z","size":760,"stargazers_count":4,"open_issues_count":8,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-08-03T13:03:14.909Z","etag":null,"topics":["developer","scaffold","zotero","zotero-plugin"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/zotero-plugin-scaffold","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/northword.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-01-14T11:09:39.000Z","updated_at":"2024-08-10T12:00:16.388Z","dependencies_parsed_at":"2024-04-02T06:23:21.208Z","dependency_job_id":"c859941e-db05-4595-8136-f649c1428783","html_url":"https://github.com/northword/zotero-plugin-scaffold","commit_stats":null,"previous_names":["northword/zotero-plugin-dev-tool","northword/zotero-plugin-scaffold"],"tags_count":72,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/northword%2Fzotero-plugin-scaffold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/northword%2Fzotero-plugin-scaffold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/northword%2Fzotero-plugin-scaffold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/northword%2Fzotero-plugin-scaffold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/northword","download_url":"https://codeload.github.com/northword/zotero-plugin-scaffold/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248565074,"owners_count":21125417,"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":["developer","scaffold","zotero","zotero-plugin"],"created_at":"2024-10-14T07:52:46.464Z","updated_at":"2025-04-12T12:10:51.436Z","avatar_url":"https://github.com/northword.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zotero Plugin Development Scaffold\n\n[![NPM Version](https://img.shields.io/npm/v/zotero-plugin-scaffold)](https://www.npmjs.com/package/zotero-plugin-scaffold)\n[![NPM Downloads](https://img.shields.io/npm/dm/zotero-plugin-scaffold)](https://www.npmjs.com/package/zotero-plugin-scaffold)\n![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/zotero-plugin-scaffold)\n![GitHub License](https://img.shields.io/github/license/northword/zotero-plugin-scaffold)\n[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)\n\nThis is an npm package designed to assist in the development of Zotero plugins. It provides features such as compiling plugins, starting Zotero and installing plugins from source code, reloading plugins when the source code changes, and releasing plugins, and so on.\n\nInitially, the code of this package was part of the [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template) repository. To allow downstream developers to easily stay up-to-date, we have abstracted these scripts into a standalone npm package.\n\nThis project is under active development, and some APIs may change. However, it is ready for production and has been [used in several projects](https://github.com/northword/zotero-plugin-scaffold/network/dependents).\n\nFor best practices regarding this package, please refer to [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template).\n\n## Documentation\n\n[Read the Docs to Learn More](https://northword.github.io/zotero-plugin-scaffold).\n\n## Contributing\n\n```bash\n# Git Clone\ngit clone https://github.com/northword/zotero-plugin-scaffold.git zotero-plugin-scaffold\ncd zotero-plugin-scaffold/\n\n# Install deps\ncorepack enable\npnpm install\n\n# Development Mode\n# This command creates a typescript runtime using jiti,\n# and the modified code does not need to be built again.\npnpm run dev\n\n# link local scaffold to your plugin\ncd your-plugin-work-dir/\npnpm link ../zotero-plugin-scaffold/packages/scaffold/\ncd zotero-plugin-scaffold/\n```\n\nNow you can make changes to Scaffold and test them in your plugin.\n\nWhen you're done modifying, make sure that you can pass the build and that the code style meets the requirements of this repository.\n\n```bash\n# Build\npnpm run build\n\n# ES Lint\npnpm run lint:fix\n```\n\n## License\n\nGNU Affero General Public License Version 3.\n\n## Acknowledgements\n\nThis project references the design and code of the [Zotero Plugin Template](https://github.com/windingwind/zotero-plugin-template).\n\nThis project would not be possible without the support of the [open source community](https://github.com/northword/zotero-plugin-scaffold/network/dependencies).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnorthword%2Fzotero-plugin-scaffold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnorthword%2Fzotero-plugin-scaffold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnorthword%2Fzotero-plugin-scaffold/lists"}