mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-30 20:14:49 +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
94 lines
2.8 KiB
TypeScript
94 lines
2.8 KiB
TypeScript
import * as T from '../../../base/lib/types'
|
|
import { ImageConfig, ImageId, VolumeId } from '../../../base/lib/types'
|
|
import {
|
|
SDKManifest,
|
|
SDKImageInputSpec,
|
|
} from '../../../base/lib/types/ManifestTypes'
|
|
import { OSVersion } from '../StartSdk'
|
|
import { VersionGraph } from '../version/VersionGraph'
|
|
import { version as sdkVersion } from '../../package.json'
|
|
|
|
/**
|
|
* @description Use this function to define critical information about your package
|
|
*
|
|
* @param manifest Static properties of the package
|
|
*/
|
|
export function setupManifest<
|
|
Id extends string,
|
|
VolumesTypes extends VolumeId,
|
|
Manifest extends {
|
|
id: Id
|
|
volumes: VolumesTypes[]
|
|
} & SDKManifest,
|
|
>(manifest: Manifest & SDKManifest): Manifest {
|
|
return manifest
|
|
}
|
|
|
|
export function buildManifest<
|
|
Id extends string,
|
|
Version extends string,
|
|
Dependencies extends Record<string, unknown>,
|
|
VolumesTypes extends VolumeId,
|
|
ImagesTypes extends ImageId,
|
|
Manifest extends {
|
|
dependencies: Dependencies
|
|
id: Id
|
|
images: Record<ImagesTypes, SDKImageInputSpec>
|
|
volumes: VolumesTypes[]
|
|
},
|
|
>(
|
|
versions: VersionGraph<Version>,
|
|
manifest: SDKManifest & Manifest,
|
|
): Manifest & T.Manifest {
|
|
const images = Object.entries(manifest.images).reduce(
|
|
(images, [k, v]) => {
|
|
v.arch = v.arch ?? ['aarch64', 'x86_64', 'riscv64']
|
|
if (v.emulateMissingAs === undefined)
|
|
v.emulateMissingAs = (v.arch as string[]).includes('x86_64')
|
|
? 'x86_64'
|
|
: (v.arch[0] ?? null)
|
|
v.nvidiaContainer = !!v.nvidiaContainer
|
|
images[k] = v as ImageConfig
|
|
return images
|
|
},
|
|
{} as { [k: string]: ImageConfig },
|
|
)
|
|
return {
|
|
...manifest,
|
|
gitHash: null,
|
|
osVersion: manifest.osVersion ?? OSVersion,
|
|
sdkVersion,
|
|
version: versions.current.options.version,
|
|
releaseNotes: versions.current.options.releaseNotes,
|
|
satisfies: versions.current.options.satisfies || [],
|
|
canMigrateTo: versions.canMigrateTo().toString(),
|
|
canMigrateFrom: versions.canMigrateFrom().toString(),
|
|
images,
|
|
alerts: {
|
|
install: manifest.alerts?.install || null,
|
|
update: manifest.alerts?.update || null,
|
|
uninstall: manifest.alerts?.uninstall || null,
|
|
restore: manifest.alerts?.restore || null,
|
|
start: manifest.alerts?.start || null,
|
|
stop: manifest.alerts?.stop || null,
|
|
},
|
|
hardwareRequirements: {
|
|
device: manifest.hardwareRequirements?.device || [],
|
|
ram: manifest.hardwareRequirements?.ram || null,
|
|
arch: Object.values(images).reduce(
|
|
(arch, inputSpec) => {
|
|
if (inputSpec.emulateMissingAs) {
|
|
return arch
|
|
}
|
|
if (arch === null) {
|
|
return inputSpec.arch
|
|
}
|
|
return arch.filter((a) => inputSpec.arch.includes(a))
|
|
},
|
|
null as string[] | null,
|
|
),
|
|
},
|
|
hardwareAcceleration: manifest.hardwareAcceleration ?? false,
|
|
}
|
|
}
|