Browse Source

Subject Robo file to coding standards

J. King 11 months ago
parent
commit
392376a1ef
2 changed files with 26 additions and 25 deletions
  1. 1
    0
      .php_cs.dist
  2. 25
    25
      RoboFile.php

+ 1
- 0
.php_cs.dist View File

@@ -10,6 +10,7 @@ const BASE = __DIR__.DIRECTORY_SEPARATOR;
10 10
 $paths = [
11 11
     __FILE__,
12 12
     BASE."arsse.php",
13
+    BASE."RoboFile.php",
13 14
     BASE."lib",
14 15
     BASE."tests",
15 16
 ];

+ 25
- 25
RoboFile.php View File

@@ -11,15 +11,15 @@ class RoboFile extends \Robo\Tasks {
11 11
     const BASE = __DIR__.\DIRECTORY_SEPARATOR;
12 12
     const BASE_TEST = self::BASE."tests".\DIRECTORY_SEPARATOR;
13 13
 
14
-    /** 
15
-     * Runs the full test suite 
16
-     * 
17
-     * Arguments passed to the task are passed on to PHPUnit. Thus one may, for 
14
+    /**
15
+     * Runs the full test suite
16
+     *
17
+     * Arguments passed to the task are passed on to PHPUnit. Thus one may, for
18 18
      * example, run the following command and get the expected results:
19
-     * 
20
-     * ./robo test --testsuite TTRSS --exclude-group slow --testdox 
21
-     * 
22
-     * Please see the PHPUnit documentation for available options. 
19
+     *
20
+     * ./robo test --testsuite TTRSS --exclude-group slow --testdox
21
+     *
22
+     * Please see the PHPUnit documentation for available options.
23 23
     */
24 24
     public function test(array $args): Result {
25 25
         // start the built-in PHP server, which is required for some of the tests
@@ -30,32 +30,32 @@ class RoboFile extends \Robo\Tasks {
30 30
         return $this->taskExec("php")->arg($execpath)->option("-c", $confpath)->args($args)->run();
31 31
     }
32 32
 
33
-    /** 
34
-     * Runs the full test suite 
35
-     * 
36
-     * This is an alias of the "test" task. 
33
+    /**
34
+     * Runs the full test suite
35
+     *
36
+     * This is an alias of the "test" task.
37 37
     */
38 38
     public function testFull(array $args): Result {
39 39
         return $this->test($args);
40 40
     }
41 41
 
42
-    /** 
43
-     * Runs a quick subset of the test suite 
44
-     * 
45
-     * See help for the "test" task for more details. 
42
+    /**
43
+     * Runs a quick subset of the test suite
44
+     *
45
+     * See help for the "test" task for more details.
46 46
     */
47 47
     public function testQuick(array $args): Result {
48 48
         return $this->test(array_merge(["--exclude-group","slow"], $args));
49 49
     }
50 50
 
51
-    /** Produces a code coverage report 
52
-     * 
51
+    /** Produces a code coverage report
52
+     *
53 53
      * By default this task produces an HTML-format coverage report in
54 54
      * arsse/tests/coverage/. Additional reports may be produced by passing
55 55
      * arguments to this task as one would to PHPUnit.
56
-     * 
56
+     *
57 57
      * Robo first tries to use phpdbg and will fall back to Xdebug if available.
58
-     * Because Xdebug slows down non-coverage tasks, however, phpdbg is highly 
58
+     * Because Xdebug slows down non-coverage tasks, however, phpdbg is highly
59 59
      * recommanded is debugging facilities are not otherwise needed.
60 60
     */
61 61
     public function coverage(array $args): Result {
@@ -79,14 +79,14 @@ class RoboFile extends \Robo\Tasks {
79 79
         }
80 80
     }
81 81
 
82
-    /** Packages a given commit of the software into a release tarball 
83
-     * 
82
+    /** Packages a given commit of the software into a release tarball
83
+     *
84 84
      * The version to package may be any Git tree-ish identifier: a tag, a branch,
85 85
      * or any commit hash. If none is provided on the command line, Robo will prompt
86 86
      * for a commit to package; the default is "head".
87
-     * 
87
+     *
88 88
      * Note that while it is possible to re-package old versions, the resultant tarball
89
-     * may not be equivalent due to subsequent changes in the exclude list, or because 
89
+     * may not be equivalent due to subsequent changes in the exclude list, or because
90 90
      * of new tooling.
91 91
     */
92 92
     public function package(string $version = null): Result {
@@ -137,4 +137,4 @@ class RoboFile extends \Robo\Tasks {
137 137
         }
138 138
         return $t->run();
139 139
     }
140
-}
140
+}

Loading…
Cancel
Save