PackageJsonFile

A file containing a package.json that defines a package. When placed inside a PackageDirectory, it will contain dependencies and exports for symbols defined inside the package. Additional dependencies and exports can be provided.

jsx

import { PackageJsonFile } from "@alloy-js/typescript";

<PackageJsonFile
  author="string"
  dependencies={Record<string, string>}
  description="string"
  devDependencies={Record<string, string>}
  exports={PackageExports | ExportPath}
  homepage="string"
  keywords={string[]}
  license="string"
  name="string"
  repository={string | {
          type: string;
          url: string;
      }}
  scripts={Record<string, string>}
  type={"module" | "commonjs"}
  version="string"
 />

stc

import { PackageJsonFile } from "@alloy-js/typescript/stc";

PackageJsonFile({
  author: string,
  dependencies: Record<string, string>,
  description: string,
  devDependencies: Record<string, string>,
  exports: PackageExports | ExportPath,
  homepage: string,
  keywords: string[],
  license: string,
  name: string,
  repository: string | {
          type: string;
          url: string;
      },
  scripts: Record<string, string>,
  type: "module" | "commonjs",
  version: string,
}).children(children)

Props

author	optionalstring The author of the package
dependencies	optionalRecord<string, string> The hard-coded dependencies of the package. References to external packages will add to the dependency list automatically. Only list dependencies here that are not referenced via refkey.
description	optionalstring The description of the package
devDependencies	optionalRecord<string, string> The dev dependencies of the package.
exports	optionalPackageExports | ExportPath The hard-coded exports of the package.
homepage	optionalstring The homepage of the package
keywords	optionalstring[] The keywords of the package
license	optionalstring The license of the package
name	string The name of the package
repository	optionalstring | { type: string; url: string; } The repository of the package
scripts	optionalRecord<string, string> The scripts entries of the package.
type	optional”module” | “commonjs” Whether this is a commonjs or module. Defaults to module.
version	string The version of the package

Example

<PackageJsonFile name="my-package" version="1.0.0" />