|
| 1 | +# Expected Behavior: `async-function-naming` Rule |
| 2 | + |
| 3 | +This rule enforces that async function declarations must have the 'Async' suffix in their name. |
| 4 | + |
| 5 | +## ❌ Invalid Examples |
| 6 | + |
| 7 | +```typescript |
| 8 | +// Async function declarations without 'Async' suffix |
| 9 | +async function fetchUser() { |
| 10 | + const response = await fetch('/api/user') |
| 11 | + return response.json() |
| 12 | +} |
| 13 | + |
| 14 | +async function processData(data: any[]) { |
| 15 | + return data.map(item => item.processed) |
| 16 | +} |
| 17 | + |
| 18 | +async function saveToDatabase(record: User) { |
| 19 | + await db.users.insert(record) |
| 20 | +} |
| 21 | + |
| 22 | +async function validateInput(input: string) { |
| 23 | + return input.length > 0 |
| 24 | +} |
| 25 | + |
| 26 | +// Complex async functions without 'Async' suffix |
| 27 | +async function getUserByIdAndUpdate(id: string, updates: Partial<User>) { |
| 28 | + const user = await db.users.findById(id) |
| 29 | + if (user) { |
| 30 | + await db.users.update(id, updates) |
| 31 | + } |
| 32 | + return user |
| 33 | +} |
| 34 | + |
| 35 | +async function handleRequest(req: Request) { |
| 36 | + const body = await req.json() |
| 37 | + const result = await processRequest(body) |
| 38 | + return new Response(JSON.stringify(result)) |
| 39 | +} |
| 40 | +``` |
| 41 | + |
| 42 | +## ✅ Valid Examples |
| 43 | + |
| 44 | +```typescript |
| 45 | +// Async function declarations with 'Async' suffix |
| 46 | +async function fetchUserAsync() { |
| 47 | + const response = await fetch('/api/user') |
| 48 | + return response.json() |
| 49 | +} |
| 50 | + |
| 51 | +async function processDataAsync(data: any[]) { |
| 52 | + return data.map(item => item.processed) |
| 53 | +} |
| 54 | + |
| 55 | +async function saveToDatabaseAsync(record: User) { |
| 56 | + await db.users.insert(record) |
| 57 | +} |
| 58 | + |
| 59 | +async function validateInputAsync(input: string) { |
| 60 | + return input.length > 0 |
| 61 | +} |
| 62 | + |
| 63 | +// Complex async functions with 'Async' suffix |
| 64 | +async function getUserByIdAndUpdateAsync(id: string, updates: Partial<User>) { |
| 65 | + const user = await db.users.findById(id) |
| 66 | + if (user) { |
| 67 | + await db.users.update(id, updates) |
| 68 | + } |
| 69 | + return user |
| 70 | +} |
| 71 | + |
| 72 | +async function handleRequestAsync(req: Request) { |
| 73 | + const body = await req.json() |
| 74 | + const result = await processRequest(body) |
| 75 | + return new Response(JSON.stringify(result)) |
| 76 | +} |
| 77 | + |
| 78 | +// Non-async functions (not affected by this rule) |
| 79 | +function calculateSum(a: number, b: number) { |
| 80 | + return a + b |
| 81 | +} |
| 82 | + |
| 83 | +const processData = (data: any[]) => { |
| 84 | + return data.map(item => item.processed) |
| 85 | +} |
| 86 | + |
| 87 | +// Arrow functions and function expressions (not affected by this rule) |
| 88 | +const fetchUser = async () => { |
| 89 | + const response = await fetch('/api/user') |
| 90 | + return response.json() |
| 91 | +} |
| 92 | + |
| 93 | +const handler = async function (event: Event) { |
| 94 | + event.preventDefault() |
| 95 | +} |
| 96 | + |
| 97 | +// Class methods (not affected by this rule) |
| 98 | +class UserService { |
| 99 | + async fetchUser() { |
| 100 | + const response = await fetch('/api/user') |
| 101 | + return response.json() |
| 102 | + } |
| 103 | + |
| 104 | + async saveUser(user: User) { |
| 105 | + await db.users.insert(user) |
| 106 | + } |
| 107 | +} |
| 108 | +``` |
| 109 | + |
| 110 | +## Rule Scope |
| 111 | + |
| 112 | +This rule **only applies to**: |
| 113 | + |
| 114 | +- ✅ `async function` declarations with names |
| 115 | + |
| 116 | +This rule **does NOT apply to**: |
| 117 | + |
| 118 | +- ❌ Arrow functions (`const fn = async () => {}`) |
| 119 | +- ❌ Function expressions (`const fn = async function() {}`) |
| 120 | +- ❌ Class methods (`async method() {}`) |
| 121 | +- ❌ Non-async functions |
| 122 | +- ❌ Anonymous functions |
| 123 | + |
| 124 | +## Auto-fix Behavior |
| 125 | + |
| 126 | +The rule provides auto-fix suggestions that add the 'Async' suffix: |
| 127 | + |
| 128 | +- `async function fetchUser()` → `async function fetchUserAsync()` |
| 129 | +- `async function processData()` → `async function processDataAsync()` |
| 130 | +- `async function saveToDatabase()` → `async function saveToDatabaseAsync()` |
0 commit comments