initial commit

Author: tsammeow

.gitignore

@@ -0,0 +1,16 @@
+node_modules/
+dist/
+
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Swap the comments on the following lines if you wish to use zero-installs
+# In that case, don't forget to run `yarn config set enableGlobalCache false`!
+# Documentation here: https://yarnpkg.com/features/caching#zero-installs
+
+#!.yarn/cache
+.pnp.*

README.md

@@ -0,0 +1,24 @@
+# Source Academy Plugin Directory
+
+This repository acts as a directory for Conductor plugins officially supported
+by Source Academy.
+
+## Plugin definitions
+
+Plugin definitions should follow the `IPluginDefinition` interface.
+
+Plugins consist of a name, an optional description, and a record mapping
+execution environment to a URL to the plugin's entrypoint file.
+
+## Adding a new Plugin
+
+To add a new plugin to the plugins directory, define your plugin according to
+the interface, and add the definition to the `plugins` array in `src/index.ts`.
+
+Please export your plugin definitions `as const`.
+
+For plugins meant to use Conductor's Module API, create an entry for
+`PluginType.MODULE`, and do not create one for `PluginType.RUNNER`.
+
+For plugins meant to use the Source Academy Frontend's API, create an entry for
+`PluginType.WEB`.

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "plugin-directory",
+  "packageManager": "[email protected]",
+  "version": "0.0.1",
+  "description": "This repository acts as a directory for Conductor plugins officially supported by Source Academy.",
+  "type": "module",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "rollup -c",
+    "prepack": "yarn build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/source-academy/plugin-directory.git"
+  },
+  "author": "tsammeow",
+  "license": "ISC",
+  "files": [
+    "dist"
+  ],
+  "bugs": {
+    "url": "https://github.com/source-academy/plugin-directory/issues"
+  },
+  "homepage": "https://github.com/source-academy/plugin-directory#readme",
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "rollup": "^4.34.1",
+    "tslib": "^2.8.1",
+    "typescript": "^5.5.3"
+  }
+}

rollup.config.js

@@ -0,0 +1,20 @@
+import nodeResolve from "@rollup/plugin-node-resolve";
+import terser from "@rollup/plugin-terser";
+import typescript from "@rollup/plugin-typescript";
+
+export default [{
+    plugins: [nodeResolve(), typescript()],
+    input: "src/index.ts",
+    output: {
+        plugins: [terser({
+            module: true,
+            ecma: 2015,
+            format: {
+                preserve_annotations: true
+            }
+        })],
+        dir: "dist",
+        format: "es",
+        sourcemap: true,
+    }
+}];

src/index.ts

@@ -0,0 +1,17 @@
+import { soundsPlugin } from "./plugins/sounds";
+import type { IPluginDefinition } from "./types/IPluginDefinition";
+
+function toRecord<const P extends IPluginDefinition[]>(plugins: P) {
+    const pluginRecord: Record<P[number]["name"], IPluginDefinition> = {} as any; // to be populated
+    for (const plugin of plugins) {
+        // @ts-expect-error
+        pluginRecord[plugin.name] = plugin;
+    }
+    return pluginRecord;
+}
+
+export const plugins = /*#__PURE__*/ toRecord([
+    soundsPlugin
+]);
+
+export { PluginType } from "./types";

src/plugins/sounds.ts

@@ -0,0 +1,8 @@
+import { IPluginDefinition } from "../types";
+
+export const soundsPlugin = {
+    name: "sounds",
+    resolutions: {
+        // TODO: add sounds plugin resolutions
+    }
+} as const satisfies IPluginDefinition;

src/types/IPluginDefinition.ts

@@ -0,0 +1,7 @@
+import type { PluginType } from "./PluginType";
+
+export interface IPluginDefinition {
+    name: string;
+    description?: string;
+    resolutions: Partial<Record<PluginType, string>>;
+}

src/types/PluginType.ts

@@ -0,0 +1,7 @@
+export enum PluginType {
+    RUNNER = "runner",
+    MODULE = "module",
+    MODULE_LEGACY = "module_legacy",
+    WEB = "web",
+    NODE_JS = "nodejs",
+}

src/types/index.ts

@@ -0,0 +1,2 @@
+export type { IPluginDefinition } from "./IPluginDefinition";
+export { PluginType } from "./PluginType";

tsconfig.json

@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "strict": true,
+        "module": "ESNext",
+        "moduleResolution": "bundler",
+        "target": "ESNext",
+        "outDir": "dist",
+        "declaration": true,
+        "sourceMap": true
+    }
+}