package_json.ts

Declarations
#

13 declarations

PACKAGE_JSON_EMPTY
#

{ [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; glyph?: string | undefined; logo?: string | undefined; ... 23 more ...; exports?: string | ... 2 more ... | undefined; }

type PackageJson

import {PACKAGE_JSON_EMPTY} from '@fuzdev/gro/package_json.js';

package_json_extract_dependencies
#

package_json.ts view source

(package_json: { [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; glyph?: string | undefined; ... 24 more ...; exports?: string | ... 2 more ... | undefined; }): PackageJsonDep[]

import {package_json_extract_dependencies} from '@fuzdev/gro/package_json.js';

`package_json`

type PackageJson

returns

PackageJsonDep[]

package_json_has_dependency
#

package_json.ts view source

(dep_name: string, package_json: { [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; glyph?: string | undefined; ... 24 more ...; exports?: string | ... 2 more ... | undefined; }, include_peer?: boolean): boolean

import {package_json_has_dependency} from '@fuzdev/gro/package_json.js';

`dep_name`

type string

`package_json`

type PackageJson

`include_peer`

whether a peerDependencies entry counts. Pass false when detecting what a project *is*, since a peer dep declares what it works alongside - a plugin package peered on @sveltejs/kit isn't itself a SvelteKit app.

type boolean

default true

returns

boolean

package_json_load
#

package_json.ts view source

(dir?: string, cache?: Record<string, { [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; ... 25 more ...; exports?: string | ... 2 more ... | undefined; }> | undefined, parse?: boolean, log?: Logger | undefined): Promise<...>

import {package_json_load} from '@fuzdev/gro/package_json.js';

`dir`

type string

default IS_THIS_GRO ? gro_paths.root : paths.root

`cache?`

type Record<string, PackageJson>

optional

`parse`

type boolean

default true

`log?`

type Logger

optional

returns

Promise<PackageJson>

package_json_load_for_gro
#

package_json.ts view source

(): Promise<{ [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; glyph?: string | undefined; ... 24 more ...; exports?: string | ... 2 more ... | undefined; }>

import {package_json_load_for_gro} from '@fuzdev/gro/package_json.js';

returns

Promise<PackageJson>

package_json_parse_repo_url
#

package_json.ts view source

(package_json: { [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; glyph?: string | undefined; ... 24 more ...; exports?: string | ... 2 more ... | undefined; }): { ...; } | undefined

import {package_json_parse_repo_url} from '@fuzdev/gro/package_json.js';

`package_json`

type PackageJson

returns

{ owner: string; repo: string; } | undefined

package_json_serialize
#

package_json.ts view source

(package_json: { [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; glyph?: string | undefined; ... 24 more ...; exports?: string | ... 2 more ... | undefined; }): string

import {package_json_serialize} from '@fuzdev/gro/package_json.js';

`package_json`

type PackageJson

returns

string

package_json_sync
#

package_json.ts view source

(map_package_json: PackageJsonMapper, log: Logger, write?: boolean, dir?: string, exports_dir?: string | undefined): Promise<{ package_json: { [x: string]: unknown; name: string; ... 29 more ...; exports?: string | ... 2 more ... | undefined; } | null; changed: boolean; }>

import {package_json_sync} from '@fuzdev/gro/package_json.js';

`map_package_json`

type PackageJsonMapper

`log`

type Logger

`write`

type boolean

default true

`dir`

type string

default paths.root

`exports_dir?`

the directory whose files become the exports, defaults to LIB_PATH

type string

optional

returns

Promise<{ package_json: { [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; glyph?: string | undefined; ... 24 more ...; exports?: string | ... 2 more ... | undefined; } | null; changed: boolean; }>

package_json_to_exports
#

package_json.ts view source

(paths: string[]): string | Record<string, unknown> | null import {package_json_to_exports} from '@fuzdev/gro/package_json.js';

`paths`

type string[]

returns

PackageJsonExports

package_json_update
#

package_json.ts view source

(update: (package_json: { [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; glyph?: string | undefined; ... 24 more ...; exports?: string | ... 2 more ... | undefined; }) => { ...; } | ... 1 more ... | null, dir?: string, write?: boolean): Promise<...>

import {package_json_update} from '@fuzdev/gro/package_json.js';

Updates package.json. Writes to the filesystem only when contents change.

`update`

type

(package_json: { [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; glyph?: string | undefined; ... 24 more ...; exports?: string | ... 2 more ... | undefined; }) => { ...; } | ... 1 more ... | null

`dir`

type string

default paths.root

`write`

type boolean

default true

returns

package_json_write
#

package_json.ts view source

(serialized_package_json: string): Promise<void> import {package_json_write} from '@fuzdev/gro/package_json.js';

`serialized_package_json`

type string

returns

Promise<void>

PackageJsonDep
#

package_json.ts view source

PackageJsonDep import type {PackageJsonDep} from '@fuzdev/gro/package_json.js';

`name`

type string

`version`

type string

PackageJsonMapper
#

package_json.ts view source

PackageJsonMapper import type {PackageJsonMapper} from '@fuzdev/gro/package_json.js';

`(call)`

type (package_json: { [x: string]: unknown; name: string; version?: string | undefined; private?: boolean | undefined; description?: string | undefined; tagline?: string | undefined; glyph?: string | undefined; ... 24 more ...; exports?: string | ... 2 more ... | undefined; }): { ...; } | ... 1 more ... | null

`package_json`

type PackageJson

returns PackageJson | Promise<PackageJson | null> | null