@codelaw/rules-js 0.1.0 → 0.2.0

package/NOTICE

@@ -5,15 +5,6 @@ https://github.com/sindresorhus/globals — Copyright (c) Sindre Sorhus
 <sindresorhus@gmail.com> (https://sindresorhus.com), released under the MIT
 License.
 
-data/node/deprecated-api.json was written for this pack: the Node.js APIs that
-the Node.js documentation deprecates (https://nodejs.org/api/deprecations.html),
-each with its documented replacement, in codelaw's own words. No text or code
-is copied from Node.js.
-
-data/react/dom-property-aliases.json was written for this pack: HTML attribute
-names and the React DOM prop names that replace them (`class` -> `className`),
-as React documents them. No React code is included.
-
 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,9 +1,8 @@
 # @codelaw/rules-js · codelaw-rules-js
 
-codelaw's rules for JavaScript, TypeScript, JSX and TSX — one of the five
-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`.
+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
@@ -13,20 +12,22 @@ 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 |
-| `ts/recommended` | 24 | typescript-eslint `recommended` 8.71.2 (not type-checked) — all 20 rules — plus the four core rules its `eslint-recommended` switches on for TypeScript: `js/no-var`, `js/prefer-const`, `js/prefer-rest-params`, `js/prefer-spread` |
-| `react/recommended` | 19 | eslint-plugin-react 7.37.5 `recommended` + `jsx-runtime` (17 of its 20 active rules), and eslint-plugin-react-hooks 7.1.1's `rules-of-hooks` and `exhaustive-deps` |
-| `node/recommended` | 10 | eslint-plugin-n 18.5.0 `recommended-module` — 10 of its 14 rules: the 3 that need no `package.json`, `node/hashbang`, which reads the nearest `package.json`'s `bin`, and the 6 import rules, which run on the project graph |
-| `stencil/recommended` | 15 | @stencil/eslint-plugin 1.4.0 `recommended` — 15 of its 21 rules |
-| `js/conventions` | 7 | codelaw's starter catalogue: `js/exports-at-end`, `js/import-groups`, `js/no-default-export`, `ts/type-only-imports`, `react/hook-prefix`, `react/props-type-name`, `stencil/tag-prefix` — opt in |
+| `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 core rules
-`ts/recommended` adds declare all four languages, so they also run on
-JavaScript files when that preset is on.
+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.
@@ -46,46 +47,12 @@ section says so. The larger ones:
 | `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 |
-| `ts/no-unused-expressions` | `x satisfies T;` is a compile-time type test and is allowed |
 | `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 |
-| `react/jsx-key` | elements returned from a `.map()` callback's block body are not checked yet |
-| `react/no-unknown-property` | renames HTML spellings (`class`, `onclick`, `tabindex`); in `.js`/`.jsx` the JavaScript grammar can't parse `class=` and `for=` |
-| `react/exhaustive-deps` | dependencies compared by root name; setters, dispatchers and refs are stable |
-| `react/rules-of-hooks` | an early `return` anywhere before a hook counts as making it conditional |
-| `node/no-deprecated-api` | the APIs come from the pack's `node/deprecated-api` table; the supported Node.js version is not read |
-| `node/no-missing-import`, `node/no-missing-require` | `scope: project` rules on the project graph, which never reads `node_modules`: only the project's own paths are judged (relative, absolute, tsconfig `paths`), and only extensionless or JavaScript/TypeScript ones; a package name is not looked up |
-| `node/no-extraneous-import`, `node/no-extraneous-require` | the nearest `package.json` only; a type-only import is satisfied by its `@types/` package |
-| `node/no-unpublished-import`, `node/no-unpublished-require` | only in a package that is not `private` and lists `files`; `.npmignore` and the `convertPath` option are not read, so source files that build into `files` are not judged |
-| `node/hashbang` | JavaScript and JSX only (no `convertPath` for TypeScript sources); `suggest`, since removing a hashbang can stop a script that is run directly |
-| `stencil/tag-prefix` | with no `prefix` option set, a tag only needs some prefix |
-| `stencil/prop-readonly` | the starter id for upstream `props-must-be-readonly` |
-
-## Not ported, and why
-
-| rule | why |
-|---|---|
-| `react/prop-types` | needs the component's declared prop types matched to its uses; TypeScript types do this job |
-| `react/jsx-uses-vars` | marks JSX names as used for `no-unused-vars`; codelaw's semantic model already counts them |
-| `react/react-in-jsx-scope`, `react/jsx-uses-react` | turned off by `jsx-runtime` |
-| eslint-plugin-react-hooks' 14 React Compiler rules | need the React Compiler's analysis |
-| `node/no-unsupported-features/es-builtins`, `/es-syntax`, `/node-builtins` | need the project's Node.js version from `package.json` and per-version feature tables |
-| `node/process-exit-as-throw` | reports nothing; it only changes ESLint's code-path analysis |
-| `stencil/async-methods`, `stencil/render-returns-host`, `stencil/single-export`, `stencil/strict-boolean-conditions` | need type information |
-| `stencil/element-type` | needs the component's tag mapped to its element type name |
-| `stencil/decorators-style` | layout: the formatter owns it |
-| `stencil/dependency-suggestions` | advisory, with no fixed check to port |
 
-Nothing from `js.configs.recommended` or typescript-eslint's non-type-checked
-`recommended` is left out. Every `*-type-checked` typescript-eslint config is
-out of scope: those rules need type information (L3).
+Nothing from `js.configs.recommended` is left out.
 
 ## Data
 
-`data/node/deprecated-api.json` — Node.js APIs the Node.js documentation deprecates, with their replacements, written for this pack.
-
-`data/react/dom-property-aliases.json` — HTML attribute names and the React prop names that replace them, written for this pack.
-
-
 `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

@@ -1,6 +1,6 @@
 name = "@codelaw/rules-js"
-version = "0.1.0"
+version = "0.2.0"
 min_codelaw = "0.1.0"
 languages = ["javascript", "jsx", "typescript", "tsx"]
-presets = ["js/recommended", "ts/recommended", "react/recommended", "node/recommended", "stencil/recommended", "js/conventions"]
-description = "codelaw's rules for JavaScript, TypeScript, JSX and TSX (SR-RULE-PACKS)"
+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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codelaw/rules-js",
-  "version": "0.1.0",
-  "description": "codelaw's rules for JavaScript, TypeScript, JSX and TSX (SR-RULE-PACKS)",
+  "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",

package/presets/js/conventions.toml

@@ -4,7 +4,3 @@ description = "House conventions from codelaw's starter catalogue; opt in"
 "js/exports-at-end" = "error"
 "js/import-groups" = "error"
 "js/no-default-export" = "error"
-"ts/type-only-imports" = "error"
-"react/hook-prefix" = "error"
-"react/props-type-name" = "error"
-"stencil/tag-prefix" = "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/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/data/node/deprecated-api.json

@@ -1,83 +0,0 @@
-{
- "buffer": {
-  "Buffer": "the global `Buffer` with `Buffer.from()` or `Buffer.alloc()`",
-  "SlowBuffer": "`Buffer.allocUnsafeSlow()`"
- },
- "constants": {
-  "*": "`fs.constants` or `os.constants`"
- },
- "crypto": {
-  "Credentials": "`tls.SecureContext`",
-  "DEFAULT_ENCODING": "an explicit encoding argument",
-  "createCipher": "`crypto.createCipheriv()`",
-  "createDecipher": "`crypto.createDecipheriv()`",
-  "fips": "`crypto.getFips()` / `crypto.setFips()`",
-  "prng": "`crypto.randomBytes()`",
-  "pseudoRandomBytes": "`crypto.randomBytes()`",
-  "rng": "`crypto.randomBytes()`"
- },
- "domain": {
-  "*": "`async_hooks` (`AsyncLocalStorage`) or explicit error handling"
- },
- "events": {
-  "listenerCount": "`emitter.listenerCount()`"
- },
- "fs": {
-  "SyncWriteStream": "a `fs.WriteStream`",
-  "exists": "`fs.stat()` or `fs.access()`",
-  "lchmod": "`fs.chmod()`",
-  "lchmodSync": "`fs.chmodSync()`"
- },
- "globals": {
-  "Buffer": "`Buffer.from()`, `Buffer.alloc()` or `Buffer.allocUnsafe()`"
- },
- "module": {
-  "_debug": "`util.debuglog()`",
-  "createRequireFromPath": "`module.createRequire()`"
- },
- "os": {
-  "getNetworkInterfaces": "`os.networkInterfaces()`",
-  "tmpDir": "`os.tmpdir()`"
- },
- "path": {
-  "_makeLong": "`path.toNamespacedPath()`"
- },
- "punycode": {
-  "*": "the `punycode` package from npm, or `url.domainToASCII()`"
- },
- "sys": {
-  "*": "`util`"
- },
- "tls": {
-  "SecurePair": "`tls.TLSSocket`",
-  "createSecurePair": "`tls.TLSSocket`"
- },
- "url": {
-  "parse": "the WHATWG `new URL()`",
-  "resolve": "`new URL(input, base)`"
- },
- "util": {
-  "_extend": "`Object.assign()`",
-  "debug": "`util.debuglog()`",
-  "error": "`console.error()`",
-  "isArray": "`Array.isArray()`",
-  "isBoolean": "`typeof value === \"boolean\"`",
-  "isBuffer": "`Buffer.isBuffer()`",
-  "isDate": "`value instanceof Date`",
-  "isError": "`value instanceof Error`",
-  "isFunction": "`typeof value === \"function\"`",
-  "isNull": "`value === null`",
-  "isNullOrUndefined": "`value == null`",
-  "isNumber": "`typeof value === \"number\"`",
-  "isObject": "`value !== null && typeof value === \"object\"`",
-  "isPrimitive": "a `typeof` check",
-  "isRegExp": "`value instanceof RegExp`",
-  "isString": "`typeof value === \"string\"`",
-  "isSymbol": "`typeof value === \"symbol\"`",
-  "isUndefined": "`value === undefined`",
-  "log": "`console.log()`",
-  "print": "`console.log()`",
-  "pump": "`stream.pipeline()`",
-  "puts": "`console.log()`"
- }
-}

package/data/react/dom-property-aliases.json

@@ -1,131 +0,0 @@
-{
-"accept-charset": "acceptCharset",
-"accesskey": "accessKey",
-"autocapitalize": "autoCapitalize",
-"autocomplete": "autoComplete",
-"autofocus": "autoFocus",
-"autoplay": "autoPlay",
-"cellpadding": "cellPadding",
-"cellspacing": "cellSpacing",
-"charset": "charSet",
-"class": "className",
-"colspan": "colSpan",
-"contenteditable": "contentEditable",
-"crossorigin": "crossOrigin",
-"datetime": "dateTime",
-"enctype": "encType",
-"enterkeyhint": "enterKeyHint",
-"fetchpriority": "fetchPriority",
-"for": "htmlFor",
-"formaction": "formAction",
-"formenctype": "formEncType",
-"formmethod": "formMethod",
-"formnovalidate": "formNoValidate",
-"formtarget": "formTarget",
-"frameborder": "frameBorder",
-"hreflang": "hrefLang",
-"http-equiv": "httpEquiv",
-"inputmode": "inputMode",
-"itemprop": "itemProp",
-"itemscope": "itemScope",
-"itemtype": "itemType",
-"marginheight": "marginHeight",
-"marginwidth": "marginWidth",
-"maxlength": "maxLength",
-"minlength": "minLength",
-"nomodule": "noModule",
-"novalidate": "noValidate",
-"onabort": "onAbort",
-"onanimationend": "onAnimationEnd",
-"onanimationiteration": "onAnimationIteration",
-"onanimationstart": "onAnimationStart",
-"onauxclick": "onAuxClick",
-"onbeforeinput": "onBeforeInput",
-"onblur": "onBlur",
-"oncancel": "onCancel",
-"oncanplay": "onCanPlay",
-"oncanplaythrough": "onCanPlayThrough",
-"onchange": "onChange",
-"onclick": "onClick",
-"onclose": "onClose",
-"oncompositionend": "onCompositionEnd",
-"oncompositionstart": "onCompositionStart",
-"oncompositionupdate": "onCompositionUpdate",
-"oncontextmenu": "onContextMenu",
-"oncopy": "onCopy",
-"oncut": "onCut",
-"ondblclick": "onDoubleClick",
-"ondrag": "onDrag",
-"ondragend": "onDragEnd",
-"ondragenter": "onDragEnter",
-"ondragleave": "onDragLeave",
-"ondragover": "onDragOver",
-"ondragstart": "onDragStart",
-"ondrop": "onDrop",
-"ondurationchange": "onDurationChange",
-"onemptied": "onEmptied",
-"onended": "onEnded",
-"onerror": "onError",
-"onfocus": "onFocus",
-"ongotpointercapture": "onGotPointerCapture",
-"oninput": "onInput",
-"oninvalid": "onInvalid",
-"onkeydown": "onKeyDown",
-"onkeypress": "onKeyPress",
-"onkeyup": "onKeyUp",
-"onload": "onLoad",
-"onloadeddata": "onLoadedData",
-"onloadedmetadata": "onLoadedMetadata",
-"onloadstart": "onLoadStart",
-"onlostpointercapture": "onLostPointerCapture",
-"onmousedown": "onMouseDown",
-"onmouseenter": "onMouseEnter",
-"onmouseleave": "onMouseLeave",
-"onmousemove": "onMouseMove",
-"onmouseout": "onMouseOut",
-"onmouseover": "onMouseOver",
-"onmouseup": "onMouseUp",
-"onpaste": "onPaste",
-"onpause": "onPause",
-"onplay": "onPlay",
-"onplaying": "onPlaying",
-"onpointercancel": "onPointerCancel",
-"onpointerdown": "onPointerDown",
-"onpointerenter": "onPointerEnter",
-"onpointerleave": "onPointerLeave",
-"onpointermove": "onPointerMove",
-"onpointerout": "onPointerOut",
-"onpointerover": "onPointerOver",
-"onpointerup": "onPointerUp",
-"onprogress": "onProgress",
-"onratechange": "onRateChange",
-"onreset": "onReset",
-"onresize": "onResize",
-"onscroll": "onScroll",
-"onseeked": "onSeeked",
-"onseeking": "onSeeking",
-"onselect": "onSelect",
-"onstalled": "onStalled",
-"onsubmit": "onSubmit",
-"onsuspend": "onSuspend",
-"ontimeupdate": "onTimeUpdate",
-"ontoggle": "onToggle",
-"ontouchcancel": "onTouchCancel",
-"ontouchend": "onTouchEnd",
-"ontouchmove": "onTouchMove",
-"ontouchstart": "onTouchStart",
-"ontransitionend": "onTransitionEnd",
-"onvolumechange": "onVolumeChange",
-"onwaiting": "onWaiting",
-"onwheel": "onWheel",
-"playsinline": "playsInline",
-"readonly": "readOnly",
-"referrerpolicy": "referrerPolicy",
-"rowspan": "rowSpan",
-"spellcheck": "spellCheck",
-"srcdoc": "srcDoc",
-"srclang": "srcLang",
-"srcset": "srcSet",
-"tabindex": "tabIndex",
-"usemap": "useMap"
-}

package/presets/node/recommended.toml

@@ -1,13 +0,0 @@
-description = "eslint-plugin-n 18.5.0 recommended-module: the rules that need no package.json, hashbang on package.json's bin, and the import rules on the project graph, reimplemented"
-
-[rules]
-"node/hashbang" = "error"
-"node/no-deprecated-api" = "error"
-"node/no-exports-assign" = "error"
-"node/no-process-exit" = "error"
-"node/no-missing-import" = "error"
-"node/no-missing-require" = "error"
-"node/no-extraneous-import" = "error"
-"node/no-extraneous-require" = "error"
-"node/no-unpublished-import" = "error"
-"node/no-unpublished-require" = "error"

package/presets/react/recommended.toml

@@ -1,22 +0,0 @@
-description = "eslint-plugin-react 7.37.5 recommended with jsx-runtime, and eslint-plugin-react-hooks 7.1.1 rules-of-hooks and exhaustive-deps, reimplemented"
-
-[rules]
-"react/display-name" = "error"
-"react/exhaustive-deps" = "error"
-"react/jsx-key" = "error"
-"react/jsx-no-comment-textnodes" = "error"
-"react/jsx-no-duplicate-props" = "error"
-"react/jsx-no-target-blank" = "error"
-"react/jsx-no-undef" = "error"
-"react/no-children-prop" = "error"
-"react/no-danger-with-children" = "error"
-"react/no-deprecated" = "error"
-"react/no-direct-mutation-state" = "error"
-"react/no-find-dom-node" = "error"
-"react/no-is-mounted" = "error"
-"react/no-render-return-value" = "error"
-"react/no-string-refs" = "error"
-"react/no-unescaped-entities" = "error"
-"react/no-unknown-property" = "error"
-"react/require-render-return" = "error"
-"react/rules-of-hooks" = "error"

package/presets/stencil/recommended.toml

@@ -1,18 +0,0 @@
-description = "@stencil/eslint-plugin 1.4.0 recommended without its type-checked rules, reimplemented"
-
-[rules]
-"stencil/ban-default-true" = "error"
-"stencil/ban-exported-const-enums" = "error"
-"stencil/ban-prefix" = "error"
-"stencil/decorators-context" = "error"
-"stencil/host-data-deprecated" = "error"
-"stencil/methods-must-be-public" = "error"
-"stencil/no-unused-watch" = "error"
-"stencil/own-methods-must-be-private" = "error"
-"stencil/own-props-must-be-private" = "error"
-"stencil/prefer-vdom-listener" = "error"
-"stencil/prop-readonly" = "error"
-"stencil/props-must-be-public" = "error"
-"stencil/required-jsdoc" = "error"
-"stencil/reserved-member-names" = "error"
-"stencil/strict-mutable" = "error"

package/presets/ts/recommended.toml

@@ -1,27 +0,0 @@
-description = "typescript-eslint's recommended preset (8.71.2, not type-checked), reimplemented, with the core rules it switches on for TypeScript"
-
-[rules]
-"ts/ban-ts-comment" = "error"
-"ts/no-array-constructor" = "error"
-"ts/no-duplicate-enum-values" = "error"
-"ts/no-empty-object-type" = "error"
-"ts/no-explicit-any" = "error"
-"ts/no-extra-non-null-assertion" = "error"
-"ts/no-misused-new" = "error"
-"ts/no-namespace" = "error"
-"ts/no-non-null-asserted-optional-chain" = "error"
-"ts/no-require-imports" = "error"
-"ts/no-this-alias" = "error"
-"ts/no-unnecessary-type-constraint" = "error"
-"ts/no-unsafe-declaration-merging" = "error"
-"ts/no-unsafe-function-type" = "error"
-"ts/no-unused-expressions" = "error"
-"ts/no-unused-vars" = "error"
-"ts/no-wrapper-object-types" = "error"
-"ts/prefer-as-const" = "error"
-"ts/prefer-namespace-keyword" = "error"
-"ts/triple-slash-reference" = "error"
-"js/no-var" = "error"
-"js/prefer-const" = "error"
-"js/prefer-rest-params" = "error"
-"js/prefer-spread" = "error"

package/rules/node/hashbang.md

@@ -1,71 +0,0 @@
----
-id: node/hashbang
-title: "Commands start with a Node.js hashbang, and nothing else has one"
-languages: [javascript, jsx]
-fix: suggest
-fix_reason: "removing the hashbang of a script someone runs directly (`./tool.js`) stops it running"
-stability: preview
-ported_from: [eslint-plugin-n/hashbang]
-since: 0.1.0
----
-
-A file the nearest `package.json` names in `bin` starts with `#!/usr/bin/env node`; a file it doesn't name has no hashbang. Without a `package.json` above the file, nothing is checked.
-
-**Why:** npm links a `bin` entry as an executable, which the shell runs through its hashbang: without one the command fails, or runs under the wrong interpreter. A hashbang on a library file is noise that suggests it is a command.
-
-```codelaw
-native: node/hashbang
-```
-
-## How to fix
-
-1. On a command `bin` names, make the first line `#!/usr/bin/env node`.
-2. On any other file, remove the hashbang, or add the file to `bin` if it is a command.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js
-// package.json
-{ "name": "tool", "bin": { "tool": "./bin/tool.js" } }
-// bin/tool.js
-console.log("hello");
-```
-
-#### Do
-
-```js
-// package.json
-{ "name": "tool", "bin": { "tool": "./bin/tool.js" } }
-// bin/tool.js
-#!/usr/bin/env node
-console.log("hello");
-```
-
-### JSX
-
-#### Don't
-
-```jsx
-// package.json
-{ "name": "tool", "bin": "./cli.jsx" }
-// lib/view.jsx
-#!/usr/bin/env node
-export const View = () => <p>hello</p>;
-```
-
-#### Do
-
-```jsx
-// package.json
-{ "name": "tool", "bin": "./cli.jsx" }
-// lib/view.jsx
-export const View = () => <p>hello</p>;
-```
-
-## Differences from the source
-
-TypeScript sources are not checked: eslint-plugin-n maps them to their built JavaScript through `convertPath`, which this rule has no option for yet. The source's checks for a byte-order mark and CRLF line endings in a command are not ported, and there is no `additionalExecutables` or `executableMap` option.