Skip to content

Commit cd43dd2

Browse files
committed
Add very basic docs
1 parent 40425d1 commit cd43dd2

File tree

7 files changed

+43
-2
lines changed

7 files changed

+43
-2
lines changed

IxDFCodingStandard/Sniffs/NamingConventions/CamelCaseRouteNameSniff.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ public function process(File $phpcsFile, $stackPtr): void
3131
}
3232

3333
/**
34-
* Finds the route name and tests it against the camel case pattern. If an issue is found,
35-
* it adds an error.
34+
* Finds the route name and tests it against the camel case pattern.
35+
* If an issue is found, it adds an error.
3636
* @param array<string, int, array<string>> $tokens
3737
**/
3838
public function processRouteName(File $phpcsFile, int $stackPtr, array $tokens): void

docs/README.md

Whitespace-only changes.

docs/classes.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Classes
2+
3+
### IxDFCodingStandard.Classes.ForbidDirectClassInheritance
4+
Forbid a given list classes from using inherited directly.
5+
6+
### IxDFCodingStandard.Classes.ForbidMethodDeclaration
7+
Forbid declaration of given methods. Example:
8+
```xml
9+
<rule ref="IxDFCodingStandard.Classes.ForbidMethodDeclaration">
10+
<properties>
11+
<property name="forbiddenMethods" type="array">
12+
<element key="\App\Notifications\Notification::shouldSend" value="\App\Notifications\Support\ShouldCheckConditionsBeforeSendingOut::shouldBeSent"/>
13+
</property>
14+
</properties>
15+
</rule>
16+
```

docs/files.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Files
2+
3+
### IxDFCodingStandard.Files.BemCasedFilename
4+
Ensure blade file named using [BEM notation](https://getbem.com/introduction/).

docs/functions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Functions
2+
3+
### IxDFCodingStandard.Functions.ForbiddenFunctions
4+
Forbid using of configured functions and propose alternatives.

docs/laravel.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Laravel
2+
3+
### IxDFCodingStandard.Laravel.DisallowGuardedAttribute
4+
Do not allow using [Mass Assignment](https://laravel.com/docs/master/eloquent#mass-assignment).
5+
6+
### IxDFCodingStandard.Laravel.NonExistingBladeTemplate
7+
Check whether blade view exist.
8+
9+
### IxDFCodingStandard.Laravel.RequireCustomAbortMessage
10+
Force using custom exception messages when use `abort`, `abort_if` and `abort_unless`.

docs/naming-conventions.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Naming conventions
2+
3+
### IxDFCodingStandard.NamingConventions.CamelCaseRouteName
4+
Ensure Laravel’s route name is not camel cased.
5+
6+
### IxDFCodingStandard.NamingConventions.MeaningfulVariableName
7+
Forbid using uninformative variable names.

0 commit comments

Comments
 (0)