Merge pull request #71 from Ekhorn/wysiwyg

feat: add rich text editor

.eslintrc.cjs

@@ -6,10 +6,27 @@ module.exports = {
     node: true,
   },
   ignorePatterns: [
-    'dist',
+    // Playwright
+    'srcs/e2e/test-results/',
+    'srcs/e2e/playwright-report/',
+    'srcs/e2e/blob-report/',
+    'srcs/e2e/playwright/.cache/',
+
+    // Typescript
+    'tsconfig.tsbuildinfo',
+    'srcs/slate-solid/lib',
+
+    // Rust
+    'srcs/tauri',
     'target',
+
+    // Vite
+    'dist',
+
+    // NPM
     'node_modules',
-    'srcs/tauri',
+
+    // General
     '*.config.*',
   ],
   parser: '@typescript-eslint/parser',

.github/workflows/ci.yaml

@@ -46,7 +46,7 @@ jobs:
           node-version: 18
           cache: 'npm'
       - run: npm ci
-      - run: npx --workspaces tsc
+      - run: npx --workspaces tsc -b
 
   vitest:
     runs-on: ubuntu-latest
@@ -58,6 +58,7 @@ jobs:
           node-version: 18
           cache: 'npm'
       - run: npm ci
+      - run: npx --workspaces tsc -b
       - run: npm test
 
   fmt_check:
@@ -164,6 +165,7 @@ jobs:
         with:
           node-version: 18
       - run: npm ci
+      - run: npx --workspaces tsc -b
       - run: npm run build
       - run: docker compose --profile services up -d
       - run: npx playwright install --with-deps

.gitignore

@@ -1,12 +1,23 @@
+# Playwright
+srcs/e2e/test-results/
+srcs/e2e/playwright-report/
+srcs/e2e/blob-report/
+srcs/e2e/playwright/.cache/
+
+# Typescript
+tsconfig.tsbuildinfo
+srcs/slate-solid/lib
+
+# Rust
 target
+
+# NPM
 node_modules
+
+# Vite
 dist
+
+# General
 .env
 .direnv
 *.db*
-
-# Playwright test output
-srcs/e2e/test-results/
-srcs/e2e/playwright-report/
-srcs/e2e/blob-report/
-srcs/e2e/playwright/.cache/

.prettierignore

@@ -1,17 +1,16 @@
+# Ignore lock files
+pnpm-lock.yaml
+package-lock.json
+yarn.lock
+
+# Rust
+src/tauri
+
+# General
+/docs/archive
 .DS_Store
-node_modules
 .archive
-/build
-/dist
-/docs/archive
-/package
-/tauri
-.env
 .env.*
 !.env.example
 .sqlx
-
-# Ignore files for PNPM, NPM and YARN
-pnpm-lock.yaml
-package-lock.json
-yarn.lock
+*.db*

CONTRIBUTING.md

@@ -4,6 +4,8 @@
 
 ### Testing
 
+**Rust**
+
 > Note: The `DATABASE_URL` must be present as environment variable for the database tests. The `DATABASE_URL` is automatically set using the `build.rs` file if the build is not a release build.
 
 Running all tests
@@ -18,6 +20,34 @@ Running tests for a specific workspace member
 cargo test -p item_producer
 ```
 
+**Vitest**
+
+Running unit/component tests
+
+```sh
+npm test
+```
+
+**Playwright**
+
+Running End-to-End tests locally
+
+```sh
+npm run e2e
+```
+
+The following command is recommended when writing End-to-End tests.
+
+```sh
+npm run e2e -- --ui
+```
+
+To use Playwright codegen run the following command.
+
+```sh
+npm run codegen
+```
+
 ### Updating migrations
 
 > Note: `npm run sqlx:prepare` runs the `srcs/scripts/sqlx_prepare.sh` script, which by default runs `cargo sqlx prepare` on all crates individually. Available options are `all`, `item_producer`, `user_service`, and `tauri`.

README.md

@@ -21,7 +21,13 @@ the required Tauri dependencies.
 Install dependencies for web-frontend.
 
 ```sh
-npm i
+npm ci
+```
+
+Build JavaScript libraries used in web-frontend. Only required initially or when changes are made to packages **referenced** in [srcs/app/tsconfig.json](srcs/app/tsconfig.json).
+
+```sh
+npx --workspaces tsc -b
 ```
 
 The project requires at least a PostgreSQL database to be run and uses RabbitMQ as message broker. Both can be started using docker compose.