JSPM

  • Created
  • Published
  • Downloads 791
  • Score
    100M100P100Q92745F
  • License MIT

The create step of Extension.js

Package Exports

  • extension-create

Readme

Empowering Version Downloads

extension-create

Scaffold a new Extension.js project from a template.

This package implements the logic Extension.js uses to scaffold a new extension project from a selected template. It performs, in order:

  • Create or reuse the target directory (and fail on conflicting files)
  • Import the selected template (local in dev, remote via Git in prod)
  • Write package.json metadata and add Extension.js scripts
  • Write manifest.json metadata
  • Initialize a Git repository
  • Write a .gitignore
  • Remove template-only test files
  • If the template is TypeScript-based, generate extension-env.d.ts

Installation

pnpm add extension-create

Usage

import {extensionCreate} from 'extension-create'

async function createNewExtension () {
  await extensionCreate(
    projectName: /* string (required) */,
    {
      template: 'init', // or any template name (see /examples)
      install: false,   // optionally run the package manager install step
      cliVersion: '2.x' // used to pin the CLI when not in dev mode
    }
  )
}

createNewExtension()

License

MIT (c) Cezar Augusto.