Skip to content
1 min read · 222 words

batteries/sandbox/lint ​

Remarks ​

Battery-scoped rules ship with the battery, not with the core @nhtio/adk/eslint plugin — they only matter to deployments that compose this battery, and they version with the battery's own API. The rules are report-only (no autofix); carve out a deliberate exception with an inline // eslint-disable-next-line adk-sandbox/{rule} -- {reason} comment.

@typescript-eslint/utils and eslint are OPTIONAL peer dependencies of @nhtio/adk — installed only by consumers who lint with this plugin. The sandbox runtime never imports this module, and the batteries/sandbox barrel does not re-export it.

Example ​

Flat config

ts
import adkSandbox from "@nhtio/adk/batteries/sandbox/lint";

export default [
  {
    plugins: { "adk-sandbox": adkSandbox.plugin },
    rules: adkSandbox.configs.recommended.rules,
  },
];

Variables ​

VariableDescription
configsNamed config presets. recommended registers the plugin under the adk-sandbox namespace and enables every rule: the two policy-shape rules at warn (a deployment may mean them, and the warning is a review signal), and require-gate at error (construction throws without it).
defaultDefault export bundles the plugin and its config presets, mirroring the shape ESLint flat configs expect from a plugin module.
pluginThe sandbox battery's ESLint plugin object. Register under the adk-sandbox namespace: plugins: { 'adk-sandbox': plugin }.
rulesMap of rule id (without the adk-sandbox/ plugin prefix) to its rule object. Registered on the plugin as rules, so configs reference them as adk-sandbox/{id}.