@webority/repo-checks 0.132.0 → 0.134.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/dist/repo-checks.js +28 -28
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -19,7 +19,7 @@ pnpm exec webority-repo-checks --offline # no advisory audit, so no network
|
|
|
19
19
|
An app is a `package.json` whose `dependencies` hold `react-native` (mobile) or `react-dom` (web). A `react-dom` folder that also has `react-native-web` is a react-native-web demo: it gets the pnpm and Biome checks, not the portal rules. Biome and `@webority/biome-config` are read from the `package.json` beside the `biome.json` in effect (a nested config with `"root": false` defers to the one above), so a sub-folder linted by the root config does not repeat them. A `workspace:`, `file:` or `link:` reference is local and never counts as a lockstep version.
|
|
20
20
|
A package with `agentation` in its `dependencies` is a build tool, not an app. It and anything else (tooling roots, libraries) get only the lockfile check.
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
A mobile app with an `android/` folder gets the Android checks, and a web app's `src/` the import checks.
|
|
23
23
|
The `missing-export:<file>` check runs the Biome installed beside the app or in a folder above it, so it needs `@biomejs/biome` installed; without one it reports nothing, and the `required:@biomejs/biome` finding fails the app.
|
|
24
24
|
|
|
25
25
|
| Finding | What it means |
|
|
@@ -27,13 +27,10 @@ The `missing-export:<file>` check runs the Biome installed beside the app or in
|
|
|
27
27
|
| `banned:<name>` | A dependency the rules retire or forbid (ESLint, Prettier, lint-staged, react-toastify, moment and the rest; the mobile list is the retired-libraries table) |
|
|
28
28
|
| `required:<name>` | A dependency every app carries (Biome and the shared preset, the core and UI packages, Bootstrap and react-bootstrap on web, Crashlytics on mobile) |
|
|
29
29
|
| `not-exact:<name>` | A `^` or `~` range. Web pins `@webority/*` and `bootstrap` exactly; a React Native app pins every dependency exactly |
|
|
30
|
-
| `bootstrap-version` | Bootstrap other than 5.3.3 |
|
|
31
30
|
| `lockstep:<set>` | Packages that publish together at one version are pinned at different versions |
|
|
32
31
|
| `pnpm:*` | A committed `package-lock.json` or `yarn.lock`, no `pnpm-lock.yaml`, no `devEngines.packageManager` of `{ "name": "pnpm", "version": "<x.y.z>", "onFail": "error" }` (a plain `npm install` fails, and pnpm refuses any other version), a leftover `packageManager` field (pnpm ignores it beside devEngines), or a `pnpm-workspace.yaml` without `engineStrict: true` and `strictPeerDependencies: true` |
|
|
33
32
|
| `biome:*` | No Biome config, a config that does not extend `@webority/biome-config/biome.jsonc`, a `formatter.lineEnding` or root `linter.rules`, or (mobile) no `__DEV__` global, either top-level or in an override whose `includes` cover the app folder |
|
|
34
33
|
| `catalogue-copy:<file>` | A `.jsx` or `.tsx` file anywhere under `src/` of a web app, or of a workspace package that depends on `@webority/ui-react`, named like a `@webority/ui-react` export |
|
|
35
|
-
| `engines-node-floor:package.json` | `engines.node` is missing or is not `>=24.15 <25` |
|
|
36
|
-
| `engines-node-floor:.nvmrc` | No `.nvmrc` at or above the app, or it does not hold `24` |
|
|
37
34
|
| `android-release-signing` | `android/app/build.gradle` has no guard that throws a `GradleException` when a requested task name contains `release` and a signing setting or the upload key is missing |
|
|
38
35
|
| `android-edge-to-edge` | `android/gradle.properties` sets `edgeToEdgeEnabled=false` |
|
|
39
36
|
| `rn-mainactivity-oncreate-bundle:<file>` | A `MainActivity.kt` or `.java` passes a bundle to `super.onCreate`; pass `null` |
|
|
@@ -169,7 +166,10 @@ with its lines.
|
|
|
169
166
|
|
|
170
167
|
## The shared pre-commit hook
|
|
171
168
|
|
|
172
|
-
Every repository runs the pre-commit hook this package ships
|
|
169
|
+
Every library and tool repository runs the pre-commit hook this package ships: the ones whose
|
|
170
|
+
`.webority/settings.json` sets `kind` to `library` or `tool`, or that have no settings file. Any other
|
|
171
|
+
kind (a product, a website, a mobile app) carries no hook, and `hook:drift` stays quiet there. Adopt it
|
|
172
|
+
once, from the git root:
|
|
173
173
|
|
|
174
174
|
```bash
|
|
175
175
|
pnpm exec webority-repo-checks --sync-hook
|