https://github.com/davidpeach/composer-manuscript

A tool to help streamline local PHP Composer package development
https://github.com/davidpeach/composer-manuscript

composer package php

Last synced: 18 days ago
JSON representation

A tool to help streamline local PHP Composer package development

• Host: GitHub
• URL: https://github.com/davidpeach/composer-manuscript
• Owner: davidpeach
• License: mit
• Created: 2021-05-22T21:18:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-11T10:50:55.000Z (about 1 year ago)
• Last Synced: 2024-10-09T05:51:18.289Z (28 days ago)
• Topics: composer, package, php
• Language: PHP
• Homepage:
• Size: 5.27 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# composer-manuscript

_The playgrounds functionality is currently broken but will be fixing this very soon_

Manuscript is a tool to help you with developing and testing composer packages on your computer.

## Installation

`composer global require davidpeach/composer-manuscript`

## How it works

Once installed, you just assign a local directory as being a "manuscript" directory.

So you could do this:

```bash

cd ~/my-local-packages

manuscript init

```

The `manuscript init` command just creates a `.manuscript` file in the current directory, along with two folders:

- packages

- playgrounds

**./packages** is where you place any packages that you are building.

**./playgrounds** is where any known frameworks can be installed for you and have your package in development installed into.

So for example, you could be developing a laravel package and want a local laravel installation to manually test things in.

With the `manuscript play` command, you can tell Manuscript to download a copy of Laravel and use the repository symlink functionality to install your package into that Laravel installation for testing.

## How to contribute

### Setting up

    1. Clone this repo.

    2. Run `composer install`.

    3. Run `composer test` to check the test suite passes on your machine.

### Local Scratchpad

### Thank You for looking.