Download the PHP package schenke-io/packaging-tools without Composer

Packaging Tools

This package is a collection of tools to simplify the package and project development.

The main elements are:

• Markdown Assemble the readme.md file out of small markdown files, class comments and other sources
• Badge build the badge custom or from existing files

• Setup read the .packaging-tools.neon configuration file and modify scripts in composer.json

• Packaging Tools
  • Installation
  • Concept
  • Configuration
  • Classes
  • MarkdownAssembler
    • How to assemble a markdown
    • Public methods of MarkdownAssembler
    • [Details of addTableFromFile()](#details-of-addtablefromfile())
    • [Details of addTableFromArray()](#details-of-addtablefromarray())
  • MakeBadge
    • Public methods of MakeBadge
  • ClassData

Installation

Install the package with composer:

Add the setup command into composer.json under scripts.

Start the setup:

and check all available setup parameters:

Concept

This package follows the following concept:

• setup and configuration is controlled by a config file
• manual edits have higher priority than automatics
• when manual edita would be overwritten there is a warning
• the documentation is organised out of components which get assembled at the end
• important classes and methods are marked and documented
• badges are written from data
• the build process is controlled by script
• missing files are explained with full path

Configuration

Each package is controlled by a config file .packaging-tools.neon . NEON files can be written as YAML or JSON but additionally with comments.

The format can be easily schema verified and is used here as simple key-value-pairs.

Classes

MarkdownAssembler

Assembler of a markdown file

How to assemble a markdown

To assemble a markdown you need these things:

• a directory with well named markdown files
• documentation of classes and methods
• csv files for tables
• a script
  • which writes badges
  • which read and assemble these files

This script can be a script run by php itself or a class file with a static method.

Public methods of MarkdownAssembler

Details of addTableFromFile()

The following extensions for the file are implemented:

Details of addTableFromArray()

The array is expected to have this format:

and would be rendered like this:

MakeBadge

makes badges in various formats and from many sources

Public methods of MakeBadge

ClassData