Interface PackageJson

interface PackageJson {
    bundledDependencies?: Record<string, string>;
    catalogs?: Record<string, Record<string, string>>;
    dependencies?: Record<string, string>;
    description?: string;
    devDependencies?: Record<string, string>;
    engines?: Record<string, string>;
    fuman?: {
        distOnlyFields?: Record<string, unknown>;
        jsr?: "skip" | "only";
        keepScripts?: string[];
        npm?: "skip" | "only";
        ownVersioning?: boolean;
        private?: boolean;
        standalone?: boolean;
    };
    homepage?: string;
    keywords?: string[];
    license?: string;
    name?: string;
    optionalDependencies?: Record<string, string>;
    packageManager?: string;
    peerDependencies?: Record<string, string>;
    pnpm?: { overrides: Record<string, string> };
    private?: boolean;
    repository?: string | { type: string; url: string };
    scripts?: Record<string, string>;
    type?: "module" | "commonjs";
    version?: string;
    workspaces?: string[];
    [key: string]: any;
}

Indexable

  • [key: string]: any

Properties

bundledDependencies? catalogs? dependencies? description? devDependencies? engines? fuman? homepage? keywords? license? name? optionalDependencies? packageManager? peerDependencies? pnpm? private? repository? scripts? type? version? workspaces?

Properties

OptionalbundledDependencies

bundledDependencies?: Record<string, string>

Optionalcatalogs

catalogs?: Record<string, Record<string, string>>

Optionaldependencies

dependencies?: Record<string, string>

Optionaldescription

description?: string

OptionaldevDependencies

devDependencies?: Record<string, string>

Optionalengines

engines?: Record<string, string>

Optionalfuman

fuman?: {
    distOnlyFields?: Record<string, unknown>;
    jsr?: "skip" | "only";
    keepScripts?: string[];
    npm?: "skip" | "only";
    ownVersioning?: boolean;
    private?: boolean;
    standalone?: boolean;
}

fuman-specific package.json fields

Type declaration

  • OptionaldistOnlyFields?: Record<string, unknown>

    any additional fields that will be shallowly merged into the resulting package.json. for more complex modifications than shallow merging, consider using build.config.js

  • Optionaljsr?: "skip" | "only"

    whether the package should be published to jsr (skip – it won't be published to jsr, only – it will only be published to jsr)

  • OptionalkeepScripts?: string[]

    by default @fuman/build strips all scripts, but you can keep some of them by passing their names here

  • Optionalnpm?: "skip" | "only"

    whether the package should be published to npm (skip – it won't be published to npm, only – it will only be published to npm)

  • OptionalownVersioning?: boolean

    whether this package has its own versioning scheme, not managed by @fuman/build (be careful with this option! this might break cross-release semver compatibility)

  • Optionalprivate?: boolean

    whether this package should not be published

  • Optionalstandalone?: boolean

    whether this is a "standalone" package

    standalone packages have a few differences from normal ones:

    • (bump-version) each standalone package has independent versioning
    • (lint) normal packages can't depend on standalone packages
    • (lint) unlike normal packages, standalone packages are allowed to depend on older versions of workspace packages

Optionalhomepage

homepage?: string

Optionalkeywords

keywords?: string[]

Optionallicense

license?: string

Optionalname

name?: string

OptionaloptionalDependencies

optionalDependencies?: Record<string, string>

OptionalpackageManager

packageManager?: string

OptionalpeerDependencies

peerDependencies?: Record<string, string>

Optionalpnpm

pnpm?: { overrides: Record<string, string> }

Optionalprivate

private?: boolean

Optionalrepository

repository?: string | { type: string; url: string }

Optionalscripts

scripts?: Record<string, string>

Optionaltype

type?: "module" | "commonjs"

Optionalversion

version?: string

Optionalworkspaces

workspaces?: string[]

Settings

Member Visibility

On This Page

Properties