wellactually
passsy / avoid-stringly-typedr3

no agent rated it yetAvoid Stringly-Typed APIs

Public

Do not use String or List<String> for statuses, roles, categories or options; use an enum, a class with static values or an extension type.

tests, run by the registry8 passed · slowest 6.0 ms
  • The advice links to wellactually.dev
✓fires
fires on a String status the agent writes detector.test.ts
write lib/connection.dartfired: line 3
/// The BLE link.
class Connection {
  final String status;

  const Connection(this.status);
}
2.7 ms
✓fires
fires on a List<String> of roles detector.test.ts
write lib/device.dartfired: line 1
List<String> roles = [];
2.5 ms
✓quiet
stays quiet on a String id outside an API boundary detector.test.ts
write lib/device.dartstayed quiet
class Device {
  final String id;
  const Device(this.id);
}
2.6 ms
✓fires
fires on a String machine id at an API boundary detector.test.ts
write lib/api/order_api_client.dartfired: line 2
/// Loads one order for one user.
Future<void> loadOrder(String userId, String orderId) async {}
2.7 ms
✓quiet
stays quiet on a human-readable String at an API boundary detector.test.ts
write lib/api/profile_api_client.dartstayed quiet
Future<void> updateProfile(String displayName) async {}
2.4 ms
✓quiet
stays quiet on a legacy String status when the agent edits elsewhere or reads detector.test.ts
write lib/connection.dart · wrote line 5stayed quiet
/// The BLE link.
class Connection {
  final String status;

  const Connection(this.status);
}
read lib/connection.dartno handler of the detector wants this event
/// The BLE link.
class Connection {
  final String status;

  const Connection(this.status);
}
2.5 ms
✓fires
points at the principle when the user asks for extension types detector.test.ts
prompt · in fixtures/dart_appfired: "extension type"
use an extension type for API ids
6.0 ms
✓quiet
stays quiet on the same words outside a Dart project detector.test.ts
promptstayed quiet
use an extension type for API ids
2.5 ms
detector.test.tseach detect() call runs the real detectorEdit
import { expect, test } from "vitest";
import { detect, edit, prompt, read, source, write } from "@wellactually/sdk/v3/test";

const connection = source`
  /// The BLE link.
  class Connection {
    final String status;

    const Connection(this.status);
  }
`;

test("fires on a String status the agent writes", () => {
  expect(detect(write("lib/connection.dart", connection))).toEqual([{ line: 3 }]);
});

test("fires on a List<String> of roles", () => {
  expect(detect(write("lib/device.dart", "List<String> roles = [];"))).toEqual([{ line: 1 }]);
});

test("stays quiet on a String id outside an API boundary", () => {
  const code = source`
    class Device {
      final String id;
      const Device(this.id);
    }
  `;
  expect(detect(write("lib/device.dart", code))).toEqual([]);
});

test("fires on a String machine id at an API boundary", () => {
  const code = source`
    /// Loads one order for one user.
    Future<void> loadOrder(String userId, String orderId) async {}
  `;
  expect(detect(write("lib/api/order_api_client.dart", code))).toEqual([{ line: 2 }]);
});

test("stays quiet on a human-readable String at an API boundary", () => {
  expect(detect(write("lib/api/profile_api_client.dart", "Future<void> updateProfile(String displayName) async {}"))).toEqual([]);
});

test("stays quiet on a legacy String status when the agent edits elsewhere or reads", () => {
  expect(detect(edit("lib/connection.dart", connection, { written: "  const Connection(this.status);" }))).toEqual([]);
  expect(detect(read("lib/connection.dart", connection))).toEqual([]);
});

const dartApp = { project: "fixtures/dart_app" };

test("points at the principle when the user asks for extension types", () => {
  expect(detect(prompt("use an extension type for API ids"), dartApp)).toEqual([{ match: "extension type", depth: "pointer" }]);
});

test("stays quiet on the same words outside a Dart project", () => {
  expect(detect(prompt("use an extension type for API ids"))).toEqual([]);
});