@waynestate/pinstripe 0.1.0 → 0.1.1

package/README.md

@@ -22,6 +22,7 @@ Checks: `composer ci` (the same command runs on GitLab and GitHub).
 Development happens on Wayne State's GitLab; this repository is a release mirror. Changes land there first.
 
 Front page: [`site/index.html`](site/index.html), a static tailor's shop you can open in a browser or serve from `site/`.
+On Citadel it is served by the raw-PHP deploy layer in [`deploy/`](deploy/): a SQUIRE kit whose front controller serves `site/` behind HELMET's security headers. For local development, keep serving `site/` directly.
 
 <div align="center">
   <img src="docs/readme/tape.svg" width="100%" alt="A yellow tape measure unrolls across a green card with seven marks, one per preset: The cut, Pint, presets per and laravel; The inseam, PHPStan, level 8; The lining, Larastan; The press, Rector, with dead code, code quality, type declarations and early return; The buttonholes, ESLint, javascript and typescript with vue and accessibility; The hem, Prettier, 100 columns, single quotes, semicolons, trailing commas; The chalk line, baseline.">
@@ -45,9 +46,11 @@ Front page: [`site/index.html`](site/index.html), a static tailor's shop you can
 Add Pinstripe as a dev dependency:
 
 ```
-composer require --dev waynestate/pinstripe
+composer require --dev waynestate/pinstripe:^0.1
 ```
 
+Pinstripe 0.1.0 is on Packagist, and the npm package, `@waynestate/pinstripe`, is at 0.1.0 too.
+
 Point PHPStan at the raw config. `phpstan.neon`:
 
 ```neon
@@ -82,7 +85,7 @@ The tailor flags the old cut before the fabric is retired.
 Same, with the Laravel parts:
 
 ```
-composer require --dev waynestate/pinstripe larastan/larastan
+composer require --dev waynestate/pinstripe:^0.1 larastan/larastan
 ```
 
 Pinstripe pulls in `phpstan/extension-installer`, which registers Larastan for you. When Composer asks, allow the
@@ -162,7 +165,24 @@ alone. Rector is the tailor's press: it smooths old code to the standard without
 
 ## The strict cut
 
-New apps can include `vendor/waynestate/pinstripe/phpstan/strict.neon` instead of `raw.neon` or `laravel.neon`. It keeps the base cut and turns on `phpstan/phpstan-strict-rules`, so loose comparisons like `==` fail the build. Existing apps stay on the base cut and baseline their way over. Strict is the tailor's chalk line drawn before the first stitch.
+New apps can include `vendor/waynestate/pinstripe/phpstan/strict.neon` instead of `raw.neon` or `laravel.neon`. It keeps the base cut and turns on `phpstan/phpstan-strict-rules`, so loose comparisons like `==` fail the build. Existing apps stay on the base cut and baseline their way over.
+
+PHPStan checks phpdoc method signatures from level 3 up, and `phpstan/phpstan-strict-rules` forces the two switches behind them on for every run it is installed for. The base cut pins `reportMaybesInMethodSignatures` and `reportStaticMethodSignatures` off so it stays exactly as documented; the strict cut keeps them on, so it also reports maybe-mismatched overrides and static method overrides.
+
+`phpstan/phpstan-strict-rules` forces eight more switches on for every run as well. Each one is decided below: low noise and real bugs stay on in every cut, noisy ones are pinned off in the base cut and turned on only in `strict.neon`.
+
+| Parameter | Raw and Laravel cuts | Strict cut | Why |
+|---|---|---|---|
+| `checkExplicitMixedMissingReturn` | on | on | A function declared to return `mixed` that can fall off the end is a real bug, and rare in practice. |
+| `checkFunctionNameCase` | on | on | A wrongly cased function name works on Windows and macOS and breaks on Linux. |
+| `checkInternalClassCaseSensitivity` | on | on | The same case bug for PHP's own classes. |
+| `checkStrictPrintfPlaceholderTypes` | on | on | `%d` fed a string is a real formatting bug, and rare. |
+| `checkDynamicProperties` | off | on | Floods legacy code with undeclared properties. |
+| `reportMaybesInPropertyPhpDocTypes` | off | on | Reports "maybe" phpdoc mismatches that legacy docblocks trip constantly. |
+| `reportWrongPhpDocTypeInVarTag` | off | on | Old `@var` tags are often loose; fixing them is cleanup, not bug hunting. |
+| `reportNonIntStringArrayKey` | off | on | Bleeding-edge check that is noisy on loosely keyed arrays. |
+
+Strict is the tailor's chalk line drawn before the first stitch.
 
 ## Adopting on an existing app
 
@@ -203,6 +223,8 @@ gets longer.
 
 ## Tested with
 
+Maintainers: how to build, test and release this project, and where its data comes from, is in [MAINTAINING.md](MAINTAINING.md).
+
 - Pint 1.32.1
 - PHPStan 2.3.3
 - PHPStan extension-installer 1.4.3

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@waynestate/pinstripe",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "The coding standard for the Wayne State app stack: shared ESLint and Prettier presets for Vue.",
     "license": "MIT",
     "homepage": "https://pinstripe.apps.wayne.edu/",