@codelaw/rules-js 0.0.0-stage → 0.2.0

package/data/globals/worker.json

@@ -0,0 +1,349 @@
+{
+"AI": false,
+"AICreateMonitor": false,
+"AbortController": false,
+"AbortSignal": false,
+"AudioData": false,
+"AudioDecoder": false,
+"AudioEncoder": false,
+"BackgroundFetchManager": false,
+"BackgroundFetchRecord": false,
+"BackgroundFetchRegistration": false,
+"BarcodeDetector": false,
+"Blob": false,
+"BroadcastChannel": false,
+"ByteLengthQueuingStrategy": false,
+"CSSImageValue": false,
+"CSSKeywordValue": false,
+"CSSMathClamp": false,
+"CSSMathInvert": false,
+"CSSMathMax": false,
+"CSSMathMin": false,
+"CSSMathNegate": false,
+"CSSMathProduct": false,
+"CSSMathSum": false,
+"CSSMathValue": false,
+"CSSMatrixComponent": false,
+"CSSNumericArray": false,
+"CSSNumericValue": false,
+"CSSPerspective": false,
+"CSSRotate": false,
+"CSSScale": false,
+"CSSSkew": false,
+"CSSSkewX": false,
+"CSSSkewY": false,
+"CSSStyleValue": false,
+"CSSTransformComponent": false,
+"CSSTransformValue": false,
+"CSSTranslate": false,
+"CSSUnitValue": false,
+"CSSUnparsedValue": false,
+"CSSVariableReferenceValue": false,
+"Cache": false,
+"CacheStorage": false,
+"CanvasGradient": false,
+"CanvasPattern": false,
+"CloseEvent": false,
+"CompressionStream": false,
+"CountQueuingStrategy": false,
+"CreateMonitor": false,
+"CropTarget": false,
+"Crypto": false,
+"CryptoKey": false,
+"CustomEvent": false,
+"DOMException": false,
+"DOMMatrix": false,
+"DOMMatrixReadOnly": false,
+"DOMPoint": false,
+"DOMPointReadOnly": false,
+"DOMQuad": false,
+"DOMRect": false,
+"DOMRectReadOnly": false,
+"DOMStringList": false,
+"DecompressionStream": false,
+"DedicatedWorkerGlobalScope": false,
+"EncodedAudioChunk": false,
+"EncodedVideoChunk": false,
+"ErrorEvent": false,
+"Event": false,
+"EventSource": false,
+"EventTarget": false,
+"File": false,
+"FileList": false,
+"FileReader": false,
+"FileReaderSync": false,
+"FileSystemDirectoryHandle": false,
+"FileSystemFileHandle": false,
+"FileSystemHandle": false,
+"FileSystemObserver": false,
+"FileSystemSyncAccessHandle": false,
+"FileSystemWritableFileStream": false,
+"FontFace": false,
+"FontFaceSet": false,
+"FontFaceSetLoadEvent": false,
+"FormData": false,
+"GPU": false,
+"GPUAdapter": false,
+"GPUAdapterInfo": false,
+"GPUBindGroup": false,
+"GPUBindGroupLayout": false,
+"GPUBuffer": false,
+"GPUBufferUsage": false,
+"GPUCanvasContext": false,
+"GPUColorWrite": false,
+"GPUCommandBuffer": false,
+"GPUCommandEncoder": false,
+"GPUCompilationInfo": false,
+"GPUCompilationMessage": false,
+"GPUComputePassEncoder": false,
+"GPUComputePipeline": false,
+"GPUDevice": false,
+"GPUDeviceLostInfo": false,
+"GPUError": false,
+"GPUExternalTexture": false,
+"GPUInternalError": false,
+"GPUMapMode": false,
+"GPUOutOfMemoryError": false,
+"GPUPipelineError": false,
+"GPUPipelineLayout": false,
+"GPUQuerySet": false,
+"GPUQueue": false,
+"GPURenderBundle": false,
+"GPURenderBundleEncoder": false,
+"GPURenderPassEncoder": false,
+"GPURenderPipeline": false,
+"GPUSampler": false,
+"GPUShaderModule": false,
+"GPUShaderStage": false,
+"GPUSupportedFeatures": false,
+"GPUSupportedLimits": false,
+"GPUTexture": false,
+"GPUTextureUsage": false,
+"GPUTextureView": false,
+"GPUUncapturedErrorEvent": false,
+"GPUValidationError": false,
+"HID": false,
+"HIDConnectionEvent": false,
+"HIDDevice": false,
+"HIDInputReportEvent": false,
+"Headers": false,
+"IDBCursor": false,
+"IDBCursorWithValue": false,
+"IDBDatabase": false,
+"IDBFactory": false,
+"IDBIndex": false,
+"IDBKeyRange": false,
+"IDBObjectStore": false,
+"IDBOpenDBRequest": false,
+"IDBRecord": false,
+"IDBRequest": false,
+"IDBTransaction": false,
+"IDBVersionChangeEvent": false,
+"IdleDetector": false,
+"ImageBitmap": false,
+"ImageBitmapRenderingContext": false,
+"ImageData": false,
+"ImageDecoder": false,
+"ImageTrack": false,
+"ImageTrackList": false,
+"LanguageDetector": false,
+"Lock": false,
+"LockManager": false,
+"MediaCapabilities": false,
+"MediaSource": false,
+"MediaSourceHandle": false,
+"MessageChannel": false,
+"MessageEvent": false,
+"MessagePort": false,
+"NavigationPreloadManager": false,
+"NavigatorUAData": false,
+"NetworkInformation": false,
+"Notification": false,
+"Observable": false,
+"OffscreenCanvas": false,
+"OffscreenCanvasRenderingContext2D": false,
+"Origin": false,
+"PERSISTENT": false,
+"Path2D": false,
+"Performance": false,
+"PerformanceEntry": false,
+"PerformanceMark": false,
+"PerformanceMeasure": false,
+"PerformanceObserver": false,
+"PerformanceObserverEntryList": false,
+"PerformanceResourceTiming": false,
+"PerformanceServerTiming": false,
+"PeriodicSyncManager": false,
+"PermissionStatus": false,
+"Permissions": false,
+"PressureObserver": false,
+"PressureRecord": false,
+"ProgressEvent": false,
+"PromiseRejectionEvent": false,
+"PushManager": false,
+"PushSubscription": false,
+"PushSubscriptionOptions": false,
+"QuotaExceededError": false,
+"RTCDataChannel": false,
+"RTCEncodedAudioFrame": false,
+"RTCEncodedVideoFrame": false,
+"RTCError": false,
+"RTCErrorEvent": false,
+"RTCRtpScriptTransformer": false,
+"RTCTransformEvent": false,
+"ReadableByteStreamController": false,
+"ReadableStream": false,
+"ReadableStreamBYOBReader": false,
+"ReadableStreamBYOBRequest": false,
+"ReadableStreamDefaultController": false,
+"ReadableStreamDefaultReader": false,
+"ReportBody": false,
+"ReportingObserver": false,
+"Request": false,
+"Response": false,
+"RestrictionTarget": false,
+"Scheduler": false,
+"SecurityPolicyViolationEvent": false,
+"Serial": false,
+"SerialPort": false,
+"ServiceWorker": false,
+"ServiceWorkerContainer": false,
+"ServiceWorkerRegistration": false,
+"SourceBuffer": false,
+"SourceBufferList": false,
+"StorageBucket": false,
+"StorageBucketManager": false,
+"StorageManager": false,
+"StylePropertyMapReadOnly": false,
+"Subscriber": false,
+"SubtleCrypto": false,
+"SyncManager": false,
+"TEMPORARY": false,
+"TaskController": false,
+"TaskPriorityChangeEvent": false,
+"TaskSignal": false,
+"Temporal": false,
+"TextDecoder": false,
+"TextDecoderStream": false,
+"TextEncoder": false,
+"TextEncoderStream": false,
+"TextMetrics": false,
+"TransformStream": false,
+"TransformStreamDefaultController": false,
+"TrustedHTML": false,
+"TrustedScript": false,
+"TrustedScriptURL": false,
+"TrustedTypePolicy": false,
+"TrustedTypePolicyFactory": false,
+"URL": false,
+"URLPattern": false,
+"URLSearchParams": false,
+"USB": false,
+"USBAlternateInterface": false,
+"USBConfiguration": false,
+"USBConnectionEvent": false,
+"USBDevice": false,
+"USBEndpoint": false,
+"USBInTransferResult": false,
+"USBInterface": false,
+"USBIsochronousInTransferPacket": false,
+"USBIsochronousInTransferResult": false,
+"USBIsochronousOutTransferPacket": false,
+"USBIsochronousOutTransferResult": false,
+"USBOutTransferResult": false,
+"UserActivation": false,
+"VideoColorSpace": false,
+"VideoDecoder": false,
+"VideoEncoder": false,
+"VideoFrame": false,
+"WGSLLanguageFeatures": false,
+"WebAssembly": false,
+"WebGL2RenderingContext": false,
+"WebGLActiveInfo": false,
+"WebGLBuffer": false,
+"WebGLContextEvent": false,
+"WebGLFramebuffer": false,
+"WebGLObject": false,
+"WebGLProgram": false,
+"WebGLQuery": false,
+"WebGLRenderbuffer": false,
+"WebGLRenderingContext": false,
+"WebGLSampler": false,
+"WebGLShader": false,
+"WebGLShaderPrecisionFormat": false,
+"WebGLSync": false,
+"WebGLTexture": false,
+"WebGLTransformFeedback": false,
+"WebGLUniformLocation": false,
+"WebGLVertexArrayObject": false,
+"WebSocket": false,
+"WebSocketError": false,
+"WebSocketStream": false,
+"WebTransport": false,
+"WebTransportBidirectionalStream": false,
+"WebTransportDatagramDuplexStream": false,
+"WebTransportDatagramsWritable": false,
+"WebTransportError": false,
+"WebTransportReceiveStream": false,
+"WebTransportSendGroup": false,
+"WebTransportSendStream": false,
+"Worker": false,
+"WorkerGlobalScope": false,
+"WorkerLocation": false,
+"WorkerNavigator": false,
+"WritableStream": false,
+"WritableStreamDefaultController": false,
+"WritableStreamDefaultWriter": false,
+"XMLHttpRequest": false,
+"XMLHttpRequestEventTarget": false,
+"XMLHttpRequestUpload": false,
+"addEventListener": false,
+"ai": false,
+"atob": false,
+"btoa": false,
+"caches": false,
+"cancelAnimationFrame": false,
+"clearInterval": false,
+"clearTimeout": false,
+"close": false,
+"console": false,
+"createImageBitmap": false,
+"crossOriginIsolated": false,
+"crypto": false,
+"dispatchEvent": false,
+"fetch": false,
+"fonts": false,
+"importScripts": false,
+"indexedDB": false,
+"isSecureContext": false,
+"location": false,
+"name": false,
+"navigator": false,
+"onerror": true,
+"onlanguagechange": true,
+"onmessage": true,
+"onmessageerror": true,
+"onoffline": true,
+"ononline": true,
+"onrejectionhandled": true,
+"onrtctransform": true,
+"onunhandledrejection": true,
+"origin": false,
+"performance": false,
+"postMessage": false,
+"queueMicrotask": false,
+"removeEventListener": false,
+"reportError": false,
+"requestAnimationFrame": false,
+"scheduler": false,
+"self": false,
+"setInterval": false,
+"setTimeout": false,
+"structuredClone": false,
+"trustedTypes": false,
+"webkitRequestFileSystem": false,
+"webkitRequestFileSystemSync": false,
+"webkitResolveLocalFileSystemSyncURL": false,
+"webkitResolveLocalFileSystemURL": false,
+"when": false
+}

package/package.json

@@ -1,6 +1,16 @@
 {
   "name": "@codelaw/rules-js",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "codelaw's rules for JavaScript, and the core JavaScript rules on TypeScript, JSX and TSX (SR-RULE-PACKS)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arpitarya/codelaw.git"
+  },
+  "homepage": "https://github.com/arpitarya/codelaw",
+  "keywords": [
+    "codelaw",
+    "codelaw-pack",
+    "lint-rules"
+  ]
+}

package/presets/js/conventions.toml

@@ -0,0 +1,6 @@
+description = "House conventions from codelaw's starter catalogue; opt in"
+
+[rules]
+"js/exports-at-end" = "error"
+"js/import-groups" = "error"
+"js/no-default-export" = "error"

package/presets/js/project.toml

@@ -0,0 +1,4 @@
+description = "The rule that reads the whole repo: exports nothing imports (knip's exports and types); opt in"
+
+[rules]
+"graph/no-unused-exports" = "error"

package/presets/js/recommended.toml

@@ -0,0 +1,67 @@
+description = "The correctness core of ESLint's recommended preset (@eslint/js 10.0.1), reimplemented"
+
+[rules]
+"js/constructor-super" = "error"
+"js/for-direction" = "error"
+"js/getter-return" = "error"
+"js/no-async-promise-executor" = "error"
+"js/no-case-declarations" = "error"
+"js/no-class-assign" = "error"
+"js/no-compare-neg-zero" = "error"
+"js/no-cond-assign" = "error"
+"js/no-const-assign" = "error"
+"js/no-constant-binary-expression" = "error"
+"js/no-constant-condition" = "error"
+"js/no-control-regex" = "error"
+"js/no-debugger" = "error"
+"js/no-delete-var" = "error"
+"js/no-dupe-args" = "error"
+"js/no-dupe-class-members" = "error"
+"js/no-dupe-else-if" = "error"
+"js/no-dupe-keys" = "error"
+"js/no-duplicate-case" = "error"
+"js/no-empty" = "error"
+"js/no-empty-character-class" = "error"
+"js/no-empty-pattern" = "error"
+"js/no-empty-static-block" = "error"
+"js/no-ex-assign" = "error"
+"js/no-extra-boolean-cast" = "error"
+"js/no-fallthrough" = "error"
+"js/no-func-assign" = "error"
+"js/no-global-assign" = "error"
+"js/no-import-assign" = "error"
+"js/no-invalid-regexp" = "error"
+"js/no-irregular-whitespace" = "error"
+"js/no-loss-of-precision" = "error"
+"js/no-misleading-character-class" = "error"
+"js/no-new-native-nonconstructor" = "error"
+"js/no-nonoctal-decimal-escape" = "error"
+"js/no-obj-calls" = "error"
+"js/no-octal" = "error"
+"js/no-prototype-builtins" = "error"
+"js/no-redeclare" = "error"
+"js/no-regex-spaces" = "error"
+"js/no-self-assign" = "error"
+"js/no-setter-return" = "error"
+"js/no-shadow-restricted-names" = "error"
+"js/no-sparse-arrays" = "error"
+"js/no-this-before-super" = "error"
+"js/no-unassigned-vars" = "error"
+"js/no-undef" = "error"
+"js/no-unexpected-multiline" = "error"
+"js/no-unreachable" = "error"
+"js/no-unsafe-finally" = "error"
+"js/no-unsafe-negation" = "error"
+"js/no-unsafe-optional-chaining" = "error"
+"js/no-unused-labels" = "error"
+"js/no-unused-private-class-members" = "error"
+"js/no-unused-vars" = "error"
+"js/no-useless-assignment" = "error"
+"js/no-useless-backreference" = "error"
+"js/no-useless-catch" = "error"
+"js/no-useless-escape" = "error"
+"js/no-with" = "error"
+"js/preserve-caught-error" = "error"
+"js/require-yield" = "error"
+"js/use-isnan" = "error"
+"js/valid-typeof" = "error"

package/presets/js/typescript.toml

@@ -0,0 +1,7 @@
+description = "The four core rules typescript-eslint's eslint-recommended switches on for TypeScript (8.71.2); use with codelaw:ts/recommended"
+
+[rules]
+"js/no-var" = "error"
+"js/prefer-const" = "error"
+"js/prefer-rest-params" = "error"
+"js/prefer-spread" = "error"

package/rules/graph/no-unused-exports.md

@@ -0,0 +1,135 @@
+---
+id: graph/no-unused-exports
+title: Exported symbols must be used somewhere
+languages: [javascript, jsx, typescript, tsx]
+scope: project
+severity: error
+fix: suggest
+fix_reason: "Static analysis can't rule out reflective or external use, so removal needs a human or agent to accept the diff."
+stability: preview
+ported_from: [knip/exports, knip/types]
+since: 0.1.0
+---
+
+Every exported symbol is imported by another module, is reachable from an entry point, or is marked `@public` / `@keep`.
+
+**Why:** an export nothing imports is dead code that still looks like API: readers keep it, refactors carry it, and it hides what a module is really for.
+
+```codelaw
+graph:
+  symbol:
+    exported: true
+    kind: [function, class, variable, type, interface, enum]
+  unless:
+    - reachable_from: entry
+    - tagged: [public, keep]
+  when:
+    external_references: 0
+  certainty_from: module.dynamic
+message: "`$SYMBOL` is exported but never used outside `$FILE`"
+fix:
+  - when: { local_references: ">0" }
+    do: [strip-export-keyword]
+  - else:
+    do: [remove-declaration]
+```
+
+## How to fix
+
+1. Run `codelaw graph why-unused <symbol>` (`<file>#<export>` or `<module>:<name>`) to see each entry, keep and import clause.
+2. If something outside the repo uses it, add the file to `[graph] entry` or `[graph] keep`, add its decorator to `[graph] registrars`, or tag it `/** @public */` / `# codelaw: keep`.
+3. Otherwise delete the declaration (and its `__all__` or `export { … }` entry), or drop `export` if its own file still uses it.
+
+## Examples
+
+### JavaScript
+
+#### Don't
+
+```js files
+// src/date.js
+export function formatDate(d) { return d.toISOString(); }
+export function parseDate(s) { return new Date(s); }
+// src/app.js
+import { formatDate } from "./date";
+console.log(formatDate(new Date()));
+```
+
+#### Do
+
+```js files
+// src/date.js
+export function formatDate(d) { return d.toISOString(); }
+// src/app.js
+import { formatDate } from "./date";
+console.log(formatDate(new Date()));
+```
+
+### JSX
+
+#### Don't
+
+```jsx files
+// src/Button.jsx
+export function Button() { return <button />; }
+export function Unused() { return <span />; }
+// src/App.jsx
+import { Button } from "./Button";
+console.log(<Button />);
+```
+
+#### Do
+
+```jsx files
+// src/Button.jsx
+export function Button() { return <button />; }
+// src/App.jsx
+import { Button } from "./Button";
+console.log(<Button />);
+```
+
+### TypeScript
+
+#### Don't
+
+```ts files
+// packages/utils/src/date.ts
+export function formatDate(d: Date) { return d.toISOString(); }
+export function parseDate(s: string) { return new Date(s); }
+// packages/web/src/app.ts
+import { formatDate } from "../../utils/src/date";
+console.log(formatDate(new Date()));
+```
+
+#### Do
+
+```ts files
+// packages/utils/src/date.ts
+export function formatDate(d: Date) { return d.toISOString(); }
+// packages/web/src/app.ts
+import { formatDate } from "../../utils/src/date";
+console.log(formatDate(new Date()));
+```
+
+### TSX
+
+#### Don't
+
+```tsx files
+// src/theme.tsx
+export const theme = { dark: false };
+export const unusedTheme = { dark: true };
+// src/main.tsx
+import { theme } from "./theme";
+console.log(theme);
+```
+
+#### Do
+
+```tsx files
+// src/theme.tsx
+export const theme = { dark: false };
+// src/main.tsx
+import { theme } from "./theme";
+console.log(theme);
+```

package/rules/js/constructor-super.md

@@ -0,0 +1,77 @@
+---
+id: js/constructor-super
+title: "A derived class's constructor calls super(); a base class's does not"
+languages: [javascript, jsx]
+fix: manual
+fix_reason: "what `super()` must receive depends on the base class"
+stability: preview
+ported_from: [eslint/constructor-super]
+since: 0.1.0
+---
+
+A class that extends another must call `super()` in its constructor before it returns, and a class
+that extends nothing must not call `super()` at all.
+
+**Why:** Without `super()` the instance is never initialised and the constructor throws; in a base
+class `super()` is a syntax error.
+
+```codelaw
+native: js/constructor-super
+```
+
+## How to fix
+
+1. In a class with `extends`, call `super(...)` with the arguments the base class expects, before any use of `this`.
+2. In a class without `extends`, remove the `super()` call.
+
+## Examples
+
+### JavaScript
+
+#### Don't
+
+```js
+class Cat extends Animal {
+  constructor() {
+    this.lives = 9;
+  }
+}
+```
+
+#### Do
+
+```js
+class Cat extends Animal {
+  constructor() {
+    super();
+    this.lives = 9;
+  }
+}
+```
+
+### JSX
+
+#### Don't
+
+```jsx
+class Cat extends Animal {
+  constructor() {
+    this.lives = 9;
+  }
+}
+```
+
+#### Do
+
+```jsx
+class Cat extends Animal {
+  constructor() {
+    super();
+    this.lives = 9;
+  }
+}
+```
+
+## Differences from the source
+
+Paths are followed in straight-line order: a `super()` on any branch counts as called.