@lincyaw/workspace 1.0.0-rc.0 → 1.0.0-rc.2

package/src/node/session.ts

@@ -1,123 +0,0 @@
-import { existsSync, statSync, watch } from 'node:fs'
-import type { FSWatcher } from 'node:fs'
-import { basename, dirname, join } from 'node:path'
-import type { Compilation, Compiler } from '@lincyaw/compiler'
-import { errorMessage } from '@lincyaw/kernel'
-import type { Logger } from '@lincyaw/kernel'
-
-export class DocumentSession {
-  readonly dir: string
-  readonly compiler: Compiler
-  #latest?: Compilation
-  #first?: Promise<Compilation>
-  #running: Promise<unknown> = Promise.resolve()
-  #queued?: Promise<Compilation>
-  readonly #listeners = new Set<(compilation: Compilation, changed: string[]) => void | Promise<void>>()
-  #changedFiles = new Set<string>()
-  readonly #watchers = new Map<string, FSWatcher>()
-  #relevant = new Map<string, Set<string>>()
-  #timer?: NodeJS.Timeout
-  #closed = false
-  readonly #log: Logger
-
-  constructor(dir: string, compiler: Compiler, log: Logger) {
-    this.dir = dir
-    this.compiler = compiler
-    this.#log = log
-  }
-
-  ready(): Promise<Compilation> {
-    if (this.#latest) return Promise.resolve(this.#latest)
-    if (!this.#first) {
-      const first = this.recompile()
-      first.catch(() => {
-        if (this.#first === first) this.#first = undefined
-      })
-      this.#first = first
-    }
-    return this.#first
-  }
-
-  get latest(): Compilation | undefined {
-    return this.#latest
-  }
-
-  onCompile(listener: (compilation: Compilation, changed: string[]) => void | Promise<void>): () => void {
-    this.#listeners.add(listener)
-    return () => this.#listeners.delete(listener)
-  }
-
-  recompile(): Promise<Compilation> {
-    if (this.#queued) return this.#queued
-    const next = this.#running.then(async () => {
-      this.#queued = undefined
-      const started = Date.now()
-      const changed = [...this.#changedFiles]
-      this.#changedFiles.clear()
-      const compilation = await this.compiler.compile()
-      this.#latest = compilation
-      for (const listener of this.#listeners) {
-        try {
-          await listener(compilation, changed)
-        } catch (error) {
-          this.#log.error(`after compiling ${this.dir || '.'}: ${errorMessage(error)}`)
-        }
-      }
-      this.#watch(compilation, started)
-      return compilation
-    })
-    this.#queued = next
-    this.#running = next.catch((error: unknown) => this.#log.error(`compiling ${this.dir || '.'} failed: ${errorMessage(error)}`))
-    return next
-  }
-
-  close(): void {
-    this.#closed = true
-    clearTimeout(this.#timer)
-    for (const watcher of this.#watchers.values()) watcher.close()
-    this.#watchers.clear()
-    this.#listeners.clear()
-  }
-
-  #watch(compilation: Compilation, started: number): void {
-    if (this.#closed) return
-    const files = new Set([...compilation.files, ...compilation.dependencies.files])
-    const next = new Map<string, Set<string>>()
-    for (const file of files) {
-      let dir = dirname(file)
-      let name = basename(file)
-      while (!existsSync(dir) && dirname(dir) !== dir) {
-        name = basename(dir)
-        dir = dirname(dir)
-      }
-      next.set(dir, (next.get(dir) ?? new Set<string>()).add(name))
-    }
-    this.#relevant = next
-    for (const [dir, watcher] of this.#watchers) {
-      if (next.has(dir)) continue
-      watcher.close()
-      this.#watchers.delete(dir)
-    }
-    for (const dir of next.keys()) {
-      if (this.#watchers.has(dir)) continue
-      try {
-        this.#watchers.set(dir, watch(dir, (_event, name) => {
-          if (name && this.#relevant.get(dir)?.has(basename(name))) this.#changed(join(dir, name))
-        }))
-      } catch {
-      }
-    }
-    const modified = [...files].filter((file) => {
-      const time = statSync(file, { throwIfNoEntry: false })?.mtimeMs ?? 0
-      return time >= started - 20 && time <= Date.now()
-    })
-    for (const file of modified) this.#changed(file)
-  }
-
-  #changed(file: string): void {
-    if (this.#closed) return
-    this.#changedFiles.add(file)
-    clearTimeout(this.#timer)
-    this.#timer = setTimeout(() => void this.recompile().catch(() => undefined), 50)
-  }
-}

package/src/node/source.ts

@@ -1,148 +0,0 @@
-import { createHash } from 'node:crypto'
-import { lstatSync, readdirSync, readFileSync, realpathSync } from 'node:fs'
-import { join } from 'node:path'
-import type { DocumentFileChange, Member } from '@lincyaw/kernel'
-import type { ConflictAnswer, FilesAnswer, SourceAnswer, SourceFile } from '../domain/api.ts'
-import { WORKSPACE_FILE } from '../domain/api.ts'
-import { within } from '../domain/paths.ts'
-import { listDocuments } from './config.ts'
-import type { WorkspaceConfig } from './config.ts'
-import { lockedError, RequestError } from './documents.ts'
-import { documentDirOf, writeChanges } from './files.ts'
-import type { DocumentWriter } from './files.ts'
-import type { DocumentLocks } from './locks.ts'
-
-export const MAX_SOURCE = 2 << 20
-const MAX_FILES = 2000
-const NOT_SOURCE = new Set(['node_modules', 'dist', '.git', '.presmium'])
-const BINARY = /\.(?:png|jpe?g|gif|webp|avif|ico|bmp|pdf|wasm|zip|gz|tgz|bz2|xz|7z|woff2?|ttf|otf|eot|mp3|mp4|m4a|wav|ogg|oga|webm|mov|avi|mkv|bin|so|dylib|dll|exe|pyc|xlsx?|docx?|pptx?|parquet|npy|npz|pkl|db|sqlite)$/i
-
-export function versionOf(bytes: Uint8Array | string): string {
-  return createHash('sha256').update(bytes).digest('hex').slice(0, 20)
-}
-
-export interface SourceOptions {
-  config: WorkspaceConfig
-  writer: DocumentWriter
-  locks?: DocumentLocks
-}
-
-interface Scope {
-  document: string
-  home: boolean
-}
-
-export class SourceFiles {
-  readonly #config: WorkspaceConfig
-  readonly #writer: DocumentWriter
-  readonly #locks?: DocumentLocks
-
-  constructor(options: SourceOptions) {
-    this.#config = options.config
-    this.#writer = options.writer
-    this.#locks = options.locks
-  }
-
-  scope(document: string): Scope {
-    return { document, home: document === '' && !this.#config.single }
-  }
-
-  roots(scope: Scope): string[] {
-    if (!scope.home) return [scope.document]
-    return ['']
-  }
-
-  allows(scope: Scope, path: string, member: Member): boolean {
-    if (path === WORKSPACE_FILE) return (scope.home || (this.#config.single && scope.document === '')) && member.roles.includes('owner')
-    if (scope.home && member.roles.includes('owner')) return true
-    const dir = documentDirOf(this.#config, path)
-    if (dir === undefined) return scope.home && member.roles.includes('owner')
-    return scope.home ? listDocuments(this.#config).some(doc => doc.dir === dir) : dir === scope.document
-  }
-
-  files(scope: Scope, member: Member): FilesAnswer {
-    const files: SourceFile[] = []
-    let truncated = false
-    const walk = (dir: string, owner: string | undefined) => {
-      let names: string[]
-      try {
-        names = readdirSync(join(this.#config.root, dir)).sort()
-      } catch {
-        return
-      }
-      for (const name of names) {
-        if (NOT_SOURCE.has(name) || name.startsWith('.')) continue
-        const path = dir ? `${dir}/${name}` : name
-        const found = lstatSync(join(this.#config.root, path), { throwIfNoEntry: false })
-        if (!found || found.isSymbolicLink()) continue
-        if (found.isDirectory() && (scope.home || documentDirOf(this.#config, `${path}/x`) === owner)) {
-          walk(path, owner)
-        } else if (found.isFile() && this.allows(scope, path, member)) {
-          if (files.length >= MAX_FILES) {
-            truncated = true
-            return
-          }
-          files.push({ path, ...BINARY.test(name) ? { binary: true as const } : {} })
-        }
-      }
-    }
-    walk(scope.home ? '' : scope.document, scope.home ? undefined : scope.document)
-    const documents = scope.home ? listDocuments(this.#config).map(doc => doc.dir) : undefined
-    return { document: scope.document, home: scope.home, ...documents ? { documents } : {}, files, ...truncated ? { truncated: true as const } : {} }
-  }
-
-  #bytes(scope: Scope, path: string, member: Member): Buffer {
-    if (typeof path !== 'string' || !path || path.startsWith('/') || path.includes('\0') || path.split('/').some(part => part === '' || part === '.' || part === '..' || NOT_SOURCE.has(part))) throw new RequestError(400, `not a source path: ${JSON.stringify(path)}`)
-    if (!this.allows(scope, path, member)) throw new RequestError(403, `${path} is not a file this page edits`)
-    const file = join(this.#config.root, path)
-    let real: string
-    try {
-      real = realpathSync(file)
-    } catch {
-      throw new RequestError(404, `no file ${path}`)
-    }
-    if (real !== file || !lstatSync(file).isFile()) throw new RequestError(403, `${path} is not a regular file of the workspace`)
-    const bytes = readFileSync(file)
-    if (bytes.byteLength > MAX_SOURCE) throw new RequestError(413, `${path} is larger than the editor opens (${MAX_SOURCE} bytes)`)
-    return bytes
-  }
-
-  read(scope: Scope, path: string, member: Member): SourceAnswer {
-    const bytes = this.#bytes(scope, path, member)
-    if (BINARY.test(path) || bytes.includes(0)) throw new RequestError(415, `${path} is not a text file`)
-    let content: string
-    try {
-      content = new TextDecoder('utf-8', { fatal: true }).decode(bytes)
-    } catch {
-      throw new RequestError(415, `${path} is not UTF-8 text`)
-    }
-    return { path, content, version: versionOf(bytes) }
-  }
-
-  async save(scope: Scope, path: string, content: string, base: string, member: Member): Promise<string> {
-    const document = listDocuments(this.#config).sort((a, b) => b.dir.length - a.dir.length).find(doc => within(path, doc.dir))?.dir
-    const outside = document === undefined
-    const release = outside || !this.#locks ? () => {} : this.#locks.claim(document, 'editor:save')
-    if (!release) throw lockedError(document!, this.#locks!.holder(document!) ?? '')
-    try {
-      const bytes = this.#bytes(scope, path, member)
-      const now = versionOf(bytes)
-      if (now !== base) {
-        const conflict: Omit<ConflictAnswer, 'error'> = { conflict: { version: now, content: bytes.toString('utf8') } }
-        throw new RequestError(409, `${path} changed since it was opened`, conflict)
-      }
-      const written = Buffer.from(content, 'utf8')
-      if (written.byteLength > MAX_SOURCE) throw new RequestError(413, `the text is larger than the editor saves (${MAX_SOURCE} bytes)`)
-      const change: DocumentFileChange = { path, content: written, ...(lstatSync(join(this.#config.root, path)).mode & 0o111) !== 0 ? { executable: true } : {} }
-      if (outside) writeChanges(this.#config, [change], true)
-      else await this.#writer.write([change])
-      return versionOf(written)
-    } finally {
-      release()
-    }
-  }
-
-  inScope(scope: Scope, path: string): boolean {
-    return this.roots(scope).some(root => root === WORKSPACE_FILE ? path === root : within(path, root))
-  }
-}

package/templates/document/default/lecture.md

@@ -1,18 +0,0 @@
----
-title: "{{title}}"
-plugins:
-  - '@lincyaw/slidev-addon-core'   # 幻灯片形态的宿主适配：插件的组件与导出靠它
----
-
-# 引言
-
-在这里写本讲的讲解。第一级标题开始一章，第二级标题开始一节；每节在网页中是一段，在幻灯片中是一页。
-
-:::{slide}
-- 要点一
-- 要点二
-:::
-
-# 小结
-
-本讲的要点。