Merge pull request #28 from innocenzi/feat/eslint-formatter

feat: add `eslint` formatter

docs/laravel/executing-the-transform-command.md

@@ -25,7 +25,7 @@ php artisan typescript:transform --output=types.d.ts
 
 This file will be stored in the resource's path of your Laravel application.
 
-It is also possible to automatically format the generated TypeScript with prettier:
+It is also possible to automatically format the generated TypeScript with Prettier, ESLint, or a custom formatter:
 
 ```bash
 php artisan typescript:transform --format

docs/laravel/installation-and-setup.md

@@ -83,9 +83,9 @@ return [
     'writer' => Spatie\TypeScriptTransformer\Writers\TypeDefinitionWriter::class,
 
     /*
-     * The generated TypeScript file can be formatted. We ship a Prettier formatter
-     * out of the box: `PrettierFormatter` but you can also implement your own one.
-     * The generated TypeScript will not be formatted when no formatter was set.
+     * The generated TypeScript file can be formatted. We ship two formatters by
+     * default: a Prettier and an ESLint one. You can also implement your own.
+     * The generated TypeScript will not be formatted if none is configured.
      */
 
     'formatter' => null,

docs/usage/formatters.md

@@ -3,7 +3,7 @@ title: Formatters
 weight: 7
 ---
 
-This output file with all the transformed types can be formatted using tools like Prettier. We ship a Prettier formatter by default with the package, which will run Prettier after the output file is generated. you can configure it as such:
+This output file with all the transformed types can be formatted using tools like Prettier. We ship an ESLint and a Prettier formatter, which will run after the output file is generated. For instance, you can configure the Prettier formatter as such:
 
 ```php
 $config = TypeScriptTransformerConfig::create()

src/Formatters/EslintFormatter.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Spatie\TypeScriptTransformer\Formatters;
+
+use Spatie\TypeScriptTransformer\Formatters\Formatter;
+use Symfony\Component\Process\Exception\ProcessFailedException;
+use Symfony\Component\Process\Process;
+
+class EslintFormatter implements Formatter
+{
+    public function format(string $file): void
+    {
+        $process = new Process(['npx', '--yes', 'eslint', '--fix', '--no-ignore', $file]);
+        $process->run();
+
+        if (! $process->isSuccessful()) {
+            throw new ProcessFailedException($process);
+        }
+    }
+}