XML Documentation xsd and samples how it could look like #2

edorian · 2011-11-09T13:07:50Z

Continuing the discussion I had with @gsherwood in #1

I needed recreate the PR because github refused to update the range.

…inst / work with to easy the writing of the xml

gsherwood · 2011-11-11T00:37:57Z

CodeSniffer/Standards/Generic/Sniffs/Files/LineLengthSniff.php

@@ -14,11 +14,10 @@
 */

 /**
- * Generic_Sniffs_Files_LineLengthSniff.
+ * Checks all lines in the file and warnings and errors they are to long


This should be: Checks all lines in the file and shows warnings or errors if they are too long

gsherwood · 2011-11-11T00:43:13Z

Besides the above text changes, I really like where this is going. If we can agree on the wording, we're good to go. Although I still need to write some code to substitue those keywords with their correct values based on the standard the user selected.

…zlabs/PHP_CodeSniffer/pull/1/files

edorian · 2011-11-11T08:37:59Z

I'm sorry about the bad wordings. I didn't proofread this even so i really should have :)

If you want to note the ability to change those values on every sniff that has changeable configuration I'm fine with that.

I'm aware of the abilty to change the values in the ruleset file.. i didn't think about extending the sniff classes to be honest as the xml file is all I ever used :)

Let me know if you find other issues or pull and I'll get started on writing something for every sniff in generic

gsherwood · 2011-11-21T23:03:08Z

CodeSniffer/Standards/Generic/Docs/Files/LineLengthStandard.xml

    <standard>
    <![CDATA[
-    It is recommended to keep lines at approximately 80 characters long for better code readability.
+    It is recommended to keep lines at approximately {lineLimit} characters long for better code readability and lines should never exceed {absoluteLineLimit} characters.


Thinking more about it, this isn't gong to work. If you have disabled your absoluteLineLimit (set it to zero) then the message will show:
"It is recommended to keep lines at approximately 80 characters long for better code readability and lines should never exceed 0 characters."

We obviously need to devise a smarter system that allows documentation to be generated based on the values that the project-specific standard is setting.

gsherwood · 2011-11-21T23:08:24Z

I think this is more complex than a pull request is going to achieve. I think we need to start again on this and plan it out properly. It requires changes to the existing documentation generator code as well as changes to the documentation itself.

I also wont be pulling this in if it stops existing documentation from being generated, which it obviously will due to the need to make core changes that have not yet been done.

If you'd like to start creating examples and basic documentation for the existing sniffs using the existing XML format, I'd be very happy to accept those contributions. But I'll need to have a bit more of a think about how best create customised standard documentation.

edorian · 2011-11-21T23:37:17Z

Anyways, thanks for getting back to me on this :)

Relax class name req's; we're not yet namespacing

…h and open files in that during interactive session

… builds

…is incorrectly quoted

…h and open files in that during interactive session

… builds

…h and open files in that during interactive session

[WIP] Fix tests

The `Fixer::generateDiff()` method calls the `shell_exec()` method to retrieve the `diff` between two files. In the unit tests, this is used to compare the expected content in a `.fixed` file with the generate fixed file contents. If the expected content matches the generated content, the diff command will produce no output and `shell_exec()` will return `null`. Ref: https://www.php.net/manual/en/function.shell-exec.php This result is subsequently passed to `explode()` as the second parameter, but `explode()` only excepts strings as the second parameter. Ref: https://www.php.net/manual/en/function.explode As of PHP 8.1, this will generate a deprecation notice `explode(): Passing null to parameter squizlabs#2 ($string) of type string is deprecated`. Discovered while testing an external standard against PHPCS `master` on PHP 8.1. Fixed now.

The `Fixer::generateDiff()` method calls the `shell_exec()` method to retrieve the `diff` between two files. In the unit tests, this is used to compare the expected content in a `.fixed` file with the generate fixed file contents. If the expected content matches the generated content, the diff command will produce no output and `shell_exec()` will return `null`. Ref: https://www.php.net/manual/en/function.shell-exec.php This result is subsequently passed to `explode()` as the second parameter, but `explode()` only excepts strings as the second parameter. Ref: https://www.php.net/manual/en/function.explode As of PHP 8.1, this will generate a deprecation notice `explode(): Passing null to parameter #2 ($string) of type string is deprecated`. Discovered while testing an external standard against PHPCS `master` on PHP 8.1. Fixed now.

…le bug The `DummyFile::__construct()` method expects a `string` as the first parameter, subsequently passes it to the `File::setContent()` method, which also expects a `string`, which then passes it to the `Common::detectLineEndings()` method, which again expects a `string`. Within the `Common::detectLineEndings()` method, the string is then passed to the PHP native `preg_match()` function, which (again) expects as `string` for the `$subject` parameter. When using PHPCS with parallel processing turned on, on a system which allows for parallel processing, the `DummyFile` class was, however, being instantiated in the `Runner::processChildProcs()` method with `null` as the content of the first parameter, which on PHP 8.1 leads to `preg_match(): Passing null to parameter squizlabs#2 ($subject) of type string is deprecated` deprecation notices. This deprecation notice was then caught as a `RuntimeException` in the `File::setContent()` method and passed on to the `File::addWarningOnLine()`, which called the `File::addMessage()` method. The `File::addMessage()` parameter then ran into trouble as the `$this->config` property has not been set up yet, as `DummyFile::__construct()` calls `File::setContent()` before calling the `parent::__construct()` method, leading to the `Undefined array key "cache"` notices which were making the build fail. Fixed now by passing an empty string instead of `null` as the `$content` for the `DummyFile` in the `Runner::processChildProcs()` method. This then leaves one more issue: the `DummyFile::__construct()` method contains a conditional code block which was only run when `$content !== null`. As this conditional code block is also not necessary to be run when an empty string would be passed to the constructor, changing this condition to `$content !== ''` makes that the condition can still match and maintains the efficiency tweak the condition was safeguarding.

…le bug The `DummyFile::__construct()` method expects a `string` as the first parameter, subsequently passes it to the `File::setContent()` method, which also expects a `string`, which then passes it to the `Common::detectLineEndings()` method, which again expects a `string`. Within the `Common::detectLineEndings()` method, the string is then passed to the PHP native `preg_match()` function, which (again) expects as `string` for the `$subject` parameter. When using PHPCS with parallel processing turned on, on a system which allows for parallel processing, the `DummyFile` class was, however, being instantiated in the `Runner::processChildProcs()` method with `null` as the content of the first parameter, which on PHP 8.1 leads to `preg_match(): Passing null to parameter #2 ($subject) of type string is deprecated` deprecation notices. This deprecation notice was then caught as a `RuntimeException` in the `File::setContent()` method and passed on to the `File::addWarningOnLine()`, which called the `File::addMessage()` method. The `File::addMessage()` parameter then ran into trouble as the `$this->config` property has not been set up yet, as `DummyFile::__construct()` calls `File::setContent()` before calling the `parent::__construct()` method, leading to the `Undefined array key "cache"` notices which were making the build fail. Fixed now by passing an empty string instead of `null` as the `$content` for the `DummyFile` in the `Runner::processChildProcs()` method. This then leaves one more issue: the `DummyFile::__construct()` method contains a conditional code block which was only run when `$content !== null`. As this conditional code block is also not necessary to be run when an empty string would be passed to the constructor, changing this condition to `$content !== ''` makes that the condition can still match and maintains the efficiency tweak the condition was safeguarding.

in some analysis, I was receiving this error "Uncaught TypeError: vsprintf(): Argument squizlabs#2 ($values) must be of type array, string given" on line 1056

edorian added 2 commits November 8, 2011 14:23

Minor additions to the sniff XML documentation and a xsd to check aga…

4f55a01

…inst / work with to easy the writing of the xml

Adapting the wording after some discussion on https://github.com/squi…

0911742

…zlabs/PHP_CodeSniffer/pull/1/files

gsherwood reviewed Nov 11, 2011
View reviewed changes

Adapting the wording after some discussion on https://github.com/squi…

eff40f0

…zlabs/PHP_CodeSniffer/pull/1/files

gsherwood reviewed Nov 21, 2011
View reviewed changes

edorian closed this Nov 21, 2011

gsherwood mentioned this pull request Apr 30, 2012

[FEATURE] Add support to import namespaces for sniffs #25

Closed

rhowardiv referenced this pull request in rhowardiv/PHP_CodeSniffer Jan 2, 2013

Merge pull request SnapInteractive#2 from rhowardiv/topsr2

65bd863

Relax class name req's; we're not yet namespacing

MarcelloPerathoner mentioned this pull request Oct 18, 2015

No silencing possible if your custom standard directory name contains underscores #745

Closed

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016

[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor pat…

f97d5dc

…h and open files in that during interactive session

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016

\[PMakowski] squizlabs#2.5.1.x-dev: matching PHPCS coding standards

a622b86

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016

[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor pat…

a47248b

…h and open files in that during interactive session

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016

\[PMakowski] squizlabs#2.5.1.x-dev: matching PHPCS coding standards

0a1f241

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016

[PMakowski] squizlabs#2.5.1.x-dev: fix after rebase

a8a9835

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016

[PMakowski] squizlabs#2.5.1.x-dev: fix T_PAAMAYIM_NEKUDOTAYIM in some…

65f3e04

… builds

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016

[PMakowski] squizlabs#2.5.1.x-dev: again matching PHPCS coding standard

7394ee4

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 17, 2016

[PMakowski] squizlabs#2.5.1.x-dev: fix unfinite loop if CLI argument …

3651599

…is incorrectly quoted

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 18, 2016

[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor pat…

169a4f9

…h and open files in that during interactive session

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 18, 2016

\[PMakowski] squizlabs#2.5.1.x-dev: matching PHPCS coding standards

109f51f

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 18, 2016

[PMakowski] squizlabs#2.5.1.x-dev: fix after rebase

f521d7f

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 18, 2016

[PMakowski] squizlabs#2.5.1.x-dev: fix T_PAAMAYIM_NEKUDOTAYIM in some…

c58ea75

… builds

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 18, 2016

[PMakowski] squizlabs#2.5.1.x-dev: again matching PHPCS coding standard

42b9447

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: update

21cf1b6

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor pat…

e7dd3db

…h and open files in that during interactive session

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: update

3b3ac15

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor pat…

1e78c77

…h and open files in that during interactive session

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: update

1679393

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor pat…

e18eaf4

…h and open files in that during interactive session

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: update

5010990

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor pat…

55e6d12

…h and open files in that during interactive session

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: update

2e707c4

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor pat…

fa772af

…h and open files in that during interactive session

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: update

249637a

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor pat…

87fb336

…h and open files in that during interactive session

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: update

3a58179

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor pat…

0d7ebad

…h and open files in that during interactive session

Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 8, 2018

[PMakowski] squizlabs#2.5.1.x-dev: update

8092ead

gsherwood pushed a commit that referenced this pull request Aug 15, 2018

Merge pull request #2 from josephzidell/patch-3

158fe98

[WIP] Fix tests

pokemonhan mentioned this pull request Dec 5, 2019

Generic.PHP.DeprecatedFunctions return PHP Fatal error: Uncaught ReflectionException #2742

Closed

ksn135 mentioned this pull request Dec 14, 2019

Fatal error: Uncaught PHP_CodeSniffer\Exceptions\RuntimeException: Undefined offset: -1 #2766

Closed

gz-ang mentioned this pull request Jul 17, 2020

Class 'PHP_CodeSniffer\Tests\FileList' not found #3021

Closed

jackjpdiscos mentioned this pull request Nov 17, 2020

Error message when running PHPCBF #3166

Closed

esprange mentioned this pull request Mar 8, 2022

vsprintf error in files.php #3555

Closed

kirilcvetkov mentioned this pull request Aug 10, 2022

Fatal error when a method has "@param $code" in DocBlock for Doctrine phpcs standard #3646

Closed

Kleinast mentioned this pull request Sep 26, 2022

Parallel running with multiple file directives leads to "passing null to non-nullable" notice on PHP 8.1 #3677

Open

juanpgarciac mentioned this pull request Jan 8, 2023

$data variable should be array #3741

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

XML Documentation xsd and samples how it could look like #2

XML Documentation xsd and samples how it could look like #2

edorian commented Nov 9, 2011

gsherwood Nov 11, 2011

gsherwood commented Nov 11, 2011

edorian commented Nov 11, 2011

gsherwood Nov 21, 2011

gsherwood commented Nov 21, 2011

edorian commented Nov 21, 2011

XML Documentation xsd and samples how it could look like #2

XML Documentation xsd and samples how it could look like #2

Conversation

edorian commented Nov 9, 2011

gsherwood Nov 11, 2011

Choose a reason for hiding this comment

gsherwood commented Nov 11, 2011

edorian commented Nov 11, 2011

gsherwood Nov 21, 2011

Choose a reason for hiding this comment

gsherwood commented Nov 21, 2011

edorian commented Nov 21, 2011