@codelaw/rules-js 0.1.0 → 0.2.0

package/rules/node/no-process-exit.md

@@ -1,99 +0,0 @@
----
-id: node/no-process-exit
-title: "No process.exit()"
-languages: [javascript, jsx, typescript, tsx]
-fix: manual
-fix_reason: "how to end the program cleanly depends on what is still running"
-stability: preview
-ported_from: [eslint-plugin-n/no-process-exit]
-since: 0.1.0
----
-
-Code doesn't call `process.exit()`.
-
-**Why:** `process.exit()` ends the process at once, dropping pending writes and skipping cleanup;
-libraries that call it take that choice away from the program.
-
-```codelaw
-match:
-  pattern: process.exit($$$ARGS)
-message: "Don't end the process from here; throw, or set `process.exitCode`"
-```
-
-## How to fix
-
-1. Set `process.exitCode` and let the program finish, or throw an error the caller handles.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js
-if (failed) {
-  process.exit(1);
-}
-```
-
-#### Do
-
-```js
-if (failed) {
-  process.exitCode = 1;
-}
-```
-
-### JSX
-
-#### Don't
-
-```jsx
-if (failed) {
-  process.exit(1);
-}
-```
-
-#### Do
-
-```jsx
-if (failed) {
-  process.exitCode = 1;
-}
-```
-
-### TypeScript
-
-#### Don't
-
-```ts
-if (failed) {
-  process.exit(1);
-}
-```
-
-#### Do
-
-```ts
-if (failed) {
-  process.exitCode = 1;
-}
-```
-
-### TSX
-
-#### Don't
-
-```tsx
-if (failed) {
-  process.exit(1);
-}
-```
-
-#### Do
-
-```tsx
-if (failed) {
-  process.exitCode = 1;
-}
-```

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

@@ -1,134 +0,0 @@
----
-id: node/no-unpublished-import
-title: "Published files import only what is published"
-languages: [javascript, jsx, typescript, tsx]
-scope: project
-fix: manual
-fix_reason: "whether to publish the file, move the dependency or move the code is the package owner's choice"
-stability: preview
-ported_from: [eslint-plugin-n/no-unpublished-import]
-since: 0.1.0
----
-
-In a package that is not `private` and lists `files`, a file `npm publish` packs imports neither a project file it doesn't pack nor a package that is only a `devDependency`.
-
-**Why:** the published package then fails to load for its users: the file isn't in the tarball, or the devDependency isn't installed.
-
-```codelaw
-graph:
-  import:
-    form: [import, export, dynamic]
-    published: false
-message: "`$SOURCE` is not shipped to this package's users (`$MANIFEST`), but a published file imports it"
-```
-
-## How to fix
-
-1. Add the imported file to `files` in the nearest `package.json`, move the package from `devDependencies` to `dependencies`, or move the import out of the published code.
-2. A type-only import is not reported: it is erased from the published JavaScript.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js files
-// package.json
-{ "name": "lib", "main": "lib/index.js", "files": ["lib"] }
-// lib/index.js
-import { fixtures } from "../test/fixtures";
-console.log(fixtures);
-// test/fixtures.js
-export const fixtures = [];
-```
-
-#### Do
-
-```js files
-// package.json
-{ "name": "lib", "main": "lib/index.js", "files": ["lib"] }
-// lib/index.js
-import { fixtures } from "./fixtures";
-console.log(fixtures);
-// lib/fixtures.js
-export const fixtures = [];
-```
-
-### JSX
-
-#### Don't
-
-```jsx files
-// package.json
-{ "name": "lib", "main": "lib/index.jsx", "files": ["lib"] }
-// lib/index.jsx
-import { fixtures } from "../test/fixtures";
-export const App = () => <p>{String(fixtures)}</p>;
-// test/fixtures.jsx
-export const fixtures = [];
-```
-
-#### Do
-
-```jsx files
-// package.json
-{ "name": "lib", "main": "lib/index.jsx", "files": ["lib"] }
-// lib/index.jsx
-import { fixtures } from "./fixtures";
-export const App = () => <p>{String(fixtures)}</p>;
-// lib/fixtures.jsx
-export const fixtures = [];
-```
-
-### TypeScript
-
-#### Don't
-
-```ts files
-// package.json
-{ "name": "lib", "main": "lib/index.ts", "files": ["lib"] }
-// lib/index.ts
-import { fixtures } from "../test/fixtures";
-console.log(fixtures);
-// test/fixtures.ts
-export const fixtures = [];
-```
-
-#### Do
-
-```ts files
-// package.json
-{ "name": "lib", "main": "lib/index.ts", "files": ["lib"] }
-// lib/index.ts
-import { fixtures } from "./fixtures";
-console.log(fixtures);
-// lib/fixtures.ts
-export const fixtures = [];
-```
-
-### TSX
-
-#### Don't
-
-```tsx files
-// package.json
-{ "name": "lib", "main": "lib/index.tsx", "files": ["lib"] }
-// lib/index.tsx
-import { fixtures } from "../test/fixtures";
-export const App = () => <p>{String(fixtures)}</p>;
-// test/fixtures.tsx
-export const fixtures = [];
-```
-
-#### Do
-
-```tsx files
-// package.json
-{ "name": "lib", "main": "lib/index.tsx", "files": ["lib"] }
-// lib/index.tsx
-import { fixtures } from "./fixtures";
-export const App = () => <p>{String(fixtures)}</p>;
-// lib/fixtures.tsx
-export const fixtures = [];
-```

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

@@ -1,133 +0,0 @@
----
-id: node/no-unpublished-require
-title: "Published files require only what is published"
-languages: [javascript, jsx, typescript, tsx]
-scope: project
-fix: manual
-fix_reason: "whether to publish the file, move the dependency or move the code is the package owner's choice"
-stability: preview
-ported_from: [eslint-plugin-n/no-unpublished-require]
-since: 0.1.0
----
-
-In a package that is not `private` and lists `files`, a file `npm publish` packs requires neither a project file it doesn't pack nor a package that is only a `devDependency`.
-
-**Why:** the published package then fails to load for its users: the file isn't in the tarball, or the devDependency isn't installed.
-
-```codelaw
-graph:
-  import:
-    form: [require]
-    published: false
-message: "`$SOURCE` is not shipped to this package's users (`$MANIFEST`), but a published file requires it"
-```
-
-## How to fix
-
-1. Add the required file to `files` in the nearest `package.json`, move the package from `devDependencies` to `dependencies`, or move the `require()` out of the published code.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js files
-// package.json
-{ "name": "lib", "main": "lib/index.js", "files": ["lib"] }
-// lib/index.js
-const { fixtures } = require("../test/fixtures");
-console.log(fixtures);
-// test/fixtures.js
-export const fixtures = [];
-```
-
-#### Do
-
-```js files
-// package.json
-{ "name": "lib", "main": "lib/index.js", "files": ["lib"] }
-// lib/index.js
-const { fixtures } = require("./fixtures");
-console.log(fixtures);
-// lib/fixtures.js
-export const fixtures = [];
-```
-
-### JSX
-
-#### Don't
-
-```jsx files
-// package.json
-{ "name": "lib", "main": "lib/index.jsx", "files": ["lib"] }
-// lib/index.jsx
-const { fixtures } = require("../test/fixtures");
-export const App = () => <p>{String(fixtures)}</p>;
-// test/fixtures.jsx
-export const fixtures = [];
-```
-
-#### Do
-
-```jsx files
-// package.json
-{ "name": "lib", "main": "lib/index.jsx", "files": ["lib"] }
-// lib/index.jsx
-const { fixtures } = require("./fixtures");
-export const App = () => <p>{String(fixtures)}</p>;
-// lib/fixtures.jsx
-export const fixtures = [];
-```
-
-### TypeScript
-
-#### Don't
-
-```ts files
-// package.json
-{ "name": "lib", "main": "lib/index.ts", "files": ["lib"] }
-// lib/index.ts
-const { fixtures } = require("../test/fixtures");
-console.log(fixtures);
-// test/fixtures.ts
-export const fixtures = [];
-```
-
-#### Do
-
-```ts files
-// package.json
-{ "name": "lib", "main": "lib/index.ts", "files": ["lib"] }
-// lib/index.ts
-const { fixtures } = require("./fixtures");
-console.log(fixtures);
-// lib/fixtures.ts
-export const fixtures = [];
-```
-
-### TSX
-
-#### Don't
-
-```tsx files
-// package.json
-{ "name": "lib", "main": "lib/index.tsx", "files": ["lib"] }
-// lib/index.tsx
-const { fixtures } = require("../test/fixtures");
-export const App = () => <p>{String(fixtures)}</p>;
-// test/fixtures.tsx
-export const fixtures = [];
-```
-
-#### Do
-
-```tsx files
-// package.json
-{ "name": "lib", "main": "lib/index.tsx", "files": ["lib"] }
-// lib/index.tsx
-const { fixtures } = require("./fixtures");
-export const App = () => <p>{String(fixtures)}</p>;
-// lib/fixtures.tsx
-export const fixtures = [];
-```

package/rules/react/display-name.md

@@ -1,91 +0,0 @@
----
-id: react/display-name
-title: "A component passed to memo or forwardRef has a name"
-languages: [javascript, jsx, tsx]
-fix: manual
-fix_reason: "the name is the author's choice"
-stability: preview
-ported_from: [eslint-plugin-react/display-name]
-since: 0.1.0
----
-
-A component wrapped in `memo` or `forwardRef` is a named function, so it has a display name.
-
-**Why:** An anonymous component shows up as `Anonymous` in React DevTools and in error messages,
-which makes both harder to read.
-
-```codelaw
-match:
-  any:
-    - pattern: memo($F)
-    - pattern: React.memo($F)
-    - pattern: forwardRef($F)
-    - pattern: React.forwardRef($F)
-constraints:
-  F:
-    any:
-      - kind: arrow_function
-      - kind: function_expression
-        not: { has: { field: name, pattern: $NAME } }
-message: "This component has no name, so React DevTools and error messages show it as `Anonymous`"
-```
-
-## How to fix
-
-1. Pass a named function: `memo(function Card(props) { … })`.
-2. Or set `Card.displayName = "Card"`.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js
-export const Card = memo((props) => <div>{props.title}</div>);
-```
-
-#### Do
-
-```js
-export const Card = memo(function Card(props) {
-  return <div>{props.title}</div>;
-});
-```
-
-### JSX
-
-#### Don't
-
-```jsx
-export const Card = memo((props) => <div>{props.title}</div>);
-```
-
-#### Do
-
-```jsx
-export const Card = memo(function Card(props) {
-  return <div>{props.title}</div>;
-});
-```
-
-### TSX
-
-#### Don't
-
-```tsx
-export const Card = memo((props) => <div>{props.title}</div>);
-```
-
-#### Do
-
-```tsx
-export const Card = memo(function Card(props) {
-  return <div>{props.title}</div>;
-});
-```
-
-## Differences from the source
-
-Components defined some other way (`createReactClass`, anonymous default exports) are not checked
-yet.

package/rules/react/exhaustive-deps.md

@@ -1,116 +0,0 @@
----
-id: react/exhaustive-deps
-title: "Effect and memo dependency lists name every value they read"
-languages: [javascript, jsx, typescript, tsx]
-fix: suggest
-fix_reason: "adding a dependency can make an effect run more often"
-stability: preview
-ported_from: [eslint-plugin-react-hooks/exhaustive-deps]
-since: 0.1.0
----
-
-The dependency list of `useEffect`, `useLayoutEffect`, `useCallback`, `useMemo` and
-`useImperativeHandle` names every prop, state value and local the callback reads, and nothing from
-outside the component.
-
-**Why:** A missing dependency makes the hook keep a stale value; an outside value in the list does
-nothing.
-
-```codelaw
-native: react/exhaustive-deps
-```
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js
-function Search({ query }) {
-  useEffect(() => {
-    fetchResults(query);
-  }, []);
-}
-```
-
-#### Do
-
-```js
-function Search({ query }) {
-  useEffect(() => {
-    fetchResults(query);
-  }, [query]);
-}
-```
-
-### JSX
-
-#### Don't
-
-```jsx
-function Search({ query }) {
-  useEffect(() => {
-    fetchResults(query);
-  }, []);
-}
-```
-
-#### Do
-
-```jsx
-function Search({ query }) {
-  useEffect(() => {
-    fetchResults(query);
-  }, [query]);
-}
-```
-
-### TypeScript
-
-#### Don't
-
-```ts
-function Search({ query }) {
-  useEffect(() => {
-    fetchResults(query);
-  }, []);
-}
-```
-
-#### Do
-
-```ts
-function Search({ query }) {
-  useEffect(() => {
-    fetchResults(query);
-  }, [query]);
-}
-```
-
-### TSX
-
-#### Don't
-
-```tsx
-function Search({ query }) {
-  useEffect(() => {
-    fetchResults(query);
-  }, []);
-}
-```
-
-#### Do
-
-```tsx
-function Search({ query }) {
-  useEffect(() => {
-    fetchResults(query);
-  }, [query]);
-}
-```
-
-## Differences from the source
-
-State setters, reducer dispatchers and refs are treated as stable, as upstream does. Dependencies
-are compared by their root name (`props` covers `props.id`).

package/rules/react/hook-prefix.md

@@ -1,108 +0,0 @@
----
-id: react/hook-prefix
-title: "Functions that call hooks are named use…"
-languages: [javascript, jsx, typescript, tsx]
-fix: manual
-fix_reason: "every caller of the function must be renamed too"
-stability: preview
-since: 0.1.0
----
-
-A function that isn't a component (PascalCase) and calls a hook is a custom hook, and is named
-`use…`.
-
-**Why:** React and its tools recognise hooks by the `use` prefix; without it the Rules of Hooks
-can't be checked for the function's callers.
-
-```codelaw
-match:
-  kind: function_declaration
-  all:
-    - has: { field: name, regex: '^[a-z]', not: { regex: '^use[A-Z]' }, pattern: $NAME }
-    - has:
-        field: body
-        has:
-          stopBy: { any: [{ kind: function_declaration }, { kind: arrow_function }, { kind: function_expression }] }
-          kind: call_expression
-          has: { field: function, regex: '^(React\.)?use[A-Z]' }
-message: "`$NAME` calls hooks, so it is a hook: name it `use…`"
-```
-
-## How to fix
-
-1. Rename the function to start with `use` (e.g. `loadUser` → `useUser`).
-2. Rename its callers.
-
-## Examples
-
-### JavaScript
-
-#### Don't
-
-```js
-function currentUser() {
-  return useContext(UserContext);
-}
-```
-
-#### Do
-
-```js
-function useCurrentUser() {
-  return useContext(UserContext);
-}
-```
-
-### JSX
-
-#### Don't
-
-```jsx
-function currentUser() {
-  return useContext(UserContext);
-}
-```
-
-#### Do
-
-```jsx
-function useCurrentUser() {
-  return useContext(UserContext);
-}
-```
-
-### TypeScript
-
-#### Don't
-
-```ts
-function currentUser() {
-  return useContext(UserContext);
-}
-```
-
-#### Do
-
-```ts
-function useCurrentUser() {
-  return useContext(UserContext);
-}
-```
-
-### TSX
-
-#### Don't
-
-```tsx
-function currentUser() {
-  return useContext(UserContext);
-}
-```
-
-#### Do
-
-```tsx
-function useCurrentUser() {
-  return useContext(UserContext);
-}
-```