@bfra.me/create NPM

@bfra.me/create

A command line utility to create new packages from customizable templates.

Installation

You can install @bfra.me/create using your preferred package manager:

# npm
npm install -g @bfra.me/create

# Yarn
yarn global add @bfra.me/create

# pnpm
pnpm add -g @bfra.me/create

Alternatively, you can use npx without installing:

npx @bfra.me/create <package-name> [options]

Usage

CLI

To create a new package, run:

create <package-name> [options]

Options

<package-name>: The name of the package you want to create.
-t, --template (string): Template to use. Default is default.
-v, --version (string): Package version. Default is 1.0.0.
-d, --description (string): Package description.
--author (string): Author of the package.

Example

Create a new package named my-new-package using the default template:

create my-new-package

Create a package with a specific template and description:

create my-new-package --template my-template --description "This is my new package"

Programmatic API

You can also use @bfra.me/create programmatically:

import {createPackage} from "@bfra.me/create"

await createPackage("my-new-package", {
  template: "default",
  version: "1.0.0",
  description: "A new package",
  author: "Your Name",
})

`createPackage(packageName: string, options: CreatePackageOptions): Promise<void>`

Creates a new package with the given name and options.

Parameters

packageName (string): The name of the package to create.
options (CreatePackageOptions): An object containing the following optional properties:
- template (string): The template to use.
- version (string): The version of the package.
- description (string): The description of the package.
- author (string): The author of the package.