feat: initial working vscode web extension

.github/workflows/test.yaml

@@ -31,9 +31,9 @@ jobs:
  name: Setup pnpm cache
  with:
  path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
- key: ${{ runner.os }}-pnpm-store-v1-${{ hashFiles('**/pnpm-lock.yaml') }}
+ key: ${{ runner.os }}-pnpm-store-v2-${{ hashFiles('**/pnpm-lock.yaml') }}
  restore-keys: |
- ${{ runner.os }}-pnpm-store-v1-
+ ${{ runner.os }}-pnpm-store-v2-
 
  - name: Install dependencies
  run: pnpm install

.gitignore

@@ -2,3 +2,6 @@ coverage/
 dist/
 node_modules/
 data/
+out
+.vscode-test/
+*.vsix

.tool-versions

@@ -1,3 +1,3 @@
 # Pinned here and in devcontainer to avoid OOM issues stemming from
 # https://github.com/TypeStrong/ts-node/issues/1995
-nodejs 20.11.0
+nodejs 20.14.0

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2023 James Dabbs
+Copyright (c) 2014-2024 James Dabbs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package.json

@@ -9,15 +9,15 @@
  "test:cov": "pnpm run --recursive test:cov"
  },
  "devDependencies": {
- "@types/node": "^20.11.3",
- "@vitest/coverage-v8": "^0.34.6",
+ "@types/node": "^20.14.0",
+ "@vitest/coverage-v8": "^1.3.0",
  "nodemon": "^2.0.22",
  "npm-check-updates": "^16.14.12",
  "prettier": "^2.8.8",
  "prettier-plugin-svelte": "^2.10.1",
  "ts-node": "^10.9.2",
- "typescript": "^5.3.3",
- "vite": "^4.5.1",
- "vitest": "^0.34.6"
+ "typescript": "^5.4.5",
+ "vite": "^5.0.0",
+ "vitest": "^1.3.0"
  }
 }

packages/compile/package.json

@@ -37,7 +37,7 @@
  "glob": "^8.1.0",
  "js-yaml": "^4.1.0",
  "yaml-front-matter": "^4.1.1",
- "zod": "^3.22.4"
+ "zod": "^3.23.8"
  },
  "devDependencies": {
  "@types/cors": "^2.8.17",

packages/compile/tsconfig.json

@@ -4,7 +4,7 @@
  "declaration": true,
  "declarationDir": "dist/types",
  "module": "es2022",
- "moduleResolution": "node",
+ "moduleResolution": "bundler",
  "noImplicitAny": true,
  "outDir": "dist/esm",
  "preserveConstEnums": true,

packages/core/bin/build

@@ -0,0 +1,12 @@
+#!/bin/bash
+set -exo pipefail
+
+# VSCode extensions can only use CommonJS modules (for now), but we want to 
+# continue using our standard Vite/ESM build process elsewhere. This builds
+# both versions, corresponding to `package.json`'s `exports` field.
+
+tsc --module es2022 --outDir dist/esm/
+echo '{"type": "module"}' > dist/esm/package.json
+
+tsc --module commonjs --outDir dist/cjs/
+echo '{"type": "commonjs"}' > dist/cjs/package.json

packages/core/package.json

@@ -14,15 +14,19 @@
  },
  "license": "MIT",
  "author": "James Dabbs <[email protected]> (https://jdabbs.com)",
- "main": "./dist/esm/index.js",
  "types": "./dist/types/index.d.ts",
+ "exports": {
+ "types": "./dist/types/index.d.ts",
+ "require": "./dist/cjs/index.js",
+ "import": "./dist/esm/index.js"
+ },
  "repository": {
  "type": "git",
  "url": "git+https://github.com/pi-base/web.git"
  },
  "scripts": {
  "build:peg": "peggy --plugin ./node_modules/ts-pegjs/dist/tspegjs -o src/Formula/Grammar.ts --cache src/Formula/Grammar.pegjs",
- "build": "pnpm build:peg && tsc",
+ "build": "pnpm build:peg && ./bin/build",
  "dev": "pnpm build:peg && tsc --watch",
  "test": "vitest run",
  "test:cov": "vitest run --coverage",
@@ -40,7 +44,7 @@
  "unified": "^10.1.2",
  "unist-util-is": "^5.2.1",
  "unist-util-visit": "^4.1.2",
- "zod": "^3.22.4"
+ "zod": "^3.23.8"
  },
  "devDependencies": {
  "@types/debug": "^4.1.12",

packages/core/src/Bundle.ts

@@ -6,11 +6,7 @@ import { Space, spaceSchema } from './Space.js'
 import { Theorem, theoremSchema } from './Theorem.js'
 import { Trait, traitSchema } from './Trait.js'
 
-export const defaultHost = import.meta.env?.VITE_PUBLIC_DATA_URL
- ? import.meta.env.VITE_PUBLIC_DATA_URL
- : import.meta.env?.DEV
- ? 'http://localhost:3141'
- : 'https://pi-base-bundles.s3.us-east-2.amazonaws.com'
+export const defaultHost = 'https://pi-base-bundles.s3.us-east-2.amazonaws.com'
 
 export type Version = {
  ref: string

packages/core/src/Id.ts

@@ -54,3 +54,39 @@ export function toInt(id: string): number {
 
  return tagged.id
 }
+
+// TODO: these were extracted from other parallel-but-divergent implementations
+// and should be unified.
+
+type Pad = '' | '0' | '00' | '000' | '0000' | '00000' | '00000'
+type XId<Prefix extends string> = `${Prefix}${Pad}${number}`
+
+export type SId = XId<'S'>
+export type PId = XId<'P'>
+export type TId = XId<'T'>
+export type SPId = [SId, PId]
+export type EntityId = SId | PId | TId | SPId
+
+export function isSpaceId(token: string): token is SId {
+ return token.match(/^S\d{1,6}$/) !== null
+}
+
+export function isPropertyId(token: string): token is PId {
+ return token.match(/^P\d{1,6}$/) !== null
+}
+
+export function isTheoremId(token: string): token is SId {
+ return token.match(/^T\d{1,6}$/) !== null
+}
+
+export function isTraitId(pair: [string, string]): pair is SPId {
+ return isSpaceId(pair[0]) && isPropertyId(pair[1])
+}
+
+export const idExp = /[PST]\d{1,6}/g
+
+export function normalizeId(id: SId): SId
+export function normalizeId(id: PId): PId
+export function normalizeId(id: string) {
+ return `${id[0]}${id.slice(1).padStart(6, '0')}`
+}

packages/core/src/Property.ts

@@ -1,5 +1,15 @@
 import { z } from 'zod'
 import { recordSchema } from './Record.js'
+import { refSchema } from './Ref.js'
+
+export const propertyPageSchema = z.object({
+ uid: z.string(),
+ name: z.string(),
+ aliases: z.array(z.string()).optional(),
+ counterexamples_id: z.number().nullable().optional(),
+ refs: z.array(refSchema).optional(),
+ description: z.string(),
+})
 
 export const propertySchema = z.intersection(
  z.object({
@@ -10,3 +20,4 @@ export const propertySchema = z.intersection(
 )
 
 export type Property = z.infer<typeof propertySchema>
+export type PropertyPage = z.infer<typeof propertyPageSchema>

packages/core/src/Space.ts

@@ -1,5 +1,15 @@
 import { z } from 'zod'
 import { recordSchema } from './Record.js'
+import { refSchema } from './Ref.js'
+
+export const spacePageSchema = z.object({
+ uid: z.string(),
+ name: z.string(),
+ aliases: z.array(z.string()).optional(),
+ counterexamples_id: z.number().nullable().optional(),
+ refs: z.array(refSchema).optional(),
+ description: z.string(),
+})
 
 export const spaceSchema = z.intersection(
  z.object({
@@ -11,3 +21,4 @@ export const spaceSchema = z.intersection(
 )
 
 export type Space = z.infer<typeof spaceSchema>
+export type SpacePage = z.infer<typeof spacePageSchema>

packages/core/src/index.ts

@@ -1,20 +1,20 @@
 import { formulaSchema } from './Formula.js'
-import { propertySchema } from './Property.js'
-import { spaceSchema } from './Space.js'
+import { propertySchema, propertyPageSchema } from './Property.js'
+import { spaceSchema, spacePageSchema } from './Space.js'
 import { theoremSchema } from './Theorem.js'
 import { traitSchema } from './Trait.js'
 
 export { type Bundle } from './Bundle.js'
 export { type Formula, type And, type Atom, type Or } from './Formula.js'
 export { parser } from './Parser.js'
-export { type Property } from './Property.js'
+export { type Property, PropertyPage } from './Property.js'
 export {
  ImplicationIndex,
  deduceTraits,
  disproveFormula,
  proveTheorem,
 } from './Logic/index.js'
-export { type Space } from './Space.js'
+export { type Space, SpacePage } from './Space.js'
 export { type Theorem } from './Theorem.js'
 export { type Trait } from './Trait.js'
 export { type Version } from './Bundle.js'
@@ -29,7 +29,9 @@ export * as TestUtils from './testUtils.js'
 export const schemas = {
  formula: formulaSchema,
  property: propertySchema,
+ propertyPage: propertyPageSchema,
  space: spaceSchema,
+ spacePage: spacePageSchema,
  theorem: theoremSchema,
  trait: traitSchema,
 }

packages/core/test/Parser.test.ts

@@ -42,7 +42,7 @@ it.todo('handles a missing id', () => {
 })
 
 it('handles an initial tag', () => {
- expect(parse('{')).resolves.toEqual('{')
+ expect(parse('{')).rejects.toThrow()
 })
 
 it('handles an incomplete internal link', () => {

packages/core/test/__snapshots__/Parser.test.ts.snap

@@ -1,19 +1,19 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`parses a complex example 1`] = `
-"<p>Inline math <span class=\\"math math-inline\\"><span class=\\"katex\\"><span class=\\"katex-mathml\\"><math xmlns=\\"http://www.w3.org/1998/Math/MathML\\"><semantics><mrow><mn>2</mn><mo>+</mo><mn>2</mn><mo>=</mo><mn>4</mn></mrow><annotation encoding=\\"application/x-tex\\">2 + 2 = 4</annotation></semantics></math></span><span class=\\"katex-html\\" aria-hidden=\\"true\\"><span class=\\"base\\"><span class=\\"strut\\" style=\\"height:0.7278em;vertical-align:-0.0833em;\\"></span><span class=\\"mord\\">2</span><span class=\\"mspace\\" style=\\"margin-right:0.2222em;\\"></span><span class=\\"mbin\\">+</span><span class=\\"mspace\\" style=\\"margin-right:0.2222em;\\"></span></span><span class=\\"base\\"><span class=\\"strut\\" style=\\"height:0.6444em;\\"></span><span class=\\"mord\\">2</span><span class=\\"mspace\\" style=\\"margin-right:0.2778em;\\"></span><span class=\\"mrel\\">=</span><span class=\\"mspace\\" style=\\"margin-right:0.2778em;\\"></span></span><span class=\\"base\\"><span class=\\"strut\\" style=\\"height:0.6444em;\\"></span><span class=\\"mord\\">4</span></span></span></span></span> and display math <span class=\\"math math-inline\\"><span class=\\"katex\\"><span class=\\"katex-mathml\\"><math xmlns=\\"http://www.w3.org/1998/Math/MathML\\"><semantics><mrow><mn>2</mn><mo>+</mo><mn>2</mn><mo>=</mo><mn>4</mn></mrow><annotation encoding=\\"application/x-tex\\">2 + 2 = 4</annotation></semantics></math></span><span class=\\"katex-html\\" aria-hidden=\\"true\\"><span class=\\"base\\"><span class=\\"strut\\" style=\\"height:0.7278em;vertical-align:-0.0833em;\\"></span><span class=\\"mord\\">2</span><span class=\\"mspace\\" style=\\"margin-right:0.2222em;\\"></span><span class=\\"mbin\\">+</span><span class=\\"mspace\\" style=\\"margin-right:0.2222em;\\"></span></span><span class=\\"base\\"><span class=\\"strut\\" style=\\"height:0.6444em;\\"></span><span class=\\"mord\\">2</span><span class=\\"mspace\\" style=\\"margin-right:0.2778em;\\"></span><span class=\\"mrel\\">=</span><span class=\\"mspace\\" style=\\"margin-right:0.2778em;\\"></span></span><span class=\\"base\\"><span class=\\"strut\\" style=\\"height:0.6444em;\\"></span><span class=\\"mord\\">4</span></span></span></span></span>.</p>
+"<p>Inline math <span class="math math-inline"><span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mn>2</mn><mo>+</mo><mn>2</mn><mo>=</mo><mn>4</mn></mrow><annotation encoding="application/x-tex">2 + 2 = 4</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.7278em;vertical-align:-0.0833em;"></span><span class="mord">2</span><span class="mspace" style="margin-right:0.2222em;"></span><span class="mbin">+</span><span class="mspace" style="margin-right:0.2222em;"></span></span><span class="base"><span class="strut" style="height:0.6444em;"></span><span class="mord">2</span><span class="mspace" style="margin-right:0.2778em;"></span><span class="mrel">=</span><span class="mspace" style="margin-right:0.2778em;"></span></span><span class="base"><span class="strut" style="height:0.6444em;"></span><span class="mord">4</span></span></span></span></span> and display math <span class="math math-inline"><span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mn>2</mn><mo>+</mo><mn>2</mn><mo>=</mo><mn>4</mn></mrow><annotation encoding="application/x-tex">2 + 2 = 4</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.7278em;vertical-align:-0.0833em;"></span><span class="mord">2</span><span class="mspace" style="margin-right:0.2222em;"></span><span class="mbin">+</span><span class="mspace" style="margin-right:0.2222em;"></span></span><span class="base"><span class="strut" style="height:0.6444em;"></span><span class="mord">2</span><span class="mspace" style="margin-right:0.2778em;"></span><span class="mrel">=</span><span class="mspace" style="margin-right:0.2778em;"></span></span><span class="base"><span class="strut" style="height:0.6444em;"></span><span class="mord">4</span></span></span></span></span>.</p>
 <p>This is a list of links</p>
 <ul>
-<li><a href=\\"S://000123\\" title=\\"000123\\" class=\\"internal-link\\">000123</a></li>
-<li><a href=\\"P://000123\\" title=\\"000123\\" class=\\"internal-link\\">000123</a></li>
-<li><a href=\\"T://000123\\" title=\\"000123\\" class=\\"internal-link\\">000123</a></li>
-<li><a href=\\"doi://123\\" title=\\"123\\" class=\\"external-link\\">123</a></li>
-<li><a href=\\"mr://123\\" title=\\"123\\" class=\\"external-link\\">123</a></li>
-<li><a href=\\"wikipedia://123\\" title=\\"123\\" class=\\"external-link\\">123</a></li>
-<li><a href=\\"mathse://123\\" title=\\"123\\" class=\\"external-link\\">123</a></li>
-<li><a href=\\"mo://123\\" title=\\"123\\" class=\\"external-link\\">123</a></li>
-<li><a href=\\"zb://123\\" title=\\"123\\" class=\\"external-link\\">123</a></li>
+<li><a href="S://000123" title="000123" class="internal-link">000123</a></li>
+<li><a href="P://000123" title="000123" class="internal-link">000123</a></li>
+<li><a href="T://000123" title="000123" class="internal-link">000123</a></li>
+<li><a href="doi://123" title="123" class="external-link">123</a></li>
+<li><a href="mr://123" title="123" class="external-link">123</a></li>
+<li><a href="wikipedia://123" title="123" class="external-link">123</a></li>
+<li><a href="mathse://123" title="123" class="external-link">123</a></li>
+<li><a href="mo://123" title="123" class="external-link">123</a></li>
+<li><a href="zb://123" title="123" class="external-link">123</a></li>
 </ul>"
 `;
 
-exports[`truncate > preserves math 1`] = `"this is a fairly long sentence and it needs to be summarized because it is too long because it <span class=\\"math math-inline\\"><span class=\\"katex\\"><span class=\\"katex-mathml\\"><math xmlns=\\"http://www.w3.org/1998/Math/MathML\\"><semantics><mrow><msub><mi>T</mi><mrow><mn>3</mn><mfrac><mn>1</mn><mn>2</mn></mfrac></mrow></msub></mrow><annotation encoding=\\"application/x-tex\\">T_{3\\\\frac{1}{2}}</annotation></semantics></math></span><span class=\\"katex-html\\" aria-hidden=\\"true\\"><span class=\\"base\\"><span class=\\"strut\\" style=\\"height:1.1704em;vertical-align:-0.487em;\\"></span><span class=\\"mord\\"><span class=\\"mord mathnormal\\" style=\\"margin-right:0.13889em;\\">T</span><span class=\\"msupsub\\"><span class=\\"vlist-t vlist-t2\\"><span class=\\"vlist-r\\"><span class=\\"vlist\\" style=\\"height:0.3448em;\\"><span style=\\"top:-2.7538em;margin-left:-0.1389em;margin-right:0.05em;\\"><span class=\\"pstrut\\" style=\\"height:3em;\\"></span><span class=\\"sizing reset-size6 size3 mtight\\"><span class=\\"mord mtight\\"><span class=\\"mord mtight\\">3</span><span class=\\"mord mtight\\"><span class=\\"mopen nulldelimiter sizing reset-size3 size6\\"></span><span class=\\"mfrac\\"><span class=\\"vlist-t vlist-t2\\"><span class=\\"vlist-r\\"><span class=\\"vlist\\" style=\\"height:0.8443em;\\"><span style=\\"top:-2.656em;\\"><span class=\\"pstrut\\" style=\\"height:3em;\\"></span><span class=\\"sizing reset-size3 size1 mtight\\"><span class=\\"mord mtight\\"><span class=\\"mord mtight\\">2</span></span></span></span><span style=\\"top:-3.2255em;\\"><span class=\\"pstrut\\" style=\\"height:3em;\\"></span><span class=\\"frac-line mtight\\" style=\\"border-bottom-width:0.049em;\\"></span></span><span style=\\"top:-3.384em;\\"><span class=\\"pstrut\\" style=\\"height:3em;\\"></span><span class=\\"sizing reset-size3 size1 mtight\\"><span class=\\"mord mtight\\"><span class=\\"mord mtight\\">1</span></span></span></span></span><span class=\\"vlist-s\\">​…</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>"`;
+exports[`truncate > preserves math 1`] = `"this is a fairly long sentence and it needs to be summarized because it is too long because it <span class="math math-inline"><span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><msub><mi>T</mi><mrow><mn>3</mn><mfrac><mn>1</mn><mn>2</mn></mfrac></mrow></msub></mrow><annotation encoding="application/x-tex">T_{3\\frac{1}{2}}</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:1.1704em;vertical-align:-0.487em;"></span><span class="mord"><span class="mord mathnormal" style="margin-right:0.13889em;">T</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.3448em;"><span style="top:-2.7538em;margin-left:-0.1389em;margin-right:0.05em;"><span class="pstrut" style="height:3em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mtight"><span class="mord mtight">3</span><span class="mord mtight"><span class="mopen nulldelimiter sizing reset-size3 size6"></span><span class="mfrac"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.8443em;"><span style="top:-2.656em;"><span class="pstrut" style="height:3em;"></span><span class="sizing reset-size3 size1 mtight"><span class="mord mtight"><span class="mord mtight">2</span></span></span></span><span style="top:-3.2255em;"><span class="pstrut" style="height:3em;"></span><span class="frac-line mtight" style="border-bottom-width:0.049em;"></span></span><span style="top:-3.384em;"><span class="pstrut" style="height:3em;"></span><span class="sizing reset-size3 size1 mtight"><span class="mord mtight"><span class="mord mtight">1</span></span></span></span></span><span class="vlist-s">​…</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>"`;

packages/viewer/package.json

@@ -33,9 +33,9 @@
  "unist-util-visit": "^4.1.2"
  },
  "devDependencies": {
- "@sveltejs/adapter-cloudflare": "^2.3.4",
- "@sveltejs/kit": "1.30.0",
- "@sveltejs/vite-plugin-svelte": "^2.5.3",
+ "@sveltejs/adapter-cloudflare": "^3.0.0",
+ "@sveltejs/kit": "^2.0.0",
+ "@sveltejs/vite-plugin-svelte": "^3.0.0",
  "@tsconfig/svelte": "^3.0.0",
  "@types/debug": "^4.1.12",
  "@types/hyperscript": "0.0.7",

packages/viewer/src/routes/(app)/spaces/[id]/properties/[propertyId]/+page.ts

@@ -23,6 +23,6 @@ export const load: PageLoad = async function ({
  }),
  checked(spaceId),
  ).catch(() => {
- throw error(404, `Trait not found ${spaceId} / ${propertyId}`)
+ error(404, `Trait not found ${spaceId} / ${propertyId}`)
  })
 }

packages/viewer/svelte.config.js

@@ -1,5 +1,5 @@
 import adapter from '@sveltejs/adapter-cloudflare'
-import { vitePreprocess } from '@sveltejs/kit/vite'
+import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'
 
 /** @type {import('@sveltejs/kit').Config} */
 const config = {

packages/viewer/tsconfig.json

@@ -29,5 +29,6 @@
  "node_modules/@types"
  ],
  "module": "es2022",
+ "moduleResolution": "bundler"
  }
 }

packages/vscode/.eslintrc.json

@@ -0,0 +1,30 @@
+{
+ "root": true,
+ "parser": "@typescript-eslint/parser",
+ "parserOptions": {
+ "ecmaVersion": 6,
+ "sourceType": "module"
+ },
+ "plugins": [
+ "@typescript-eslint"
+ ],
+ "rules": {
+ "@typescript-eslint/naming-convention": [
+ "warn",
+ {
+ "selector": "import",
+ "format": [ "camelCase", "PascalCase" ]
+ }
+ ],
+ "@typescript-eslint/semi": ["error", "never"],
+ "curly": "warn",
+ "eqeqeq": "warn",
+ "no-throw-literal": "warn",
+ "semi": "off"
+ },
+ "ignorePatterns": [
+ "out",
+ "dist",
+ "**/*.d.ts"
+ ]
+}

packages/vscode/.npmrc

@@ -0,0 +1 @@
+enable-pre-post-scripts = true

packages/vscode/.vscode-test.mjs

@@ -0,0 +1,5 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+ files: 'out/test/**/*.test.js',
+});

packages/vscode/.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+ // See http://go.microsoft.com/fwlink/?LinkId=827846
+ // for the documentation about the extensions.json format
+ "recommendations": ["dbaeumer.vscode-eslint", "connor4312.esbuild-problem-matchers", "ms-vscode.extension-test-runner"]
+}