Always return empty arrays in Typescript
When defining methods that return collections like arrays, always return an empty array instead of undefined when no items exist.
Bad:
```typescript
function getUserNames(): string[] | undefined {
if (users.length === 0) {
return undefined
}
Install this rule for wispbit
Quick Install
Run this one command to automatically install the rule:
Manual install
Copy the rule
---
include: *.ts,*.tsx
---
When defining methods that return collections like arrays, always return an empty array instead of undefined when no items exist.
Bad:
```typescript
function getUserNames(): string[] | undefined {
if (users.length === 0) {
return undefined
}
return users.map((user) => user.name)
}
```
Good:
```typescript
function getUserNames(): string[] {
if (users.length === 0) {
return []
}
return users.map((user) => user.name)
}
```
Add the rule into your project
.wispbit/rules/typescript-always-return-empty.md
Install this rule for Coderabbit
Copy the configuration below and add it to your repository as .coderabbit.yml
in your project root.
reviews:
path_instructions:
- path: "*.ts,*.tsx"
instructions: |
When defining methods that return collections like arrays, always return an empty array instead of undefined when no items exist.
Bad:
```typescript
function getUserNames(): string[] | undefined {
if (users.length === 0) {
return undefined
}
return users.map((user) => user.name)
}
```
Good:
```typescript
function getUserNames(): string[] {
if (users.length === 0) {
return []
}
return users.map((user) => user.name)
}
```
Install this rule for Greptile
Greptile rules can be added through the web interface. Please see this documentation for details on how to add custom rules and context.
When defining methods that return collections like arrays, always return an empty array instead of undefined when no items exist.
Bad:
```typescript
function getUserNames(): string[] | undefined {
if (users.length === 0) {
return undefined
}
return users.map((user) => user.name)
}
```
Good:
```typescript
function getUserNames(): string[] {
if (users.length === 0) {
return []
}
return users.map((user) => user.name)
}
```
File Path Patterns:
Install this rule for GitHub Copilot
Copilot instructions can be added through the interface. See the documentation for details on how to create coding guidelines.
When defining methods that return collections like arrays, always return an empty array instead of undefined when no items exist.
Bad:
```typescript
function getUserNames(): string[] | undefined {
if (users.length === 0) {
return undefined
}
return users.map((user) => user.name)
}
```
Good:
```typescript
function getUserNames(): string[] {
if (users.length === 0) {
return []
}
return users.map((user) => user.name)
}
```
File Path Patterns:
Install this rule for Graphite Diamond
Diamond custom rules can be added through the interface. See the documentation for details on how to create custom rules.
When defining methods that return collections like arrays, always return an empty array instead of undefined when no items exist.
Bad:
```typescript
function getUserNames(): string[] | undefined {
if (users.length === 0) {
return undefined
}
return users.map((user) => user.name)
}
```
Good:
```typescript
function getUserNames(): string[] {
if (users.length === 0) {
return []
}
return users.map((user) => user.name)
}
```
File Path Patterns:
Use with Cline
Copy the rule below and ask Cline to review your code using this rule
When defining methods that return collections like arrays, always return an empty array instead of undefined when no items exist.
Bad:
```typescript
function getUserNames(): string[] | undefined {
if (users.length === 0) {
return undefined
}
return users.map((user) => user.name)
}
```
Good:
```typescript
function getUserNames(): string[] {
if (users.length === 0) {
return []
}
return users.map((user) => user.name)
}
```
Use with OpenAI Codex
Copy the rule below and ask OpenAI Codex to review your code using this rule
When defining methods that return collections like arrays, always return an empty array instead of undefined when no items exist.
Bad:
```typescript
function getUserNames(): string[] | undefined {
if (users.length === 0) {
return undefined
}
return users.map((user) => user.name)
}
```
Good:
```typescript
function getUserNames(): string[] {
if (users.length === 0) {
return []
}
return users.map((user) => user.name)
}
```
Use with Cursor
Copy the rule below and ask Cursor to review your code using this rule
When defining methods that return collections like arrays, always return an empty array instead of undefined when no items exist.
Bad:
```typescript
function getUserNames(): string[] | undefined {
if (users.length === 0) {
return undefined
}
return users.map((user) => user.name)
}
```
Good:
```typescript
function getUserNames(): string[] {
if (users.length === 0) {
return []
}
return users.map((user) => user.name)
}
```
Use with Claude Code
Copy the rule below and ask Claude Code to review your code using this rule
When defining methods that return collections like arrays, always return an empty array instead of undefined when no items exist.
Bad:
```typescript
function getUserNames(): string[] | undefined {
if (users.length === 0) {
return undefined
}
return users.map((user) => user.name)
}
```
Good:
```typescript
function getUserNames(): string[] {
if (users.length === 0) {
return []
}
return users.map((user) => user.name)
}
```