library_json.ts

Declarations
#

Library metadata combining package.json with analyzed source.

4 declarations

view source

library_json_parse
#

library_json.ts view source

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

Creates a LibraryJson with computed properties from package.json and source metadata.

package_json

type { [x: string]: unknown; name: string; version: string; private?: boolean | undefined; public?: boolean | undefined; description?: string | undefined; motto?: string | undefined; glyph?: string | undefined; ... 24 more ...; exports?: string | ... 2 more ... | undefined; }

source_json

type { [x: string]: unknown; name: string; version: string; modules?: { [x: string]: unknown; path: string; declarations?: { [x: string]: unknown; name: string; kind: "function" | "type" | "variable" | "class" | "constructor" | "component" | "json" | "css"; ... 19 more ...; alias_of?: { ...; } | undefined; }[] | undefine...

returns

LibraryJson

library_org_url_parse
#

library_json.ts view source

(library: LibraryJson): string | null

Extracts GitHub org URL from a library, e.g. https://github.com/ryanatkn.

library

type LibraryJson

returns

string | null

library_repo_name_parse
#

library_json.ts view source

(name: string): string

Extracts repo name from a package name, e.g. @fuzdev/fuz_ui → fuz.

name

type string

returns

string

LibraryJson
#

library_json.ts view source

LibraryJson

A library's package.json and source metadata with computed properties.

package_json

type PackageJson

source_json

type SourceJson

name

Package name, e.g. @fuzdev/fuz_ui.

type string

repo_name

Name without scope, e.g. fuz.

type string

repo_url

GitHub repo URL, e.g. https://github.com/fuzdev/fuz_ui.

type Url

owner_name

GitHub user/org, e.g. ryanatkn.

type string | null

homepage_url

type Url | null

logo_url

Logo URL, falls back to favicon.png.

type Url | null

logo_alt

type string

npm_url

type Url | null

changelog_url

type Url | null

published

True if has exports and version is not 0.0.1.

type boolean

Depends on
#