@osmeridian/lint-typecheck-format-test

@osmeridian/lint-typecheck-format-test

Shared lint, format, typecheck defaults, and Vitest factory for Omniswift Vue/Nuxt apps.

Rule changes belong in this package only. Consuming apps keep thin re-exports and allowlisted overlays — do not copy or edit shared rule tables locally.

Copy-paste stubs: examples/nuxt-consumer/.

Engines: Node >=22.18.0 <25, pnpm >=10.

Install

pnpm add -D @osmeridian/lint-typecheck-format-test oxc-nuxt eslint@10.8.1 oxlint-tsgolint@7.0.2001

Or pin an exact version:

{
  "devDependencies": {
    "@osmeridian/lint-typecheck-format-test": "1.1.2",
    "eslint": "10.8.1",
    "oxc-nuxt": "^0.1.5",
    "oxlint-tsgolint": "7.0.2001"
  }
}

Install the exact eslint and oxlint-tsgolint versions listed here — not ^ / >= / “whatever is current.”

ltft runs the copies bundled in this package. The editor and Oxlint type-aware lookup use the copies in the app. Those two paths must be the same version, or IDE squiggles and CI will disagree. oxlint and oxlint-tsgolint are also paired; a newer tsgolint with an older oxlint (or the reverse) breaks --type-aware. Shared rule tables are tested against these pins — bump them in this package, then bump the app to match.

Oxlint, Prettier, and related plugins still ship with this package for ltft lint / ltft format.

Apply in a Nuxt app

1. Register oxc-nuxt

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ["oxc-nuxt" /* ... */],
});

This package does not bundle or register that module.

2. Prepare Nuxt

nuxt prepare

This generates .nuxt/oxlint.mjs (withNuxt) so Oxlint knows Nuxt auto-import globals.

3. Add thin config files

ESLint — re-export the shared flat config:

// eslint.config.js
export { default } from "@osmeridian/lint-typecheck-format-test/eslint";

Oxlint — wrap shared rules with withNuxt:

// oxlint.config.ts
import { withNuxt } from "./.nuxt/oxlint.mjs";
import { baseOxlint } from "@osmeridian/lint-typecheck-format-test/oxlint";

export default withNuxt({
  ...baseOxlint,
  overrides: [...(baseOxlint.overrides ?? []), /* app-only overrides */],
});

Prettier — spread shared options; set app Tailwind paths:

// .prettierrc.mjs
import base from "@osmeridian/lint-typecheck-format-test/prettier";

export default {
  ...base,
  tailwindStylesheet: "./app/assets/styles/tailwind.css",
  tailwindFunctions: ["cn", "clsx"],
};

The Tailwind plugin path is resolved inside this package — no consumer createRequire needed.

Typecheck defaults (optional):

import { nuxtTypescriptDefaults } from "@osmeridian/lint-typecheck-format-test/typescript/nuxt";

export default defineNuxtConfig({
  typescript: {
    tsConfig: {
      ...nuxtTypescriptDefaults,
      // app paths / excludes
    },
  },
});

Vitest (optional):

import { fileURLToPath } from "node:url";
import { createVitestConfig } from "@osmeridian/lint-typecheck-format-test/vitest";

const rootDir = fileURLToPath(new URL(".", import.meta.url));

export default createVitestConfig({
  rootDir,
  aliases: [
    /* app-specific fixture aliases */
  ],
});

4. Add scripts

{
  "scripts": {
    "lint": "ltft lint",
    "lint:fix": "ltft lint:fix",
    "format": "ltft format",
    "format:fix": "ltft format:fix",
    "typecheck": "nuxt typecheck",
    "test": "vitest run"
  }
}

CLI

ltft lint           # oxlint then eslint; fails on warnings
ltft lint:fix      # same with --fix
ltft format         # prettier --check
ltft format:fix    # prettier --write
ltft format:check   # alias for format
ltft help

typecheck and test stay as app scripts (nuxt typecheck, vitest run) — they are not part of ltft.

This package does not ship lint-staged or husky. Wire pre-commit hooks in the app if you want them.

How ltft lint works

ltft lint always runs both tools, in order. Either step exits non-zero on failure; warnings are treated as failures.

What Oxlint and ESLint do

They are complementary, not alternatives.

Rules and config reference

Oxlint (baseOxlint)

Source: src/oxlint/base.js.

Categories

Enabling a category turns on many plugin defaults beyond the explicit rules table below. Those explicit entries are overrides and additions.

Options: denyWarnings: true, typeAware: true.

Plugins: eslint, import, node, oxc, promise, typescript, unicorn, vue (plus JSDoc via a path override).

Explicit top-level rules

Path overrides

ESLint

Source: src/eslint/index.js.

Built on eslint-plugin-vue flat/base plus a local plugin.

Utils files — **/utils/**/*.{ts,js,mts,cts,mjs,cjs} (ignores *.{spec,test}.* and __tests__):

Filenames under a utils/ directory must end with -utils (e.g. date-utils.ts). Names of 2 characters or fewer (e.g. cn.ts) are exempt.

Vue SFCs — app/**/*.vue:

Hexagonal import bans — no-restricted-imports (source: src/eslint/hexagonal.js):

Optional named export: @osmeridian/lint-typecheck-format-test/eslint/hexagonal (already included in the default /eslint config).

Attribute order (local/static-before-dynamic-attrs):

1. Definition (is)
2. List rendering (v-for)
3. Conditionals (v-if / v-else-if / v-else / v-show / v-cloak)
4. Render modifiers (v-pre / v-once)
5. Global (id)
6. Unique / slot (key, ref, slot)
7. Two-way binding (v-model)
8. Other directives
9. Static attributes (class, role, …)
10. Dynamic attributes (:prop, v-bind)
11. Boolean shorthand
12. Events (@click, …)
13. Content (v-text / v-html)

Prettier

Source: src/prettier/index.js.

ltft format always applies:

1. This package’s prettierignore (.nuxt, .output, node_modules, dist, lockfiles, package.json, …)
2. The project’s .gitignore when present
3. The project’s .prettierignore when present

Keep app-specific excludes in the project .prettierignore only.

TypeScript defaults

nuxtTypescriptDefaults sets:

{ vueCompilerOptions: { checkUnknownProps: true } }

Oxlint --type-aware is separate from nuxt typecheck — use both.

Vitest factory defaults

createVitestConfig({ rootDir, ... }) defaults:

Pass aliases, include, setupFiles, or overrides for app-specific needs.

Overlay allowlist

Allowed in consumers:

Not allowed: copying or editing shared rule tables from this package into the app.

Requesting rule changes

Open a PR against osmeridian/lint-typecheck-format-test, bump the consumer dependency pin after the release.

Package exports

Exports include TypeScript types — consumers do not need local declare module shims.

Example stubs

See examples/nuxt-consumer/ for ESLint, Oxlint, Prettier, Vitest, and package.json script stubs.