Interface PackageConfig

The schema for the pxt.json package files

interface PackageConfig {
    additionalFilePath?: string;
    additionalFilePaths?: string[];
    assetPack?: boolean;
    assetPacks?: DependencyMap<boolean>;
    authors?: string[];
    binaryonly?: boolean;
    card?: CodeCard;
    codal?: { libraries?: string[] };
    compileServiceVariant?: string;
    core?: boolean;
    cppDependencies?: Record<string, string>;
    dalDTS?: {
        compileServiceVariant?: string;
        corePackage?: string;
        excludePrefix?: string[];
        includeDirs?: string[];
    };
    dependencies: DependencyMap<string>;
    description?: string;
    disablesVariants?: string[];
    disableTargetTemplateFiles?: boolean;
    documentation?: string;
    experimentalHw?: boolean;
    extension?: PackageExtension;
    features?: string[];
    fileDependencies?: DependencyMap<string>;
    files: string[];
    firmwareUrl?: string;
    gistId?: string;
    hidden?: boolean;
    icon?: string;
    isExtension?: boolean;
    languageRestriction?: LanguageRestriction;
    license?: string;
    name: string;
    npmDependencies?: DependencyMap<string>;
    palette?: string[];
    paletteNames?: string[];
    partial?: boolean;
    platformio?: { dependencies?: DependencyMap<string> };
    preferredEditor?: string;
    public?: boolean;
    requiredCategories?: string[];
    screenSize?: { height: number; width: number };
    searchOnly?: boolean;
    simFiles?: string[];
    skipLocalization?: boolean;
    snippetBuilders?: SnippetConfig[];
    supportedTargets?: string[];
    targetVersions?: TargetVersions;
    testDependencies?: Record<string, string>;
    testFiles?: string[];
    theme?: string | Record<string, string>;
    utf8?: boolean;
    version?: string;
    weight?: number;
    yotta?: YottaConfig;
}

Properties

additionalFilePath?: string
additionalFilePaths?: string[]
assetPack?: boolean
assetPacks?: DependencyMap<boolean>
authors?: string[]
binaryonly?: boolean
card?: CodeCard
codal?: { libraries?: string[] }
compileServiceVariant?: string
core?: boolean
cppDependencies?: Record<string, string>
dalDTS?: {
    compileServiceVariant?: string;
    corePackage?: string;
    excludePrefix?: string[];
    includeDirs?: string[];
}
dependencies: DependencyMap<string>
description?: string
disablesVariants?: string[]
disableTargetTemplateFiles?: boolean
documentation?: string
experimentalHw?: boolean
extension?: PackageExtension
features?: string[]
fileDependencies?: DependencyMap<string>
files: string[]
firmwareUrl?: string
gistId?: string
hidden?: boolean
icon?: string
isExtension?: boolean
languageRestriction?: LanguageRestriction
license?: string
name: string
npmDependencies?: DependencyMap<string>
palette?: string[]
paletteNames?: string[]
partial?: boolean
platformio?: { dependencies?: DependencyMap<string> }
preferredEditor?: string
public?: boolean
requiredCategories?: string[]
screenSize?: { height: number; width: number }
searchOnly?: boolean
simFiles?: string[]
skipLocalization?: boolean
snippetBuilders?: SnippetConfig[]
supportedTargets?: string[]
targetVersions?: TargetVersions
testDependencies?: Record<string, string>
testFiles?: string[]
theme?: string | Record<string, string>
utf8?: boolean
version?: string
weight?: number
yotta?: YottaConfig