larrylint

🦙 larrylint

Opinionated rules for Laioutr apps: an ESLint preset for your editor and a CLI for CI.

Laioutr apps are Nuxt modules with a lot of moving parts: sections and blocks, orchestr handlers, middleware, API clients, server routes. larrylint keeps them where they belong and stops the imports that make a codebase drift, like app code pulling in server code or handlers importing each other. It also catches the mistakes that only show up in Studio or in production, like schema fields that never reach the component, fallbacks that never apply, or cookies written after orchestr has sent the headers.

Usage

Check the Laioutr app in the current folder. No install and no config needed:

npx larrylint

Set it up for good. This installs larrylint, adds its rules to your eslint.config, and records existing violations in a baseline so only new code has to follow the rules:

npx larrylint init

After that, eslint . and your editor report larrylint's rules next to your own.

token-namespaces reads the app's installed @laioutr-core/canonical-types, so install the app's dependencies first. larrylint stops with an error when it's missing.

Rules

Structure

Type imports are always fine, since they don't end up in the bundle.

Orchestr

Sections and blocks

Frontend

Layout

larrylint follows the runtime layout from Laioutr's coding standards:

src/
├── module.ts                # registers sections, blocks, orchestr handlers and plugins
└── runtime/
    ├── app/                 # client code
    │   ├── components/      # UI components
    │   ├── sections/        # defineSection() components
    │   └── blocks/          # defineBlock() components
    ├── server/              # server code
    │   ├── client/          # API client factories
    │   ├── const/
    │   ├── mappers/
    │   ├── middleware/      # defineOrchestr() with extendRequest()
    │   ├── orchestr/        # *.query.ts, *.resolver.ts, *.link.ts, *.action.ts, *.template.ts, *.page-index.ts
    │   ├── orchestr-helper/ # helper logic for handlers
    │   └── utils/
    └── shared/              # code for both sides, like orchestr tokens

Where your sections, blocks and handlers live, larrylint reads from your module.ts: the folders and globs you pass to registerLaioutrApp(), and the plugins you pass to addPlugin(). So other folders work too, like section/ and block/ in Laioutr's own ui-app. Without a module.ts it can read, larrylint assumes the folders of Laioutr's app starter: app/sections/, app/blocks/ and server/orchestr/.

Besides that, larrylint only relies on the names app/components/ and server/client/, and on the split into app/, server/ and shared/.

Baseline

On an existing codebase, larrylint init records all current violations in larrylint-baseline.json, counted per file and rule. A file stays quiet as long as it has no more violations of a rule than recorded. Once it gets more, all of them show again, like ESLint's bulk suppressions. The baseline applies in your editor, in eslint . and in the CLI.

After fixing old violations, shrink the baseline:

npx larrylint --baseline

Configuration

Most apps need none. heavyPackages lists the packages that sections, blocks and plugins must load with import(), for heavy-imports. Set it in your package.json:

{
  "larrylint": {
    "heavyPackages": ["leaflet"]
  }
}

Or in a larrylint.config.ts:

import { defineLarrylintConfig } from 'larrylint'

export default defineLarrylintConfig({
  heavyPackages: ['leaflet'],
})

ESLint

larrylint init adds the rules to your eslint.config for you. To do it by hand with @nuxt/eslint-config or @antfu/eslint-config:

import { createConfigForNuxt } from '@nuxt/eslint-config/flat'
import larrylint from 'larrylint'

export default createConfigForNuxt().append(larrylint())

With a plain array, like @laioutr/eslint-config:

import config from '@laioutr/eslint-config/nuxt-module'
import larrylint from 'larrylint'

export default [...config, ...(await larrylint())]

The preset only brings rules, no parsers or style rules, so it runs on top of whatever your config already uses.

CLI

larrylint [--cwd <folder>] [--fix] [--baseline]
larrylint init [--cwd <folder>]

• --fix fixes what can be fixed automatically.
• --baseline records the current violations in larrylint-baseline.json.

The CLI only runs larrylint's rules, independent of your ESLint setup, and exits with code 1 on new violations.

License

Published under the MIT License.