@codelaw/rules-js 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2026 Arpit Arya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+SPDX-License-Identifier: MIT

package/NOTICE

@@ -0,0 +1,10 @@
+@codelaw/rules-js / codelaw-rules-js
+
+data/globals/*.json are derived from the `globals` package, version 17.13.0,
+https://github.com/sindresorhus/globals — Copyright (c) Sindre Sorhus
+<sindresorhus@gmail.com> (https://sindresorhus.com), released under the MIT
+License.
+
+The rules are reimplementations written for codelaw. Their `ported_from:`
+fields name the ESLint rules (https://eslint.org, MIT License) whose documented
+behaviour they reproduce; no ESLint code or documentation text is included.

package/README.md

@@ -1,3 +1,58 @@
-# Temporary Holding Version
+# @codelaw/rules-js · codelaw-rules-js
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+codelaw's core JavaScript rules, which also run on TypeScript, JSX and TSX — one of codelaw's first-party rule packs
+([SR-RULE-PACKS](../../records/0101_rule-packs.md)). The
+same files ship on npm as `@codelaw/rules-js` and on PyPI as `codelaw-rules-js`.
+
+```toml
+# codelaw.toml
+extends = ["codelaw:js/recommended"]
+preview = true   # every rule is `preview` until a corpus run promotes it
+```
+
+## Presets
+
+<!-- docs-sync:presets -->
+
+| preset | rules | ported from |
+|---|---|---|
+| `js/recommended` | 64 | ESLint `js.configs.recommended`, `@eslint/js` 10.0.1 — all 64 rules |
+| `js/typescript` | 4 | the four core rules typescript-eslint 8.71.2's `eslint-recommended` switches on for TypeScript: `js/no-var`, `js/prefer-const`, `js/prefer-rest-params`, `js/prefer-spread`; use it with `codelaw:ts/recommended` |
+| `js/conventions` | 3 | codelaw's starter catalogue: `js/exports-at-end`, `js/import-groups`, `js/no-default-export` — opt in |
+| `js/project` | 1 | `graph/no-unused-exports`, the rule that reads the whole repo, from knip's `exports` and `types` — opt in |
+
+<!-- /docs-sync:presets -->
+
+Rules that typescript-eslint's `eslint-recommended` switches off for TypeScript
+(`no-undef`, `no-redeclare`, `no-dupe-class-members` and the rest, which the
+compiler checks) declare only `javascript` and `jsx` here. The four rules in
+`js/typescript` declare all four languages, so they also run on JavaScript
+files when that preset is on.
+
+Every rule is **reimplemented**, not vendored: the matchers, messages and docs
+are written fresh, and each rule's `ported_from:` names the source rule.
+
+## How the ports differ
+
+Every rule matches its source's documented behaviour on the source's own
+examples. Where codelaw differs, the rule's `## Differences from the source`
+section says so. The larger ones:
+
+| rule | difference |
+|---|---|
+| `js/constructor-super`, `js/no-this-before-super` | follow the constructor's statements in straight-line order; a `super()` on any branch counts |
+| `js/no-constant-condition` | literal conditions only; ESLint also folds `typeof x`, `!1` and similar |
+| `js/no-extra-boolean-cast` | `!!x` in a condition; `Boolean(x)` in a condition is not checked yet |
+| `js/no-invalid-regexp` | structural problems only (brackets, groups, quantifiers, flags) |
+| `js/no-useless-assignment` | dead stores a straight-line reading proves; ESLint follows every code path |
+| `js/no-useless-escape` | strings and templates; escapes inside regular expressions are not checked yet |
+| `js/no-undef` | environments come from the `env` option (`shared-node-browser` by default), using the `globals` data tables |
+| `js/prefer-spread` | only `f.apply(null, args)` on a plain function name |
+| `js/no-var` | `suggest`, not `auto`: `let` is block-scoped, so the swap can change meaning |
+
+Nothing from `js.configs.recommended` is left out.
+
+## Data
+
+`data/globals/*.json` — the globals of each environment `js/no-undef`'s `env`
+option names, from the `globals` package 17.13.0 (MIT). See `NOTICE`.

package/codelaw-pack.toml

@@ -0,0 +1,6 @@
+name = "@codelaw/rules-js"
+version = "0.2.0"
+min_codelaw = "0.1.0"
+languages = ["javascript", "jsx", "typescript", "tsx"]
+presets = ["js/recommended", "js/typescript", "js/conventions", "js/project"]
+description = "codelaw's rules for JavaScript, and the core JavaScript rules on TypeScript, JSX and TSX (SR-RULE-PACKS)"

package/corpus.toml

@@ -0,0 +1,76 @@
+# `codelaw test --corpus` finding counts (SR-RULE-AUTHORING decision 4).
+# Rewrite with --update-snapshot, and review the change.
+
+[findings]
+"graph/no-unused-exports" = 118
+"js/constructor-super" = 0
+"js/exports-at-end" = 436
+"js/for-direction" = 0
+"js/getter-return" = 0
+"js/import-groups" = 76
+"js/no-async-promise-executor" = 0
+"js/no-case-declarations" = 0
+"js/no-class-assign" = 0
+"js/no-compare-neg-zero" = 0
+"js/no-cond-assign" = 0
+"js/no-const-assign" = 0
+"js/no-constant-binary-expression" = 0
+"js/no-constant-condition" = 0
+"js/no-control-regex" = 0
+"js/no-debugger" = 0
+"js/no-default-export" = 61
+"js/no-delete-var" = 0
+"js/no-dupe-args" = 0
+"js/no-dupe-class-members" = 0
+"js/no-dupe-else-if" = 0
+"js/no-dupe-keys" = 0
+"js/no-duplicate-case" = 0
+"js/no-empty" = 0
+"js/no-empty-character-class" = 0
+"js/no-empty-pattern" = 0
+"js/no-empty-static-block" = 0
+"js/no-ex-assign" = 0
+"js/no-extra-boolean-cast" = 0
+"js/no-fallthrough" = 0
+"js/no-func-assign" = 0
+"js/no-global-assign" = 0
+"js/no-import-assign" = 0
+"js/no-invalid-regexp" = 0
+"js/no-irregular-whitespace" = 0
+"js/no-loss-of-precision" = 0
+"js/no-misleading-character-class" = 0
+"js/no-new-native-nonconstructor" = 0
+"js/no-nonoctal-decimal-escape" = 0
+"js/no-obj-calls" = 0
+"js/no-octal" = 0
+"js/no-prototype-builtins" = 0
+"js/no-redeclare" = 0
+"js/no-regex-spaces" = 0
+"js/no-self-assign" = 0
+"js/no-setter-return" = 0
+"js/no-shadow-restricted-names" = 0
+"js/no-sparse-arrays" = 0
+"js/no-this-before-super" = 0
+"js/no-unassigned-vars" = 0
+"js/no-undef" = 61
+"js/no-unexpected-multiline" = 0
+"js/no-unreachable" = 0
+"js/no-unsafe-finally" = 0
+"js/no-unsafe-negation" = 0
+"js/no-unsafe-optional-chaining" = 0
+"js/no-unused-labels" = 0
+"js/no-unused-private-class-members" = 0
+"js/no-unused-vars" = 2
+"js/no-useless-assignment" = 14
+"js/no-useless-backreference" = 0
+"js/no-useless-catch" = 0
+"js/no-useless-escape" = 0
+"js/no-var" = 0
+"js/no-with" = 0
+"js/prefer-const" = 0
+"js/prefer-rest-params" = 0
+"js/prefer-spread" = 0
+"js/preserve-caught-error" = 0
+"js/require-yield" = 0
+"js/use-isnan" = 0
+"js/valid-typeof" = 0