tlint

tlint copied to clipboard

Install (Requires PHP 7.3+)

composer global require tightenco/tlint

Upgrade

composer global update tightenco/tlint

What Is It?

This is an opinionated code linter (with growing support for auto-formatting!) for Tighten flavored code conventions for Laravel and PHP.

For example, Laravel has many available ways to pass variables from a controller to a view:

A)

$value = 'Hello, World!';

return view('view', compact('value'));

B)

return view('view', ['value' => 'Hello, World!']);

C)

return view('view')
    ->with('value', 'Hello, World!');

In this case TLint will warn if you are not using the B) method. This example is a sort of "meta layer" of code linting, allowing teams to avoid higher level sticking points of code review / discussions.

TLint also has more immediately useful lints that can supplement your editor/IDE such as:

• NoUnusedImports
• TrailingCommasOnArrays
• And many more! (See below for full listing)

Usage

For entire project (you must pass the lint command to use other options)

tlint

For individual files and specific directories

tlint lint index.php
tlint lint app

You can also lint only diff files by running the following with unstaged git changes

tlint lint --diff
tlint lint src --diff

Want the output from a file as JSON? (Primarily used for integration with editor plugins)

tlint lint test.php --json

Want to only run a single linter?

tlint lint --only=UseConfigOverEnv

Example Output

Linting TestLaravelApp/routes/web.php
============
Lints:
============
! Prefer `view(...)->with(...)` over `view(..., [...])`.
5 : `    return view('test', ['test' => 'test']);``

Formatting (Beta)

Using the same conventions as above, but using the format command, you can auto-fix some lints:

tlint format

Linting Configuration

TLint Ships with 2 "preset" styles: Laravel & Tighten. The Laravel preset is intended to match the conventions agreed upon by the Laravel framework contributors, while the Tighten preset is intended to match those agreed upon by Tighten team members.

The default configuration is "tighten" flavored, but you may change this by adding a tlint.json file to your project's root directory with the following schema:

You may further customize the linters used by adding specific lint names to the "disabled" list. You may disable linting for specific directories by adding them to the "excluded" list. You may provide custom paths by adding them to the "paths" lists.

{
    "preset": "laravel",
    "disabled": ["NoInlineVarDocs"],
    "excluded": ["tests/"],
    "paths": [
        {
            "controllers": ["app/Domain/Http/Controllers"]
        }
    ]
}

Custom Configuration & Presets

You can also add your own custom preset and linters by providing a fully-qualified class name as the preset. For example, if you created a custom preset class:

namespace App\Support\Linting;

/** use ... */

class Preset implements PresetInterface
{
  public function getLinters() : array
  {
    return [
      PrefixTestsWithTest::class,
      ModelMethodOrder::class,
    ];
  }

  public function getFormatters() : array
  {
    return [];
  }
}

Then your config could look like:

{
    "preset": "App\\Support\\Linting\\Preset"
}

This lets you define whatever custom linting functionality, or modify the existing linters to your liking.

Formatting Configuration (Beta)

Similar to linting there are two "preset" styles for formatting: Laravel & Tighten.

The default configuration is "tighten", but you may change this by adding a tformat.json file to your project's root directory with the following schema:

{
    "preset": "laravel"
}

Editor Integrations

PHPStorm

Sublime

VSCode

Available Linters

General PHP

• AlphabeticalImports
• ClassThingsOrder
• ConcatenationSpacing
• NewLineAtEndOfFile
• NoInlineVarDocs
• NoParensEmptyInstantiations
• NoStringInterpolationWithoutBraces
• NoUnusedImports
• OneLineBetweenClassVisibilityChanges
• QualifiedNamesOnlyForClassName
• RemoveLeadingSlashNamespaces
• SpaceAfterSoleNotOperator
• TrailingCommasOnArrays

PHPUnit

• NoMethodVisibilityInTests

Laravel

• ApplyMiddlewareInRoutes
• ArrayParametersOverViewWith
• FullyQualifiedFacades
• ImportFacades
• MailableMethodsInBuild
• NoLeadingSlashesOnRoutePaths
• ModelMethodOrder
• NoDocBlocksForMigrationUpDown
• NoDump
• NoJsonDirective
• NoSpaceAfterBladeDirectives, SpaceAfterBladeDirectives
• PureRestControllers
• RequestHelperFunctionWherePossible
• RequestValidation
• RestControllersMethodOrder
• SpacesAroundBladeRenderContent
• UseAnonymousMigrations
• UseAuthHelperOverFacade
• UseConfigOverEnv
• ViewWithOverArrayParameters

Available Formatters (Beta)

Notes about formatting

• Formatting is designed to alter the least amount of code possible.
• Import related formatters are not designed to alter grouped imports.

General PHP

• AlphabeticalImports
• ExcessSpaceBetweenAndAfterImports
• NewLineAtEndOfFile
• UnusedImports

Laravel

• FullyQualifiedFacades
• NoDatesPropertyOnModels
• NoDocBlocksForMigrationUpDown
• UseAnonymousMigrations

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Logan Henson
• Jacob Baker-Kretzmar
• All Contributors

License

The MIT License (MIT). Please see License File for more information.