phpcsstandards / phpcs-docs Goto Github PK

Currently, the @link matcher fails on any value that includes newlines or anything after the URL. Make it more permissive.

Using the config-repos branch and without changing anything, I tried to run the following from the root of this repository:

$ php ./bin/phpcsdocs generate

And got the following error response:

In GitCodeRepository.php line 26:

  The command "git clone "[email protected]:PHPCompatibility/PHPCompatibility.git" "var/repos/PHPCompatibility/"" failed.

  Exit Code: 128(Invalid exit argument)

  Working directory: D:\000_GitHub\PHPCS\PHPCSStandards\phpcs-docs

  Output:
  ================


  Error Output:
  ================
  Cloning into 'var/repos/PHPCompatibility'...
  Warning: Permanently added the RSA host key for IP address '140.82.121.3' to the list of known hosts.
  [email protected]: Permission denied (publickey).
  fatal: Could not read from remote repository.

  Please make sure you have the correct access rights
  and the repository exists.

Just a placeholder issue to remind us to add more extensive documentation to the readme, as well as to the command line help.

Exclude any @internal or {@internal} docblocks.

Classes should be final and we should not extend implementations. It's okay to copy an existing to make the necessary changes. We can always extract truly reusable elements and inject them as dependencies instead. The test for the new class should encompass the common elements as well, otherwise we're not truly testing them, and any unintended regressions would go unnoticed. Not a deal breaker and I'm happy to address the issue in a subsequent commit.

Originally posted by @afilina in #10 (comment)

We should convert any string paths that we pass around as Path objects, which would take care of normalizing slashes in one central location. It would significantly help readability and maintainability.

After #3, I edited the generator.xml.dist file to contain the following:

<?xml version="1.0" encoding="UTF-8"?>
<generator format="markdown">
    <source path="D:\000_GitHub\PHPCS\PHPCompatibility\PHPCompatibility">
        <standard path="PHPCompatibility" />
    </source>
</generator>

Using the config-repos branch, I then tried to run the following command again from the root of this repository:

$ php ./bin/phpcsdocs generate

And got the following error response:

Searching for sniffs in D:\000_GitHub\PHPCS\PHPCompatibility\PHPCompatibility/PHPCompatibility/...

In NotASniffPath.php line 18:

  The file path provided does not follow the convention for a sniff class.
  Must contain {Standard}/Sniffs/{Category}/{SniffName}Sniff.php
  Received: D:\000_GitHub\PHPCS\PHPCompatibility\PHPCompatibility/PHPCompatibility/Sniffs/Classes\ForbiddenExtendingFinalClassSniff.php


generate [<sniff>]

I suspect this may be due to the multiple PHPCompatibility directories in the path ?

{@internal abc {@link http://link.com}}

Either create a smarter regex to detect these cases or file an issue with phpDocumentor to enable detecting them with getTagsByName.

Originally posted by @jrfnl in #15 (comment)

• PHPCS
• Psalm
• Coverage
• Mutation testing