JBZoo Markdown

https://github.com/jbzoo/markdown
Admin
JBZoo Markdown is a PHP library providing a simple and fluent API to programmatically generate...
Tokens:1,381
Snippets:13
Trust Score:7.5
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install/Update Dependencies via Composer

Source: https://github.com/jbzoo/markdown/blob/master/CLAUDE.md

Installs or updates all project dependencies using Composer. This command ensures that all necessary libraries and packages are correctly set up for development.

```bash
make update
```

--------------------------------

### Install JBZoo Markdown via Composer

Source: https://github.com/jbzoo/markdown/blob/master/README.md

This command installs the JBZoo Markdown library using Composer, the dependency manager for PHP. It ensures all necessary packages and their dependencies are downloaded and set up for your project.

```sh
composer require jbzoo/markdown
```

--------------------------------

### Run PHPUnit Tests and Code Quality Checks with Make

Source: https://github.com/jbzoo/markdown/blob/master/README.md

This snippet shows how to execute tests and perform code quality checks using make commands. It includes commands for running PHPUnit tests, all tests including code quality, and specific code style checks.

```shell
make test           # Run PHPUnit tests
make test-all       # Run all tests and code quality checks
make codestyle      # Run linters and code style checks
```

--------------------------------

### Run Static Analysis with Psalm

Source: https://github.com/jbzoo/markdown/blob/master/CLAUDE.md

Utilizes Psalm for static analysis, providing advanced type checking and error detection. This complements PHPStan by offering another layer of code verification.

```bash
make test-psalm
```

--------------------------------

### PHP Table Generation with JBZoo Markdown

Source: https://github.com/jbzoo/markdown/blob/master/README.md

Demonstrates how to create and render a markdown table using the JBZoo Markdown library. It shows how to add an auto-index column, set headers and alignments, and append rows of data. The output is a formatted markdown table string.

```php
<?php declare(strict_types=1);

use JBZoo\Markdown\Table;

echo (new Table())
    ->addAutoIndex('Index', 999)
    ->setHeaders(['Header #1', 'Header #2'])
    ->setAlignments([Table::ALIGN_CENTER, Table::ALIGN_RIGHT])
    ->appendRow(['123', '456'])
    ->appendRows([
        ['789_1', '9871'],
        ['789_2', '']
    ])
    ->render();
```

--------------------------------

### Run All Tests and Code Quality Checks

Source: https://github.com/jbzoo/markdown/blob/master/CLAUDE.md

Performs a comprehensive check including all unit tests and code quality assessments. This command is part of the CI/CD pipeline to ensure code health.

```bash
make test-all
```

--------------------------------

### Run PHPUnit Tests

Source: https://github.com/jbzoo/markdown/blob/master/CLAUDE.md

Executes the project's PHPUnit tests to verify the functionality of the Markdown and Table classes. This is crucial for ensuring code correctness and identifying regressions.

```bash
make test
```

--------------------------------

### PHP Advanced Table Features with JBZoo Markdown

Source: https://github.com/jbzoo/markdown/blob/master/README.md

Showcases various advanced features of the JBZooMarkdownTable class. This includes creating basic tables, tables with custom alignments for columns, and tables with an automatically generated index column, demonstrating the library's flexibility in table formatting.

```php
<?php declare(strict_types=1);

use JBZoo\Markdown\Table;

// Basic table
$table = new Table();
$table->setHeaders(['Name', 'Age', 'City'])
      ->appendRow(['John', '25', 'New York'])
      ->appendRow(['Jane', '30', 'London']);

echo $table->render();

// Table with alignments
$table = new Table();
$table->setHeaders(['Left', 'Center', 'Right'])
      ->setAlignments([Table::ALIGN_LEFT, Table::ALIGN_CENTER, Table::ALIGN_RIGHT])
      ->appendRow(['Text', 'Text', 'Text']);

echo $table->render();

// Table with auto-indexing
$table = new Table();
$table->addAutoIndex('#', 1)
      ->setHeaders(['Item', 'Price'])
      ->appendRows([
          ['Apple', '$1.00'],
          ['Banana', '$0.50'],
          ['Orange', '$0.75']
      ]);

echo $table->render();
```

--------------------------------

### Run Static Analysis with PHPStan

Source: https://github.com/jbzoo/markdown/blob/master/CLAUDE.md

Performs static analysis using PHPStan to detect potential errors and bugs in the code without executing it. This helps catch issues early in the development cycle.

```bash
make test-phpstan
```

--------------------------------

### PHP Markdown Elements Generation with JBZoo Markdown

Source: https://github.com/jbzoo/markdown/blob/master/README.md

Illustrates the use of the static methods in the JBZooMarkdownMarkdown class to generate various markdown elements. This includes titles, URLs, badges, images, blockquotes, spoilers, and code blocks, each with its corresponding markdown output.

```php
<?php declare(strict_types=1);

use JBZoo\Markdown\Markdown;

// Page Navigation
echo Markdown::title('Page Name', 1);    // # Page Name\n
echo Markdown::title('Title', 2);        // ## Title\n
echo Markdown::title('Sub Title', 3);    // ### Sub Title\n
// Links
echo Markdown::url('Google', 'https://google.com');
// Output: [Google](https://google.com)

// Badges
echo Markdown::badge('Status', 'https://travis-ci.org/badge.svg', 'https://travis-ci.org/');
// Output: [![Status](https://travis-ci.org/badge.svg)](https://travis-ci.org/)

// Images
echo Markdown::image('https://example.com/logo.jpg', 'Logo');
// Output: ![Logo](https://example.com/logo.jpg)

// Blockquotes
echo Markdown::blockquote(['Quote Line 1', 'Quote Line 2', 'Quote Line 3']);
// Output:
// > Quote Line 1
// > Quote Line 2
// > Quote Line 3

// Spoiler (collapsible content)
echo Markdown::spoiler('Click to expand', 'Hidden content here');
// Output:
// <details>
//   <summary>Click to expand</summary>
//
//   Hidden content here
//
// </details>

// Code blocks
echo Markdown::code("<?php\necho 'Hello World';\n", 'php');
// Output:
// ```php
// <?php
// echo 'Hello World';
// 
// ```
```

--------------------------------

### Run PHP CodeSniffer (PSR-12)

Source: https://github.com/jbzoo/markdown/blob/master/CLAUDE.md

Specifically runs PHP CodeSniffer to check code style compliance with the PSR-12 standard. This is a subset of the broader `codestyle` check.

```bash
make test-phpcs
```

--------------------------------

### Run Code Style Checks

Source: https://github.com/jbzoo/markdown/blob/master/CLAUDE.md

Executes all linters and code style checkers to ensure adherence to project coding standards, such as PSR-12. This command helps maintain code consistency and readability.

```bash
make codestyle
```
Tokens:
Raw