@codelaw/rules-js 0.1.0 → 0.2.0

package/rules/node/no-deprecated-api.md

@@ -1,91 +0,0 @@
----
-id: node/no-deprecated-api
-title: "No deprecated Node.js APIs"
-languages: [javascript, jsx, typescript, tsx]
-fix: manual
-fix_reason: "each deprecated API has its own replacement"
-stability: preview
-ported_from: [eslint-plugin-n/no-deprecated-api]
-since: 0.1.0
----
-
-Code doesn't use Node.js APIs the documentation deprecates — `new Buffer()`, `fs.exists`,
-`url.parse`, `util.isArray`, the `domain` module and the rest — whether reached by `import`,
-`require()` or a global.
-
-**Why:** Deprecated APIs are unsafe, slow or due for removal, and each has a documented replacement.
-
-```codelaw
-native: node/no-deprecated-api
-```
-
-## How to fix
-
-1. Replace the call with the API the message names.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js
-import { isArray } from "node:util";
-export const ok = isArray([]);
-```
-
-#### Do
-
-```js
-export const ok = Array.isArray([]);
-```
-
-### JSX
-
-#### Don't
-
-```jsx
-import { isArray } from "node:util";
-export const ok = isArray([]);
-```
-
-#### Do
-
-```jsx
-export const ok = Array.isArray([]);
-```
-
-### TypeScript
-
-#### Don't
-
-```ts
-import { isArray } from "node:util";
-export const ok = isArray([]);
-```
-
-#### Do
-
-```ts
-export const ok = Array.isArray([]);
-```
-
-### TSX
-
-#### Don't
-
-```tsx
-import { isArray } from "node:util";
-export const ok = isArray([]);
-```
-
-#### Do
-
-```tsx
-export const ok = Array.isArray([]);
-```
-
-## Differences from the source
-
-The pack's `node/deprecated-api` data table lists the APIs; the Node.js version a project supports
-is not read.

package/rules/node/no-exports-assign.md

@@ -1,92 +0,0 @@
----
-id: node/no-exports-assign
-title: "No assigning to exports"
-languages: [javascript, jsx, typescript, tsx]
-fix: manual
-fix_reason: "whether `module.exports` or a property was meant needs the author"
-stability: preview
-ported_from: [eslint-plugin-n/no-exports-assign]
-since: 0.1.0
----
-
-Code doesn't assign to the CommonJS `exports` variable; `exports = module.exports = …` is allowed.
-
-**Why:** Assigning to `exports` only rebinds a local variable, so nothing is exported.
-
-```codelaw
-match:
-  kind: assignment_expression
-  has: { field: left, kind: identifier, regex: ^exports$, pattern: $E }
-  not:
-    any:
-      - has: { field: right, regex: '^module\.exports\b' }
-      - inside:
-          stopBy: neighbor
-          kind: assignment_expression
-          has: { field: left, regex: '^module\.exports$' }
-where:
-  $E: undeclared
-message: "Assigning to `exports` exports nothing; assign to `module.exports`"
-```
-
-## How to fix
-
-1. Assign to `module.exports`, or set properties on `exports` (`exports.name = …`).
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js
-exports = { start };
-```
-
-#### Do
-
-```js
-module.exports = { start };
-```
-
-### JSX
-
-#### Don't
-
-```jsx
-exports = { start };
-```
-
-#### Do
-
-```jsx
-module.exports = { start };
-```
-
-### TypeScript
-
-#### Don't
-
-```ts
-exports = { start };
-```
-
-#### Do
-
-```ts
-module.exports = { start };
-```
-
-### TSX
-
-#### Don't
-
-```tsx
-exports = { start };
-```
-
-#### Do
-
-```tsx
-module.exports = { start };
-```

package/rules/node/no-extraneous-import.md

@@ -1,118 +0,0 @@
----
-id: node/no-extraneous-import
-title: "Imported packages must be declared"
-languages: [javascript, jsx, typescript, tsx]
-scope: project
-fix: manual
-fix_reason: "which dependency field and version to add is the package owner's choice"
-stability: preview
-ported_from: [eslint-plugin-n/no-extraneous-import]
-since: 0.1.0
----
-
-Every package an `import`, `export … from` or `import()` names is declared in the nearest `package.json`: `dependencies`, `devDependencies`, `peerDependencies` or `optionalDependencies`.
-
-**Why:** an undeclared package works only while something else happens to install it — a hoisted monorepo dependency or a transitive one — and breaks for every user who doesn't have it.
-
-```codelaw
-graph:
-  import:
-    form: [import, export, dynamic]
-    declared: false
-message: "`$PACKAGE` is imported but not declared in `$MANIFEST`"
-```
-
-## How to fix
-
-1. Add the package to the nearest `package.json` (`dependencies` if the shipped code needs it, `devDependencies` if only tests and tooling do), with your package manager's `add` command.
-2. A type-only import is satisfied by its `@types/` package.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0" } }
-// src/app.js
-import lodash from "lodash";
-console.log(lodash);
-```
-
-#### Do
-
-```js files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0", "lodash": "4.17.21" } }
-// src/app.js
-import lodash from "lodash";
-console.log(lodash);
-```
-
-### JSX
-
-#### Don't
-
-```jsx files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0" } }
-// src/app.jsx
-import lodash from "lodash";
-export const App = () => <p>{String(lodash)}</p>;
-```
-
-#### Do
-
-```jsx files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0", "lodash": "4.17.21" } }
-// src/app.jsx
-import lodash from "lodash";
-export const App = () => <p>{String(lodash)}</p>;
-```
-
-### TypeScript
-
-#### Don't
-
-```ts files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0" } }
-// src/app.ts
-import lodash from "lodash";
-console.log(lodash);
-```
-
-#### Do
-
-```ts files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0", "lodash": "4.17.21" } }
-// src/app.ts
-import lodash from "lodash";
-console.log(lodash);
-```
-
-### TSX
-
-#### Don't
-
-```tsx files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0" } }
-// src/app.tsx
-import lodash from "lodash";
-export const App = () => <p>{String(lodash)}</p>;
-```
-
-#### Do
-
-```tsx files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0", "lodash": "4.17.21" } }
-// src/app.tsx
-import lodash from "lodash";
-export const App = () => <p>{String(lodash)}</p>;
-```

package/rules/node/no-extraneous-require.md

@@ -1,117 +0,0 @@
----
-id: node/no-extraneous-require
-title: "Required packages must be declared"
-languages: [javascript, jsx, typescript, tsx]
-scope: project
-fix: manual
-fix_reason: "which dependency field and version to add is the package owner's choice"
-stability: preview
-ported_from: [eslint-plugin-n/no-extraneous-require]
-since: 0.1.0
----
-
-Every package a `require()` names is declared in the nearest `package.json`: `dependencies`, `devDependencies`, `peerDependencies` or `optionalDependencies`.
-
-**Why:** an undeclared package works only while something else happens to install it, and breaks for every user who doesn't have it.
-
-```codelaw
-graph:
-  import:
-    form: [require]
-    declared: false
-message: "`$PACKAGE` is required but not declared in `$MANIFEST`"
-```
-
-## How to fix
-
-1. Add the package to the nearest `package.json` (`dependencies` if the shipped code needs it, `devDependencies` if only tests and tooling do), with your package manager's `add` command.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0" } }
-// src/app.js
-const lodash = require("lodash");
-console.log(lodash);
-```
-
-#### Do
-
-```js files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0", "lodash": "4.17.21" } }
-// src/app.js
-const lodash = require("lodash");
-console.log(lodash);
-```
-
-### JSX
-
-#### Don't
-
-```jsx files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0" } }
-// src/app.jsx
-const lodash = require("lodash");
-export const App = () => <p>{String(lodash)}</p>;
-```
-
-#### Do
-
-```jsx files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0", "lodash": "4.17.21" } }
-// src/app.jsx
-const lodash = require("lodash");
-export const App = () => <p>{String(lodash)}</p>;
-```
-
-### TypeScript
-
-#### Don't
-
-```ts files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0" } }
-// src/app.ts
-const lodash = require("lodash");
-console.log(lodash);
-```
-
-#### Do
-
-```ts files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0", "lodash": "4.17.21" } }
-// src/app.ts
-const lodash = require("lodash");
-console.log(lodash);
-```
-
-### TSX
-
-#### Don't
-
-```tsx files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0" } }
-// src/app.tsx
-const lodash = require("lodash");
-export const App = () => <p>{String(lodash)}</p>;
-```
-
-#### Do
-
-```tsx files
-// package.json
-{ "name": "app", "dependencies": { "react": "19.0.0", "lodash": "4.17.21" } }
-// src/app.tsx
-const lodash = require("lodash");
-export const App = () => <p>{String(lodash)}</p>;
-```

package/rules/node/no-missing-import.md

@@ -1,118 +0,0 @@
----
-id: node/no-missing-import
-title: "Imported project paths must exist"
-languages: [javascript, jsx, typescript, tsx]
-scope: project
-fix: manual
-fix_reason: "the right path depends on where the module went"
-stability: preview
-ported_from: [eslint-plugin-n/no-missing-import]
-since: 0.1.0
----
-
-An `import`, `export … from` or `import()` path of the project — relative, absolute or a tsconfig `paths` alias — names a file that exists.
-
-**Why:** a path that names no file fails at build or load time, and only on the code path that reaches it.
-
-```codelaw
-graph:
-  import:
-    form: [import, export, dynamic]
-    resolves: false
-message: "`$SOURCE` names no file of this project"
-```
-
-## How to fix
-
-1. Point the specifier at the file that exists (check the extension and the folder), or restore the missing file.
-2. A path to a generated file the repo doesn't hold is reported too: generate it before `codelaw check`, or suppress the line with a reason.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js files
-// src/app.js
-import { helper } from "./helpers";
-console.log(helper);
-// src/helper.js
-export const helper = 1;
-```
-
-#### Do
-
-```js files
-// src/app.js
-import { helper } from "./helper";
-console.log(helper);
-// src/helper.js
-export const helper = 1;
-```
-
-### JSX
-
-#### Don't
-
-```jsx files
-// src/app.jsx
-import { helper } from "./helpers";
-export const App = () => <p>{String(helper)}</p>;
-// src/helper.jsx
-export const helper = 1;
-```
-
-#### Do
-
-```jsx files
-// src/app.jsx
-import { helper } from "./helper";
-export const App = () => <p>{String(helper)}</p>;
-// src/helper.jsx
-export const helper = 1;
-```
-
-### TypeScript
-
-#### Don't
-
-```ts files
-// src/app.ts
-import { helper } from "./helpers";
-console.log(helper);
-// src/helper.ts
-export const helper = 1;
-```
-
-#### Do
-
-```ts files
-// src/app.ts
-import { helper } from "./helper";
-console.log(helper);
-// src/helper.ts
-export const helper = 1;
-```
-
-### TSX
-
-#### Don't
-
-```tsx files
-// src/app.tsx
-import { helper } from "./helpers";
-export const App = () => <p>{String(helper)}</p>;
-// src/helper.tsx
-export const helper = 1;
-```
-
-#### Do
-
-```tsx files
-// src/app.tsx
-import { helper } from "./helper";
-export const App = () => <p>{String(helper)}</p>;
-// src/helper.tsx
-export const helper = 1;
-```

package/rules/node/no-missing-require.md

@@ -1,117 +0,0 @@
----
-id: node/no-missing-require
-title: "Required project paths must exist"
-languages: [javascript, jsx, typescript, tsx]
-scope: project
-fix: manual
-fix_reason: "the right path depends on where the module went"
-stability: preview
-ported_from: [eslint-plugin-n/no-missing-require]
-since: 0.1.0
----
-
-A `require()` path of the project — relative, absolute or a tsconfig `paths` alias — names a file that exists.
-
-**Why:** a path that names no file throws `MODULE_NOT_FOUND`, and only when that line runs.
-
-```codelaw
-graph:
-  import:
-    form: [require]
-    resolves: false
-message: "`$SOURCE` names no file of this project"
-```
-
-## How to fix
-
-1. Point the specifier at the file that exists (check the extension and the folder), or restore the missing file.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js files
-// src/app.js
-const { helper } = require("./helpers");
-console.log(helper);
-// src/helper.js
-export const helper = 1;
-```
-
-#### Do
-
-```js files
-// src/app.js
-const { helper } = require("./helper");
-console.log(helper);
-// src/helper.js
-export const helper = 1;
-```
-
-### JSX
-
-#### Don't
-
-```jsx files
-// src/app.jsx
-const { helper } = require("./helpers");
-export const App = () => <p>{String(helper)}</p>;
-// src/helper.jsx
-export const helper = 1;
-```
-
-#### Do
-
-```jsx files
-// src/app.jsx
-const { helper } = require("./helper");
-export const App = () => <p>{String(helper)}</p>;
-// src/helper.jsx
-export const helper = 1;
-```
-
-### TypeScript
-
-#### Don't
-
-```ts files
-// src/app.ts
-const { helper } = require("./helpers");
-console.log(helper);
-// src/helper.ts
-export const helper = 1;
-```
-
-#### Do
-
-```ts files
-// src/app.ts
-const { helper } = require("./helper");
-console.log(helper);
-// src/helper.ts
-export const helper = 1;
-```
-
-### TSX
-
-#### Don't
-
-```tsx files
-// src/app.tsx
-const { helper } = require("./helpers");
-export const App = () => <p>{String(helper)}</p>;
-// src/helper.tsx
-export const helper = 1;
-```
-
-#### Do
-
-```tsx files
-// src/app.tsx
-const { helper } = require("./helper");
-export const App = () => <p>{String(helper)}</p>;
-// src/helper.tsx
-export const helper = 1;
-```