Skip to content
ContractSpec
Start here

Package manual · tools

·CLI, authoring and agent tooling

tools.eslint-plugin-no-implicit-sensitivefields

ESLint rule enforcing that every defineReferenceKind() call declares an explicit sensitiveFields array (closes F-4).

toolstoolv2.0.4experimentalservernode
@lssm-tech/tools.eslint-plugin-no-implicit-sensitivefields
bun add @lssm-tech/tools.eslint-plugin-no-implicit-sensitivefields
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

ESLint plugin that enforces explicit sensitiveFields declarations on every defineReferenceKind() call from @lssm-tech/lib.contracts-spec/rich-reference.

Closes plan slice S-1b (architect NR-2 / F-4 mitigation): the contracts-spec runtime already throws when sensitiveFields is missing or non-array, but the runtime cannot enforce the additional repository policy that an empty array (sensitiveFields: []) must be accompanied by an inline confirmation comment. This rule catches both issues at lint time.

Install

bash
bun add -d @lssm-tech/tools.eslint-plugin-no-implicit-sensitivefields

eslint (>=8, <11) is a peer dependency.

Flat config (ESLint 9+)

js
import noImplicitSensitiveFields from '@lssm-tech/tools.eslint-plugin-no-implicit-sensitivefields';

export default [
  {
    plugins: { 'no-implicit-sensitivefields': noImplicitSensitiveFields },
    rules: { 'no-implicit-sensitivefields/no-implicit-sensitivefields': 'error' },
  },
];

Or apply the bundled recommended flat config in one line:

js
import { configs } from '@lssm-tech/tools.eslint-plugin-no-implicit-sensitivefields';

export default [configs.recommended];

What the rule does

For every call expression whose callee is defineReferenceKind (or <obj>.defineReferenceKind):

  1. If the object literal argument lacks a sensitiveFields property → reports missing.
  2. If sensitiveFields: [] appears without a nearby comment containing confirmed: no sensitive fields → reports emptyWithoutComment.

A "nearby" comment is one whose line number is within ±1 line of the sensitiveFields property — covering the common authoring shapes: a leading comment, a same-line trailing comment, or an in-block comment immediately after.

Valid

ts
defineReferenceKind({
  id: 'ticket',
  schema,
  sensitiveFields: ['title'],
  defaultPreview: 'inline-card',
  defaultPanel: 'drawer',
  icon: 'ticket',
});

defineReferenceKind({
  id: 'public-doc',
  schema,
  // confirmed: no sensitive fields
  sensitiveFields: [],
  defaultPreview: 'inline-card',
  defaultPanel: 'drawer',
  icon: 'doc',
});

defineReferenceKind({
  id: 'public-doc-2',
  schema,
  sensitiveFields: [], // confirmed: no sensitive fields
  defaultPreview: 'inline-card',
  defaultPanel: 'drawer',
  icon: 'doc',
});

Invalid

ts
// Missing sensitiveFields entirely
defineReferenceKind({
  id: 'bad-1',
  schema,
  defaultPreview: 'inline-card',
  defaultPanel: 'drawer',
  icon: 'bad',
}); // error: missing

// Empty list without the confirmation marker
defineReferenceKind({
  id: 'bad-2',
  schema,
  sensitiveFields: [],
  defaultPreview: 'inline-card',
  defaultPanel: 'drawer',
  icon: 'bad',
}); // error: emptyWithoutComment

Test

bash
bun test

Relationships

THIS PACKAGEtools.eslint-plugin-no-implicit-sensitivefields2 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

0 declarations

No Runtime dependencies are declared here.

Declared capabilities

This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.

Scripts

  • buildcontractspec-bun-build build
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types
  • cleanrimraf dist .turbo
  • lintbun run lint:fix
  • lint:fixnode ../../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../../scripts/biome.cjs check --write .
  • lint:checknode ../../../scripts/biome.cjs check .
  • testbun test
  • typechecktsgo --noEmit
  • prebuildcontractspec-bun-build prebuild