将PHP接口导出到Typescript接口,反之亦然？

您可以使用惊人的 nikic/PHP-Parser来创建一个工具,用于将选定的PHP类(在phpDoc中具有@TypeScriptMe字符串的类)转换为非常容易的TypeScript接口.下面的脚本非常简单,但我认为你可以扩展它,你可以自动生成TypeScript接口,并可能通过git跟踪更改.

例

对于此输入：

<?php
/**
 * @TypeScriptMe
 */
class Person
{
    /**
     * @var string
     */
    public $name;

    /**
     * @var int
     */
    public $age;

    /**
     * @var stdClass
     */
    public $mixed;

    /**
     * @var string
     */
    private $propertyIsPrivateItWontShow;
}

class IgnoreMe {

    public function test() {

    }
}

你会得到：

interface Person {
  name: string,age: number,mixed: any
}

源代码

index.php文件：

<?php

namespace TypeScript {

    class Property_
    {
        /** @var string */
        public $name;
        /** @var string */
        public $type;

        public function __construct($name,$type = "any")
        {
            $this->name = $name;
            $this->type = $type;
        }

        public function __toString()
        {
            return "{$this->name}: {$this->type}";
        }
    }

    class Interface_
    {
        /** @var string */
        public $name;
        /** @var Property_[] */
        public $properties = [];

        public function __construct($name)
        {
            $this->name = $name;
        }

        public function __toString()
        {
            $result = "interface {$this->name} {n";
            $result .= implode(",n",array_map(function ($p) { return "  " . (string)$p;},$this->properties));
            $result .= "n}";
            return $result;
        }
    }
}

namespace MyParser {

    ini_set('display_errors',1);
    require __DIR__ . "/vendor/autoload.php";

    use PhpParser;
    use PhpParserNode;
    use TypeScript;

    class Visitor extends PhpParserNodeVisitorAbstract
    {
        private $isActive = false;

        /** @var TypeScript/Interface_[] */
        private $output = [];

        /** @var TypeScriptInterface_ */
        private $currentInterface;

        public function enterNode(Node $node)
        {
            if ($node instanceof PhpParserNodeStmtClass_) {

                /** @var PhpParserNodeStmtClass_ $class */
                $class = $node;
                // If there is "@TypeScriptMe" in the class phpDoc,then ...
                if ($class->getDocComment() && strpos($class->getDocComment()->getText(),"@TypeScriptMe") !== false) {
                    $this->isActive = true;
                    $this->output[] = $this->currentInterface = new TypeScriptInterface_($class->name);
                }
            }

            if ($this->isActive) {
                if ($node instanceof PhpParserNodeStmtProperty) {
                    /** @var PhpParserNodeStmtProperty $property */
                    $property = $node;

                    if ($property->isPublic()) {
                        $type = $this->parsePhpDocForProperty($property->getDocComment());
                        $this->currentInterface->properties[] = new TypeScriptProperty_($property->props[0]->name,$type);
                    }
                }
            }
        }

        public function leaveNode(Node $node)
        {
            if ($node instanceof PhpParserNodeStmtClass_) {
                $this->isActive = false;
            }
        }

        /**
         * @param PhpParserComment|null $phpDoc
         */
        private function parsePhpDocForProperty($phpDoc)
        {
            $result = "any";

            if ($phpDoc !== null) {
                if (preg_match('/@var[ t]+([a-z0-9]+)/i',$phpDoc->getText(),$matches)) {
                    $t = trim(strtolower($matches[1]));

                    if ($t === "int") {
                        $result = "number";
                    }
                    elseif ($t === "string") {
                        $result = "string";
                    }
                }
            }

            return $result;
        }

        public function getOutput()
        {
            return implode("nn",array_map(function ($i) { return (string)$i;},$this->output));
        }
    }

    ### Start of the main part


    $parser = new PhpParserParser(new PhpParserLexerEmulative);
    $traverser = new PhpParserNodeTraverser;
    $visitor = new Visitor;
    $traverser->addVisitor($visitor);

    try {
        // @todo Get files from a folder recursively
        //$code = file_get_contents($fileName);

        $code = <<<'EOD'
<?php
/**
 * @TypeScriptMe
 */
class Person
{
    /**
     * @var string
     */
    public $name;

    /**
     * @var int
     */
    public $age;

    /**
     * @var stdClass
     */
    public $mixed;

    /**
     * @var string
     */
    private $propertyIsPrivateItWontShow;
}

class IgnoreMe {

    public function test() {

    }
}

EOD;

        // parse
        $stmts = $parser->parse($code);

        // traverse
        $stmts = $traverser->traverse($stmts);

        echo "<pre><code>" . $visitor->getOutput() . "</code></pre>";

    } catch (PhpParserError $e) {
        echo 'Parse Error: ',$e->getMessage();
    }
}

composer.json

{
    "name": "experiment/experiment","description": "...","homepage": "http://example.com","type": "project","license": ["Unlicense"],"authors": [
        {
            "name": "MrX","homepage": "http://example.com"
        }
    ],"require": {
        "php": ">= 5.4.0","nikic/php-parser": "^1.4"
    },"minimum-stability": "stable"
}