oxlint-plugin-arch 0.13.0 → 0.13.2

package/CHANGELOG.md

@@ -1,5 +1,76 @@
 # Changelog
 
+## 0.13.2
+
+Preset defaults that change what an app reports:
+
+- Effect contract packages also accept `<d>.service.ts`, which holds no functions (`files-no-functions`), next to `<d>.layer.types.ts`.
+- Effect servers and contract packages are locked by default (`effect.strict`, on): the top level of each file kind, yielded service names, dependencies yielded first, layer keys against function names and against the service class, rpc and mail file and export names, workflow, constant, config and prompt names, the service key, error tags and codes, and tests that hold only test calls. `effect: { strict: false }` on the app or package turns the lock off; `docs/groups/effect.md` lists every key.
+- Effect servers, locked: a layer binds no inline function, under `*.of` as well as `*.bind`; the span inside `X.toLayer(Effect.fn('…'))` follows `X`; an rpc handler returns the call its key path names (`naming-keys` `delegate`).
+- Effect contract packages, locked: a contract file has `<d>.service.ts` beside it (`files-siblings`), calls no `Schema.Struct`, and a service method takes a `<D>…Params` type (`effect-service-params`).
+- Effect servers: in `*.actions.ts` and `*.queries.ts` an `Effect.fn` span follows its function's name (`orderActionScheduleCancel` is `'order.schedule.cancel'`), and in `*.workflows.ts` a `Workflow.make` name is its constant without `Workflow` (`naming-labels`).
+
+Rules and options:
+
+- New `files-top-level`: `allow` lists what may sit at the top level of a file, `deny` what may not, by kind (`type`, `interface`, `enum`, `class`, `const`, `let`, `function`, `function-const`, `call` and the rest), name, and what builds a constant (`from: '^Schema\\.'`).
+- New `naming-imports`: an import takes the name its specifier expands to, such as `@scope/kit-{package}` as `{Package}Kit`, as a namespace import by default.
+- New `naming-labels`: the text label of a call (a span, a workflow name, a service key, an error tag or code) follows the name the call is assigned to, or a pattern.
+- New `naming-keys`: a value bound under an object key is named after the key path, such as `schedule.cancel` and `orderActionScheduleCancel`.
+- New `naming-pairs`: two calls of one chain take values that share a name, such as a procedure's input and output Schemas.
+- New `files-siblings`: a file needs other files beside it, such as a contract next to its service.
+- `naming-keys` also reads exported objects (`exports`) and takes `keys` (a pattern for the keys themselves), `inline: false`, `delegate` (a handler returns the call its key path names), `allow`, `singularize` and the `{Key}` placeholder; `name` is now optional.
+- `naming-labels` takes `within`: a label passed into a call is named after that call's receiver (`X.toLayer(Effect.fn('…'))`).
+- New `effect-service-params`: a method of a service class takes a named params type, `<Folder>…Params` by default, with `name`, `allow` and `declaration`.
+- `effect-schema-first` takes `allow`: exported values that are not Schemas, such as a filter, need no derived type.
+- New `effect-layer-keys`: a layer binds exactly the methods its service class declares in another file.
+- New `effect-yields-first`: service yields come before any other statement of a generator.
+- New `code-inside`: a call banned inside another call's callback, such as a workflow started inside a transaction.
+- `naming-file` takes `template`, a path the file must fit; a placeholder written twice must hold the same text (`{group}/rpc.{group}.{area}.ts`).
+- New `effect-yield-name`: a `const` holding a yielded service is named after it (`const orders = yield* Orders.Orders`), with `names` and `allow`.
+- The `top` group takes `stem`, `singularize`, `roles`, `separators`, `file` and `placeholder`; a `files-top-level` report says what each allowed entry requires.
+- New `top` group: `top: ['describe', 'it', 'it.each']` on a folder or file key runs `files-top-level`; `import` is always allowed. On by default and empty.
+- Preset `sets`: name a list or a map once and write `{name}` in any key or list, or `each: 'name'` on a list entry, instead of constants and helpers above the config.
+- `deny.only` and `boundaries-deny` `only`: imports and calls used in the listed places only, each side one value or a list.
+- `naming.imports` in the preset: specifier template to import name.
+- `effect.files` adds or removes (`!`) contract file kinds, such as `*.policy.ts`.
+- `naming-exports`, `naming-declarations` and `files-exports` read `{folder}`, `{parent}`, `{stem}` and `{file}` from the path in patterns and names; an uppercase placeholder is constant case.
+- `naming-exports` and `naming-declarations` take `prefix`, the places a prefix may come from (`file`, `folder`, `parent`); `naming-exports` `template` takes several `export` names and a `file` with folders.
+- `naming-declarations` takes several option objects, one check per kind.
+- `files-exports` takes `file`, a path template whose placeholders `names` and `patterns` use.
+- `naming-exports` `template` with a `file` that has no placeholder now checks that file; before, it was skipped.
+- New page: [What a file may contain](docs/files.md).
+
+## 0.13.1
+
+Preset defaults that change what an app reports:
+
+- `effect` group: `layout-call-arguments` adds `pipe: { min: 2 }`; `layout-call-depth` counts through callbacks; `layout-object` adds `params`, `nested`, `siblings` and `inner: 2`; `layout-ternary` splits a one-line ternary over 100 columns (was `fit: false`); `layout-type-arguments` is on with `min: 3`.
+- Effect servers: `comments-code` keeps one-line step comments (`steps: true`); `effect-layer-file` names local layers `<Role>Layer` (`suffix: 'Layer'`). An app that keeps `layer<Role>` writes `'apps/server/src/domains/*/*.layer.ts': { rules: { 'arch/effect-layer-file': 'error' } }`.
+- `sql` group: `layout-chain` breaks Kysely chains of 3+ calls.
+- Effect servers and contract packages ban `ai` and `@ai-sdk/**` ("Use effect/ai.").
+
+Rules and options:
+
+- Preset: when several file keys match one file, their settings merge on it, broadest key first; before, the later key's group or `rules` replaced the earlier one's, so a broad key could undo a convention's exception.
+- `boundaries-*`: the `@/`, `#/` and `#services/` prefixes resolve `..` segments, so `#services/chat/../service` reaches the registry check.
+- `react-memo` also reports `R['memo']` and a `{ default as R }` import.
+- Vendored `require-safety-comment-for-type-assertion` matches a `comment` that starts with a non-ASCII letter.
+- `effect-layer-file` takes `suffix`, such as `'Layer'`, to name local layers `<Role>Layer`; it also recognises those names as Layers.
+- `comments-code` takes `steps`: a single `//` line directly above a statement in a function, or above a property in an object literal, stays.
+- `layout-object` takes `params`, which splits a one-line destructured parameter with `min` properties, and `nested`, which splits a one-line object holding an object or function.
+- `layout-call-arguments` takes `pipe: { min }`, which splits a one-line pipe with `min` steps even while `split` is off.
+- `layout-pipe` takes `methods`, and `layout-call-arguments` `pipe.methods`, for pipe methods other than `pipe`.
+- `naming-types` takes `pattern`; `types-local-alias` takes `allow`.
+- `react-dynamic-classes` takes `attributes`; `react-empty-effect` takes `hooks`; `react-memo` takes `names`, `sources` and `message`.
+- Vendored `no-shape-in-symbol-names` takes `terms`; `require-safety-comment-for-type-assertion` takes `comment`.
+- `boundaries-imports`, `boundaries-next` and `boundaries-tanstack` take `conventions` for every file and folder name they read; `boundaries-imports` `portable` also takes a folder name, and `boundaries-tanstack` takes `serverHooks`. The `#services/` prefix follows the services folder.
+- New `layout-type-arguments`: a one-line type argument list holding a union of `min` types puts each type on its own line, each after a leading `|`.
+- `layout-object` `nested` reports without a fix inside a ternary or before a chained call; new `inner` splits an object with `inner` or more entries inside a split object, at every depth; new `siblings` splits an object argument to match a split sibling call in the same array.
+- With `layout-call-arguments` `pipe` set, `join` leaves every pipe as written.
+- `layout-call-arguments` `hug` also reports a call whose argument drops to the next line while `)` stays on it, and splits it fully.
+- `code-inline` no longer asks to inline a top-level value when the result would pass `max` columns or `nesting`.
+- `layout-call-depth` takes `callbacks`, which counts nesting through inline callbacks; `code-inline` takes the same `callbacks`, and the `effect` group sets both.
+
 ## 0.13.0
 
 ### Migrating from 0.12

package/README.md

@@ -42,7 +42,7 @@ export default preset({
 })
 ```
 
-The preset detects each workspace from its `package.json` (TanStack, Next, Expo, backend, UI kit, library) along with its stylesheet, service registry and migrations. List only the folders you want to change. Detection, inheritance, groups, recipes and templates: [docs/folders.md](docs/folders.md). Rules without the preset: [docs/plugin-only.md](docs/plugin-only.md).
+The preset detects each workspace from its `package.json` (TanStack, Next, Expo, backend, UI kit, library) along with its stylesheet, service registry and migrations. List only the folders you want to change. Detection, inheritance, groups, recipes and templates: [docs/folders.md](docs/folders.md). Locking down what one kind of file may contain: [docs/files.md](docs/files.md). Rules without the preset: [docs/plugin-only.md](docs/plugin-only.md).
 
 **3. Lint**
 
@@ -53,22 +53,22 @@ bunx oxlint
 ## 📚 Groups and rules
 
 <!-- generated:start -->
-On by default: [`layout`](docs/groups/layout.md), [`limits`](docs/groups/limits.md), [`style`](docs/groups/style.md), [`basics`](docs/groups/basics.md), [`naming`](docs/groups/naming.md), [`comments`](docs/groups/comments.md), [`types`](docs/groups/types.md), [`imports`](docs/groups/imports.md), [`tests`](docs/groups/tests.md), [`deny`](docs/groups/deny.md), [`externals`](docs/groups/externals.md).
+On by default: [`layout`](docs/groups/layout.md), [`limits`](docs/groups/limits.md), [`style`](docs/groups/style.md), [`basics`](docs/groups/basics.md), [`naming`](docs/groups/naming.md), [`comments`](docs/groups/comments.md), [`types`](docs/groups/types.md), [`imports`](docs/groups/imports.md), [`tests`](docs/groups/tests.md), [`deny`](docs/groups/deny.md), [`top`](docs/groups/top.md), [`externals`](docs/groups/externals.md).
 
 Opt-in: [`react`](docs/groups/react.md), [`tanstack`](docs/groups/tanstack.md), [`next`](docs/groups/next.md), [`expo`](docs/groups/expo.md), [`tailwind`](docs/groups/tailwind.md), [`shadcn`](docs/groups/shadcn.md), [`kit`](docs/groups/kit.md), [`backend`](docs/groups/backend.md), [`orpc`](docs/groups/orpc.md), [`schemas`](docs/groups/schemas.md), [`forms`](docs/groups/forms.md), [`sql`](docs/groups/sql.md), [`effect`](docs/groups/effect.md), [`console`](docs/groups/console.md).
 
-83 rules, IDs `arch/<rule>`. 🔧 = autofix.
+95 rules, IDs `arch/<rule>`. 🔧 = autofix.
 
 | Family | Covers | Rules |
 | --- | --- | --- |
 | `backend` | Service and RPC structure | [`backend-orpc-output`](docs/rules/backend-orpc-output.md), [`backend-registry`](docs/rules/backend-registry.md), [`backend-service-functions`](docs/rules/backend-service-functions.md), [`backend-sql-like`](docs/rules/backend-sql-like.md) |
 | `boundaries` | Import and runtime boundaries | [`boundaries-deny`](docs/rules/boundaries-deny.md), [`boundaries-imports`](docs/rules/boundaries-imports.md), [`boundaries-next`](docs/rules/boundaries-next.md), [`boundaries-rpc-database`](docs/rules/boundaries-rpc-database.md), [`boundaries-tanstack`](docs/rules/boundaries-tanstack.md), [`boundaries-token-owner`](docs/rules/boundaries-token-owner.md) |
-| `code` | Code shapes to avoid | [`code-branch-once`](docs/rules/code-branch-once.md), [`code-constructor`](docs/rules/code-constructor.md), [`code-delegate`](docs/rules/code-delegate.md), [`code-double-negation`](docs/rules/code-double-negation.md), [`code-function-nesting`](docs/rules/code-function-nesting.md), [`code-inline`](docs/rules/code-inline.md), [`code-justified-call`](docs/rules/code-justified-call.md), [`code-literal-in`](docs/rules/code-literal-in.md), [`code-mutable-state`](docs/rules/code-mutable-state.md), [`code-object-params`](docs/rules/code-object-params.md), [`code-paired-call`](docs/rules/code-paired-call.md), [`code-promise-mutation`](docs/rules/code-promise-mutation.md), [`code-switch`](docs/rules/code-switch.md), [`code-traced`](docs/rules/code-traced.md), [`code-trivial-functions`](docs/rules/code-trivial-functions.md), [`code-yield-argument`](docs/rules/code-yield-argument.md) |
+| `code` | Code shapes to avoid | [`code-branch-once`](docs/rules/code-branch-once.md), [`code-constructor`](docs/rules/code-constructor.md), [`code-delegate`](docs/rules/code-delegate.md), [`code-double-negation`](docs/rules/code-double-negation.md), [`code-function-nesting`](docs/rules/code-function-nesting.md), [`code-inline`](docs/rules/code-inline.md), [`code-inside`](docs/rules/code-inside.md), [`code-justified-call`](docs/rules/code-justified-call.md), [`code-literal-in`](docs/rules/code-literal-in.md), [`code-mutable-state`](docs/rules/code-mutable-state.md), [`code-object-params`](docs/rules/code-object-params.md), [`code-paired-call`](docs/rules/code-paired-call.md), [`code-promise-mutation`](docs/rules/code-promise-mutation.md), [`code-switch`](docs/rules/code-switch.md), [`code-traced`](docs/rules/code-traced.md), [`code-trivial-functions`](docs/rules/code-trivial-functions.md), [`code-yield-argument`](docs/rules/code-yield-argument.md) |
 | `comments` | Comments and directives | [`comments-code`](docs/rules/comments-code.md) 🔧, [`comments-directives`](docs/rules/comments-directives.md) |
 | `copy` | User-facing text | [`copy-dashes`](docs/rules/copy-dashes.md) |
-| `files` | What a file may contain or export | [`files-components-only`](docs/rules/files-components-only.md), [`files-constants-only`](docs/rules/files-constants-only.md), [`files-domain-constants`](docs/rules/files-domain-constants.md), [`files-exports`](docs/rules/files-exports.md), [`files-externals`](docs/rules/files-externals.md), [`files-factory-keys`](docs/rules/files-factory-keys.md), [`files-helpers`](docs/rules/files-helpers.md), [`files-no-functions`](docs/rules/files-no-functions.md), [`files-restricted`](docs/rules/files-restricted.md), [`files-route`](docs/rules/files-route.md), [`files-types-only`](docs/rules/files-types-only.md) |
-| `layout` | Layout a formatter leaves alone | [`layout-arrow-body`](docs/rules/layout-arrow-body.md) 🔧, [`layout-call-arguments`](docs/rules/layout-call-arguments.md) 🔧, [`layout-call-array`](docs/rules/layout-call-array.md) 🔧, [`layout-call-depth`](docs/rules/layout-call-depth.md), [`layout-chain`](docs/rules/layout-chain.md) 🔧, [`layout-items`](docs/rules/layout-items.md) 🔧, [`layout-jsx-attributes`](docs/rules/layout-jsx-attributes.md) 🔧, [`layout-key-value`](docs/rules/layout-key-value.md) 🔧, [`layout-object`](docs/rules/layout-object.md) 🔧, [`layout-padding`](docs/rules/layout-padding.md) 🔧, [`layout-pipe`](docs/rules/layout-pipe.md), [`layout-ternary`](docs/rules/layout-ternary.md) 🔧 |
-| `naming` | File, folder and export names | [`naming-declarations`](docs/rules/naming-declarations.md), [`naming-exports`](docs/rules/naming-exports.md), [`naming-file`](docs/rules/naming-file.md), [`naming-folder`](docs/rules/naming-folder.md), [`naming-types`](docs/rules/naming-types.md) |
+| `files` | What a file may contain or export | [`files-components-only`](docs/rules/files-components-only.md), [`files-constants-only`](docs/rules/files-constants-only.md), [`files-domain-constants`](docs/rules/files-domain-constants.md), [`files-exports`](docs/rules/files-exports.md), [`files-externals`](docs/rules/files-externals.md), [`files-factory-keys`](docs/rules/files-factory-keys.md), [`files-helpers`](docs/rules/files-helpers.md), [`files-no-functions`](docs/rules/files-no-functions.md), [`files-restricted`](docs/rules/files-restricted.md), [`files-route`](docs/rules/files-route.md), [`files-siblings`](docs/rules/files-siblings.md), [`files-top-level`](docs/rules/files-top-level.md), [`files-types-only`](docs/rules/files-types-only.md) |
+| `layout` | Layout a formatter leaves alone | [`layout-arrow-body`](docs/rules/layout-arrow-body.md) 🔧, [`layout-call-arguments`](docs/rules/layout-call-arguments.md) 🔧, [`layout-call-array`](docs/rules/layout-call-array.md) 🔧, [`layout-call-depth`](docs/rules/layout-call-depth.md), [`layout-chain`](docs/rules/layout-chain.md) 🔧, [`layout-items`](docs/rules/layout-items.md) 🔧, [`layout-jsx-attributes`](docs/rules/layout-jsx-attributes.md) 🔧, [`layout-key-value`](docs/rules/layout-key-value.md) 🔧, [`layout-object`](docs/rules/layout-object.md) 🔧, [`layout-padding`](docs/rules/layout-padding.md) 🔧, [`layout-pipe`](docs/rules/layout-pipe.md), [`layout-ternary`](docs/rules/layout-ternary.md) 🔧, [`layout-type-arguments`](docs/rules/layout-type-arguments.md) 🔧 |
+| `naming` | File, folder and export names | [`naming-declarations`](docs/rules/naming-declarations.md), [`naming-exports`](docs/rules/naming-exports.md), [`naming-file`](docs/rules/naming-file.md), [`naming-folder`](docs/rules/naming-folder.md), [`naming-imports`](docs/rules/naming-imports.md), [`naming-keys`](docs/rules/naming-keys.md), [`naming-labels`](docs/rules/naming-labels.md), [`naming-pairs`](docs/rules/naming-pairs.md), [`naming-types`](docs/rules/naming-types.md) |
 | `react` | Components, effects, class names | [`react-dynamic-classes`](docs/rules/react-dynamic-classes.md), [`react-empty-effect`](docs/rules/react-empty-effect.md), [`react-memo`](docs/rules/react-memo.md), [`react-props`](docs/rules/react-props.md), [`react-query-props`](docs/rules/react-query-props.md) |
 | `schemas` | Schema placement | [`schemas-inline`](docs/rules/schemas-inline.md), [`schemas-local`](docs/rules/schemas-local.md), [`schemas-rederive`](docs/rules/schemas-rederive.md), [`schemas-single-use`](docs/rules/schemas-single-use.md) |
 | `tests` | Test structure | [`tests-assertions`](docs/rules/tests-assertions.md), [`tests-concurrent-db`](docs/rules/tests-concurrent-db.md), [`tests-modifiers`](docs/rules/tests-modifiers.md), [`tests-titles`](docs/rules/tests-titles.md) |