Giter VIP home page Giter VIP logo

configstruct's Introduction

Gave up maintenance (不羈放縱愛自由)

Use https://github.com/sylvrs/libMarshal instead.

ConfigStruct

Type and shape system for arrays. Help write clearer code when implementing configs for your PocketMine-MP plugin or composer project.

It also generates more human-readable errors when something is wrong with the data. Encouraging and guiding the user (especially some PocketMine-MP server owners) to read the error and fix their mess.

https://github.com/Sandertv/Marshal is an alternative that supports lower versions of PHP. However, it is not as bloat feature-rich as this library.

The section that everyone is looking for

Installation

Via Composer:

composer require endermanbugzjfc/configstruct

Via PocketMine-MP virion infection: https://poggit.pmmp.io/v.dl/Endermanbugzjfc/ConfigStruct/ConfigStruct/%5E2.0.0

Preview

Parse errors

2 errors in /Users/Shoghi/Documents/shog chips.yml
    1 errors in element "a"
        1 errors in index "0"
            1 errors in element "c"
                Element is array while it should be string
    1 errors in element "b"
        Element is null while it should be bool

Notice there is a trailing line break.

Developer guide

Parsing data

use Endermanbugzjfc\ConfigStruct\Parse;
$context = Parse::object($object, $data);
$context->copyToObject($object, $dataFilePath);

$dataFilePath will be displayed in error messages if there is any.

The errors will be wrapped and thrown with a ParseErrorsWrapper when calling copyToObject(). Although it is recommended to catch it, you can yet ignore it. Because the errors can still be displayed well in a PHP uncaught error message.

You may use Parse::objectByReflection() if you don't have an object but instead, its ReflectionClass instance. And use $context->copyToNewObject() to copy the parsed data to a new object.

Customising error message

Changing the root header label

/Users/Shoghi/Documents/shog chips.yml is the root header label in the following errors tree:

2 errors in /Users/Shoghi/Documents/shog chips.yml
    1 errors in element "a"
        1 errors in index "0"
            1 errors in element "c"
                Element is array while it should be string
    1 errors in element "b"
        Element is null while it should be bool

You can change it in the first argument of ParseErrorsWrapper::regenerateErrorMessage():

$parseErrorsWrapper->regenerateErrorMessage('C:\Windows\System32\ntoskrnl.exe');

Changing the indentation

You can change it in the second argument of ParseErrorsWrapper::regenerateErrorMessage()

Filtering errors

You can hide certain errors from the errors tree by filtering them out. Apply an error filter with the third argument of ParseErrorsWrapper::regenerateErrorMessage():

$parseErrorsWrapper->regenerateErrorMessage(
    $parseErrorsWrapper->getRootHeaderLabel(),
    $parseErrorsWrapper->getIndentation(),
    fn (array $keys, BaseParseError $parseError) : bool => !$parseError instanceof TypeMismatchError
);

This filters out all the TypeMismatchError. Although $parseError->getErrorsTree() will still have them, they will not be shown in the error message.

Print the updated error message

Simply throw the parse errors wrapper again. Or you may choose to echo $parseErrorsWrapper->getMessage(). By default, the error message has a trailing line break (\n). You can get an error message without the trailing line break (and other whitespaces) by calling $parseErrorsWrapper->getMessageRtrim() instead.

configstruct's People

Contributors

endermanbugzjfc avatar poggit-bot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

configstruct's Issues

PHPStan unfriendly

The current API is so PHPStan unfriendly—especially the errors tree, since it is recursive, which cannot be expressed in PHPStan-type.

I want to solve this by making each recursion level an object.
Generic-type will also be used.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.