Development: Create infrastructure for client plugins

CONTRIBUTING.md

@@ -1,5 +1,9 @@
 Since all contributors would need to start the application anyway, an exhaustive contributors guide is provided in-app after starting in development mode.
 
+If you are serious about contributing to this repository, you can find a quick way to start the application in development mode below. Please be aware of the [Pull Request Rules](#pull-request-rules). Breaking these rules will result in reactions such as your Pull Request to be rejected or your account restricted in this repository.
+
+### Quickstart
+
 This contributors guide is short and will only help you run a minimal working Torii app. First make sure you have the [Rust Programming Language](https://rust-lang.org/) (which comes with [cargo](https://doc.rust-lang.org/cargo/)) and [NodeJS](https://nodejs.org/en) (which comes with [npm](https://docs.npmjs.com/cli/v11/commands/npm) and [npx](https://docs.npmjs.com/cli/v11/commands/npx)) installed. This guide assumes you have some prior familiarity with these tools.
 
 First, install all client dependencies with the following command. You will have to run this command everytime when client dependencies change (e.g. after pulling from remote). This will generate the `node_modules` directory, which contains all client dependencies.
@@ -22,3 +26,17 @@ Now you should see the application winow which comes with at least two default w
 cd torii-api
 go run src/main.go serve
 ``` -->
+
+### Pull Request Rules
+
+- **No vibes.** You are allowed to use smart, contextless autocompletion and ask smart assistants for planning and code review. However code which has been subject to agent generation is categorically not allowed in this repository.
+
+- **English Codebase.** We allow to interact with this repositories issuesses, discussions and comments in different languages. However excluded are all commit messages, source code and the title and first message in a Pull Request, which have to be in English.
+
+- **No obfuscastions.** Code using obfuscations for the sake of being unreadable is not allowed. Performance-optimized code has to be clearly documented with comments.
+
+- **Citations.** Code retrieved from external websites like StackOverflow have to be cited in the codebase. A citation is a comment with a link above the cited code segment. Links that helped you fix bugs or helped you choose an algorithm or approach are welcomed.
+
+- **Documentation.** All code is subject to exhaustive documentation. Make sure the formatting is not broken for documentation generators. For functions include example and usage. We try to keep a 1:1 to 1:2 (code lines:documentation) ratio.
+
+- **Rules are non-exhaustive.** The administrative team of this codebase reserves the right to make up new written rules when "unspoken rules" are broken. The "unspoken rules" include: Be Nice, Keep the Code Clean, Follow Existing Patterns or Evolve New Maintainable Patterns.

ROADMAP.md

@@ -89,6 +89,18 @@ The first stage of the project is to create a simple file browser like applicati
 
 ### `v0.0.0-dev9` [NEXT]
 
+-   [ ] Client Refactoring (vue app and plugins first steps)
+    -   [ ] Phase 1: Plugin API Core
+        -   [x] `ToriiPlugin`: A separate library module defining plugin.
+        -   [ ] Define plugin lifecycle hooks (`onInit`, `onRecordOpen`, `onComponentUpdate`, etc.)
+        -   [ ] Define anchor point constants. Anchor points are views which can be extended by plugins.
+        -   [ ] `PluginManager` with `register` new plugins and `getAnchorView()` to render an anchor screen.
+    -   [ ] Phase 2: Call Plugin API
+        -   [ ] Define a Vue anchor component (renderer) and place some in the app.
+        -   [ ] Pass workspace context to plugins.
+    -   [ ] Phase 3: Plugin Extraction
+        -   [ ] `word-count`
+        -   [ ] `recent-projects`
 -   [x] Client Documentation (Typedoc Infrastructure)
 -   [ ] Breadcrumb Header
 -   [x] Expand Footer with Edit and View mode.
@@ -107,7 +119,6 @@ The first stage of the project is to create a simple file browser like applicati
 
 ### `v0.0.0-dev10`
 
--   [ ] Client Refactoring (vue app and plugins first steps)
 -   [ ] Client Documentation (Github CI)
     -   [ ] [clean-jsdoc-theme](https://www.npmjs.com/package/@clean-jsdoc-theme/typedoc)
 -   [ ] Remove Naive UI dependency and implement custom vue components

package.json

@@ -2,7 +2,7 @@
     "name": "Torii",
     "type": "module",
     "workspaces": [
-        "torii-client"
+        "torii-client/**"
     ],
     "devDependencies": {
         "@tauri-apps/cli": "^2.11.1",

torii-client/README.md

@@ -1,24 +1,3 @@
-# torii-client
+# Torii Client Infrastructure
 
-## Project setup
-```
-npm install
-```
-
-### Compiles and hot-reloads for development
-```
-npm run serve
-```
-
-### Compiles and minifies for production
-```
-npm run build
-```
-
-### Lints and fixes files
-```
-npm run lint
-```
-
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+- [webapp](./webapp/): The main "executable". This is what the Torii application "sees".

torii-client/plugin-core/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@torii/plugin-core",
+  "version": "0.1.0",
+  "private": true,
+  "main": "src/lib.ts",
+  "dependencies": {
+    "vue": "^3.5.41"
+  }
+}