@codelaw/rules-ts 0.0.0-stage → 0.2.0

package/rules/ts/triple-slash-reference.md

@@ -0,0 +1,60 @@
+---
+id: ts/triple-slash-reference
+title: "No /// <reference path> directives"
+languages: [typescript, tsx]
+fix: manual
+fix_reason: "the matching import needs the module path and what it provides"
+stability: preview
+ported_from: [typescript-eslint/triple-slash-reference]
+since: 0.1.0
+---
+
+Files are connected with `import`, not `/// <reference path="…" />`.
+
+**Why:** Reference directives predate ES modules and hide dependencies from bundlers and other
+tools.
+
+```codelaw
+match:
+  kind: comment
+  regex: ^///\s*<reference\s+path=
+message: "Use an `import` instead of a `/// <reference path>` directive"
+```
+
+## How to fix
+
+1. Replace the directive with an `import` of the module it pointed to.
+
+## Examples
+
+### TypeScript
+
+#### Don't
+
+```ts
+/// <reference path="./globals.d.ts" />
+export const x = 1;
+```
+
+#### Do
+
+```ts
+import "./globals";
+export const x = 1;
+```
+
+### TSX
+
+#### Don't
+
+```tsx
+/// <reference path="./globals.d.ts" />
+export const x = 1;
+```
+
+#### Do
+
+```tsx
+import "./globals";
+export const x = 1;
+```

package/rules/ts/type-only-imports.md

@@ -0,0 +1,57 @@
+---
+id: ts/type-only-imports
+title: "Names used only as types are imported with type"
+languages: [typescript, tsx]
+fix: suggest
+fix_reason: "a type-only import is erased, so code that relied on the module's side effects changes"
+stability: preview
+since: 0.1.0
+---
+
+An imported name that the file uses only in type positions is marked `type`.
+
+**Why:** Type-only imports are erased at compile time, which keeps runtime imports honest and helps
+bundlers drop unused modules.
+
+```codelaw
+native: ts/type-only-imports
+```
+
+## Examples
+
+### TypeScript
+
+#### Don't
+
+```ts
+import { Config, load } from "./config";
+export const c: Config = load();
+```
+
+#### Do
+
+```ts
+import { type Config, load } from "./config";
+export const c: Config = load();
+```
+
+### TSX
+
+#### Don't
+
+```tsx
+import { Config, load } from "./config";
+export const c: Config = load();
+```
+
+#### Do
+
+```tsx
+import { type Config, load } from "./config";
+export const c: Config = load();
+```
+
+## Differences from the source
+
+Only within the file, without type information: a name used as a value anywhere is left alone.
+Default and namespace imports are reported without a fix.