planning

Author: Stefterv

README.md

@@ -1,37 +1,9 @@
-# LSP Example
+# Processing VSCode Extension
 
-Heavily documented sample code for https://code.visualstudio.com/api/language-extensions/language-server-extension-guide
+<!-- TODO: Write the README  -->
+<!-- TODO: Add general Processing Foundation repository contents -->
 
-## Functionality
-
-This Language Server works for plain text file. It has the following language features:
-- Completions
-- Diagnostics regenerated on each file change or configuration change
-
-It also includes an End-to-End test.
-
-## Structure
-
-```
-.
-├── client // Language Client
-│   ├── src
-│   │   ├── test // End to End tests for Language Client / Server
-│   │   └── extension.ts // Language Client entry point
-├── package.json // The extension manifest.
-└── server // Language Server
-    └── src
-        └── server.ts // Language Server entry point
-```
-
-## Running the Sample
-
-- Run `npm install` in this folder. This installs all necessary npm modules in both the client and server folder
-- Open VS Code on this folder.
-- Press Ctrl+Shift+B to start compiling the client and server in [watch mode](https://code.visualstudio.com/docs/editor/tasks#:~:text=The%20first%20entry%20executes,the%20HelloWorld.js%20file.).
-- Switch to the Run and Debug View in the Sidebar (Ctrl+Shift+D).
-- Select `Launch Client` from the drop down (if it is not already).
-- Press ▷ to run the launch config (F5).
-- In the [Extension Development Host](https://code.visualstudio.com/api/get-started/your-first-extension#:~:text=Then%2C%20inside%20the%20editor%2C%20press%20F5.%20This%20will%20compile%20and%20run%20the%20extension%20in%20a%20new%20Extension%20Development%20Host%20window.) instance of VSCode, open a document in 'plain text' language mode.
-  - Type `j` or `t` to see `Javascript` and `TypeScript` completion.
-  - Enter text content such as `AAA aaa BBB`. The extension will emit diagnostics for all words in all-uppercase.
+<!-- TODO: Check for other Processing plugins and request deactivation if they are installed -->
+<!-- TODO: Generate grammar based on the installed Processing version -->
+<!-- TODO: Setup publishing https://code.visualstudio.com/api/working-with-extensions/publishing-extension  -->
+<!-- TODO: Merge changes to Processing https://github.com/processing/processing4/pull/1115 -->

client/src/extension.ts

@@ -23,10 +23,7 @@ export const state = {
 };
 
 export async function activate(context: ExtensionContext) {
-	// TODO: Check for other Processing plugins and request deactivation if they are installed
-	// TODO: Add examples and sketchbook window
-	// TODO: Generate grammar based on the Processing version
-	// TODO: Setup language icon
+
 
 	await setupSelectedVersion(context);
 	setupCommands(context);

client/src/setupSidebar.ts

@@ -81,6 +81,7 @@ class SketchTreeItem extends TreeItem {
 			arguments: [this.sketch.path]
 		};
 
+		// TODO: Make showing a preview a toggleable setting
 		const preview = `${sketch.path}/${sketch.name}.png`;
 		if (existsSync(preview)) {
 			this.iconPath = preview;

package.json

@@ -1,6 +1,7 @@
 {
 	"name": "processing4-vscode-extension",
-	"description": "Run Processing sketches in VS Code",
+	"displayName": "Processing",
+	"description": "Run Processing sketches in VSCode",
 	"author": "Stef Tervelde",
 	"license": "LGPL-2.1-or-later",
 	"version": "1.0.0",