{"id":28629182,"url":"https://github.com/source-academy/plugin-directory","last_synced_at":"2025-11-10T02:04:54.503Z","repository":{"id":282028770,"uuid":"946477800","full_name":"source-academy/plugin-directory","owner":"source-academy","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-12T11:54:32.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-12T11:54:18.776Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/source-academy.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-11T07:48:47.000Z","updated_at":"2025-03-12T11:54:35.000Z","dependencies_parsed_at":"2025-03-12T12:42:48.458Z","dependency_job_id":null,"html_url":"https://github.com/source-academy/plugin-directory","commit_stats":null,"previous_names":["source-academy/plugin-directory"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/source-academy/plugin-directory","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/source-academy%2Fplugin-directory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/source-academy%2Fplugin-directory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/source-academy%2Fplugin-directory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/source-academy%2Fplugin-directory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/source-academy","download_url":"https://codeload.github.com/source-academy/plugin-directory/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/source-academy%2Fplugin-directory/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268660082,"owners_count":24286021,"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","status":"online","status_checked_at":"2025-08-04T02:00:09.867Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-06-12T11:41:17.730Z","updated_at":"2025-11-10T02:04:54.495Z","avatar_url":"https://github.com/source-academy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Source Academy Plugin Directory\n\nThis repository acts as a directory for Conductor plugins officially supported\nby Source Academy.\n\n## Using this directory\n\n### As a static asset\n\nYou may import the `plugins` array directly after installing this repository\n(as `import { plugins } from 'plugin-directory'`). This will cause the array\nto be bundled together at build time.\n\nCaution: when including this repository as a dependency in your `package.json`,\n**be sure to specify a specific commit hash or tag**.\nFailure to do this may cause problems with CI/CD due to lockfile issues when this\ndirectory is updated.\n\n### Retrieved dynamically\n\nThe `plugins` array is available dynamically at\n[`https://source-academy.github.io/plugin-directory/directory.json`](https://source-academy.github.io/plugin-directory/directory.json).\n\nIn this case, you probably do not want to bundle the array at build time. You may\nbundle only the utility functions by importing from `'plugin-directory/dist/util'` instead.\n\nYou can reconstruct the `pluginMap` using the `generatePluginMap` utility function.\n\n### A hybrid approach\n\nYou may import the `plugins` array from the dynamically updated file at\n[`https://source-academy.github.io/plugin-directory/index.js`](https://source-academy.github.io/plugin-directory/index.js).\n\nMarking this file as an external dependency in your build tool will cause it to\nbe imported at run time. You may also wish to map this file to a local copy\nfor development builds.\n\n## Plugin definitions\n\nPlugin definitions should follow the `IPluginDefinition` interface.\n\nPlugins consist of an ID, a name, an optional description, and a record mapping\nexecution environment to a URL to the plugin's entrypoint file.\n\nTo add a new plugin to the plugins directory, define your plugin according to\nthe interface, and add the definition to the `plugins` array in `src/plugins.ts`.\n\nFor plugins meant to use Conductor's Module API, create an entry for\n`PluginType.MODULE`, and do not create one for `PluginType.RUNNER`.\n\nFor plugins meant to use the Source Academy Frontend's API, create an entry for\n`PluginType.WEB`.\n\n## Local testing\n\nYou may test any changes (e.g. adding your new language) locally by running `yarn start`.\nThis starts a development server and compiles the directory in watch mode (recompiling on any changes).\n\nThe directory will be available at [`http://localhost:8126/directory.json`](http://localhost:8126/directory.json).\nOn the Source Academy frontend, set the feature flag `directory.plugin.url` to point to this location.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsource-academy%2Fplugin-directory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsource-academy%2Fplugin-directory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsource-academy%2Fplugin-directory/lists"}