mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-26 18:31:52 +00:00
f2142f0bb3
* add documentation for ai agents * docs: consolidate CLAUDE.md and CONTRIBUTING.md, add style guidelines - Refactor CLAUDE.md to reference CONTRIBUTING.md for build/test/format info - Expand CONTRIBUTING.md with comprehensive build targets, env vars, and testing - Add code style guidelines section with conventional commits - Standardize SDK prettier config to use single quotes (matching web) - Add project-level Claude Code settings to disable co-author attribution * style(sdk): apply prettier with single quotes Run prettier across sdk/base and sdk/package to apply the standardized quote style (single quotes matching web). * docs: add USER.md for per-developer TODO filtering - Add agents/USER.md to .gitignore (contains user identifier) - Document session startup flow in CLAUDE.md: - Create USER.md if missing, prompting for identifier - Filter TODOs by @username tags - Offer relevant TODOs on session start * docs: add i18n documentation task to agent TODOs * docs: document i18n ID patterns in core/ Add agents/i18n-patterns.md covering rust-i18n setup, translation file format, t!() macro usage, key naming conventions, and locale selection. Remove completed TODO item and add reference in CLAUDE.md. * chore: clarify that all builds work on any OS with Docker
89 lines
2.6 KiB
TypeScript
89 lines
2.6 KiB
TypeScript
import * as fs from 'node:fs/promises'
|
|
import * as T from '../../../base/lib/types'
|
|
|
|
/**
|
|
* Common interface for objects that have a subpath method (Volume, SubContainer, etc.)
|
|
*/
|
|
export interface PathBase {
|
|
subpath(path: string): string
|
|
}
|
|
|
|
/**
|
|
* @description Represents a volume in the StartOS filesystem.
|
|
* Provides utilities for reading and writing files within the volume.
|
|
*/
|
|
export class Volume<Id extends string = string> implements PathBase {
|
|
/**
|
|
* The absolute path to this volume's root directory
|
|
*/
|
|
readonly path: string
|
|
|
|
constructor(readonly id: Id) {
|
|
this.path = `/media/startos/volumes/${id}`
|
|
}
|
|
|
|
/**
|
|
* Get the absolute path to a file or directory within this volume
|
|
* @param subpath Path relative to the volume root
|
|
*/
|
|
subpath(subpath: string): string {
|
|
return subpath.startsWith('/')
|
|
? `${this.path}${subpath}`
|
|
: `${this.path}/${subpath}`
|
|
}
|
|
|
|
/**
|
|
* @description Read a file from this volume
|
|
* @param subpath Path relative to the volume root (e.g. "config.json" or "/data/file.txt")
|
|
* @param options Optional read options (same as node:fs/promises readFile)
|
|
*/
|
|
async readFile(
|
|
subpath: string,
|
|
options?: Parameters<typeof fs.readFile>[1],
|
|
): Promise<Buffer | string> {
|
|
const fullPath = this.subpath(subpath)
|
|
return fs.readFile(fullPath, options)
|
|
}
|
|
|
|
/**
|
|
* @description Write a file to this volume
|
|
* @param subpath Path relative to the volume root (e.g. "config.json" or "/data/file.txt")
|
|
* @param data The data to write
|
|
* @param options Optional write options (same as node:fs/promises writeFile)
|
|
*/
|
|
async writeFile(
|
|
subpath: string,
|
|
data:
|
|
| string
|
|
| NodeJS.ArrayBufferView
|
|
| Iterable<string | NodeJS.ArrayBufferView>
|
|
| AsyncIterable<string | NodeJS.ArrayBufferView>,
|
|
options?: Parameters<typeof fs.writeFile>[2],
|
|
): Promise<void> {
|
|
const fullPath = this.subpath(subpath)
|
|
const dir = fullPath.replace(/\/[^/]*\/?$/, '')
|
|
await fs.mkdir(dir, { recursive: true })
|
|
return fs.writeFile(fullPath, data, options)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Type-safe volumes object that provides Volume instances for each volume defined in the manifest
|
|
*/
|
|
export type Volumes<Manifest extends T.SDKManifest> = {
|
|
[K in Manifest['volumes'][number]]: Volume<K>
|
|
}
|
|
|
|
/**
|
|
* Creates a type-safe volumes object from a manifest
|
|
*/
|
|
export function createVolumes<Manifest extends T.SDKManifest>(
|
|
manifest: Manifest,
|
|
): Volumes<Manifest> {
|
|
const volumes = {} as Volumes<Manifest>
|
|
for (const volumeId of manifest.volumes) {
|
|
;(volumes as any)[volumeId] = new Volume(volumeId)
|
|
}
|
|
return volumes
|
|
}
|