Merge pull request #1915 from nellh/schema-web-validator

Add vite web validator for the schema validator

Author: rwblair

bids-validator/build.ts

@@ -7,9 +7,16 @@
 import * as esbuild from 'https://deno.land/x/[email protected]/mod.js'
 import { parse } from 'https://deno.land/[email protected]/flags/mod.ts'
 import { denoPlugins } from "https://deno.land/x/[email protected]/mod.ts"
+import * as path from "https://deno.land/[email protected]/path/mod.ts"
 
-const MAIN_ENTRY = 'src/main.ts'
-const CLI_ENTRY = 'src/bids-validator.ts'
+function getModuleDir(importMeta: ImportMeta): string {
+  return path.resolve(path.dirname(path.fromFileUrl(importMeta.url)));
+}
+
+const dir = getModuleDir(import.meta);
+
+const MAIN_ENTRY = path.join(dir, 'src', 'main.ts')
+const CLI_ENTRY = path.join(dir, 'src', 'bids-validator.ts')
 
 const flags = parse(Deno.args, {
   boolean: ['minify'],
@@ -20,7 +27,7 @@ const result = await esbuild.build({
   format: 'esm',
   entryPoints: [MAIN_ENTRY, CLI_ENTRY],
   bundle: true,
-  outdir: 'dist/validator',
+  outdir: path.join('dist','validator'),
   minify: flags.minify,
   target: ['chrome109', 'firefox109', 'safari16'],
   plugins: [...denoPlugins()],

web/.gitignore

@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+.vite
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

web/README.md

@@ -0,0 +1,32 @@
+# BIDS Validator web app
+
+This is a web app for running the schema based BIDS validator in the browser. For local development, this is run using deno and uses an esbuild bundle created from the native deno codebase. A bundle is generated in `dist/validator` and used by the otherwise static vite app.
+
+## Running
+
+You need to have Deno v1.28.0 or later installed to run this repo.
+
+Start a dev server:
+
+```
+$ deno task dev
+```
+
+## Deploy
+
+Build production assets:
+
+```
+$ deno task build
+```
+
+## Notes
+
+- You need to use `.mjs` or `.mts` extension for the `vite.config.[ext]` file.
+
+## Papercuts
+
+Currently there's a "papercut" for Deno users:
+
+- peer dependencies need to be referenced in `vite.config.js` - in this example
+  it is `react` and `react-dom` packages that need to be referenced

web/deno.json

@@ -0,0 +1,8 @@
+{
+  "tasks": {
+    "dev": "../bids-validator/build.ts && deno run -A --node-modules-dir npm:vite",
+    "build": "../bids-validator/build.ts && deno run -A --node-modules-dir npm:vite build",
+    "preview": "deno run -A --node-modules-dir npm:vite preview",
+    "serve": "deno run --allow-net --allow-read https://deno.land/[email protected]/http/file_server.ts dist/"
+  }
+}