JSPM

create-mkstack

0.2.1
    • ESM via JSPM
    • ES Module Entrypoint
    • Export Map
    • Keywords
    • License
    • Repository URL
    • TypeScript Types
    • README
    • Created
    • Published
    • Downloads 12
    • Score
      100M100P100Q40733F
    • License MIT

    Create a new project based on the mkstack template

    Package Exports

    • create-mkstack
    • create-mkstack/index.js

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (create-mkstack) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    create-mkstack

    A simple utility to create a new project based on the mkstack template.

    Usage

    You can run it directly with npx:

    # Interactive mode (prompts for directory name)
    npm create mkstack
    # or
    npx create-mkstack
    
    # Non-interactive mode (specify directory name as an argument)
    npm create mkstack my-project
    # or
    npx create-mkstack my-project
    
    # Non-interactive mode with automatic overwrite
    npm create mkstack my-project -y
    # or
    npx create-mkstack my-project --yes

    What it does

    This utility:

    1. Downloads and extracts the mkstack template (from https://gitlab.com/soapbox-pub/mkstack/-/archive/main/mkstack.tar) without requiring git to be installed
    2. Initializes a new git repository inside the project (if git is available)
    3. Creates an initial commit with all the template files (if git is available)

    Options

    You can use the following options:

    1. Directory Name - Provide the project directory as a command line argument:

      npx create-mkstack my-project
    2. -y or --yes Flag - Skip confirmation when overwriting an existing directory:

      # Skip confirmation for directory overwrite
      npx create-mkstack my-project -y
      # or
      npx create-mkstack my-project --yes

    If no directory argument is provided, you'll be prompted for:

    • Project directory name: The name of the directory where the project will be created

    Requirements

    Node.js 14.0.0 or newer

    Git is optional - the utility will initialize a git repository if git is available on your system, but will work without it.

    License

    MIT