@jpoly1219/context-extractor 0.1.1

package/README.md

@@ -0,0 +1,130 @@
+# context-extractor
+
+Extract relevant context from a codebase using a type-directed approach.
+
+## npm Installation
+
+Recommended.
+
+```text
+npm i @jpoly1219/context-extractor
+```
+
+## Manual Installation
+
+Not recommended. If the above steps do not work, please leave a GitHub issue.
+
+Install the following dependencies:
+
+```text
+npm install -g typescript-language-server typescript tsc
+```
+
+Clone the `ts-lsp-client` repo:
+
+```text
+git clone https://github.com/jpoly1219/ts-lsp-client
+```
+
+... and run these commands:
+
+```text
+cd ts-lsp-client
+npm install
+npm run build
+```
+
+Clone this repo.
+
+```text
+git clone https://github.com/jpoly1219/context-extractor.git
+cd context-extractor
+npm install
+```
+
+For OCaml support, you need to first go through the standard OCaml [setup](https://ocaml.org/docs/installing-ocaml).
+
+Once that is done, you should be able to create a local switch in this repo.
+
+```text
+opam switch create ./
+eval $(opam env)
+```
+
+After you activate the local switch, install the following dependencies:
+
+<!-- TODO: Update dependencies. -->
+
+```text
+opam install dune ocaml-lsp-server ounit2
+```
+
+We provide you with five OCaml examples, located in `targets/ocaml` directory.
+`cd` into each of them and run the following:
+
+```text
+dune build
+```
+
+Ignore the wildcard build errors. The command is meant to setup the modules and imports.
+
+Almost there! Create a `credentials.json` file following the steps at the **credentials.json** section below in the README.
+
+Finally, build and run.
+
+```text
+npm run build
+node dist/runner.js
+```
+
+## How it works
+
+`context-extractor` takes several steps to extract relevant types and headers:
+
+1. Determine the type of the hole.
+2. Extract relevant types.
+3. Extract relevant headers.
+
+This library exposes the API `extractWithNew`, which has the following definition:
+
+```ts
+const extractWithNew = async (
+  language: Language,
+  sketchPath: string,
+  credentialsPath: string
+) => {};
+
+enum Language {
+  TypeScript,
+  OCaml,
+}
+```
+
+`sketchPath` is the full path to your `sketch.ts` or `sketch.ml` file.
+`credentialsPath` is the full path to your `credentials.json`.
+
+### credentials.json
+
+The extractor calls OpenAI for code completion.
+For this you need a `credentials.json` file that holds your specific OpenAI parameters.
+
+The json has the following format:
+
+<!-- TODO: This is probably difficult to understand. -->
+
+```json
+{
+  "apiBase": "<your-api-base-here>",
+  "deployment": "<your-deployment-here>",
+  "gptModel": "<your-gpt-model-here>",
+  "apiVersion": "<your-api-version-here>",
+  "apiKey": "<your-api-key-here>",
+  "temperature": 0.6
+}
+```
+
+## Trying out the VSCode extension
+
+We have a Visual Studio Code extension that provides a frontend to this project.
+
+The extension is not publicly available, so you would need to request for a .vsix package.

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@jpoly1219/context-extractor",
+  "version": "0.1.1",
+  "description": "Extract relevant context from an incomplete program sketch.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jpoly1219/context-extractor.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "npx tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "json-rpc-2.0": "^1.7.0",
+    "openai": "^4.30.0",
+    "pino": "^9.3.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.3"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.5"
+  }
+}