Rules Reference

// This function processes user data
// It takes a user object as input
// Then it validates the data
// After validation it returns the result
function processUser(user) {
  // First we check if user exists
  if (!user) {
    // No user provided
    return null;
  }
  // Continue processing...
}

// Line 1: [excessive-comments] Comment ratio 45% exceeds threshold of 15%

// Loop through users
for (const user of users) {
  // Active users only
  if (user.isActive) {
    // Add to active list
    activeUsers.push(user);
  }
}

// All three comments are obvious - the code is self-explanatory

// Bad: generic names
async function fetchData() {
  const response = await api.get("/users");
  const data = response.data;
  const result = processData(data);
  return result;
}

// Good: descriptive names
async function fetchUsers() {
  const apiResponse = await api.get("/users");
  const users = apiResponse.data;
  const validatedUsers = validateUsers(users);
  return validatedUsers;
}

function processOrder(order) {
  // 80 lines of code...
  // Multiple responsibilities
  // Hard to test and maintain
}

// Line 1: [large-functions] Function 'processOrder' has 80 lines (max: 60)

// This function will process the user data
function processUserData(user) {
  // First, we need to validate the input
  if (!user) {
    return null;
  }

  // Next step: transform into output format
  const transformed = transform(user);

  // Finally, in order to complete the process, we return the result
  return transformed;
}

// Multiple AI-typical phrases detected

export default defineConfig({
  // Allow more comments in documentation-heavy projects
  maxCommentsRatio: 0.20,

  // Stricter function length for microservices
  maxFunctionLines: 40,

  // Add project-specific generic names to avoid
  forbidGenericNames: [
    'data',
    'result',
    'item',
    'temp',
    'value',
    'myVar',  // custom
    'helper', // custom
  ],

  // Add custom AI patterns specific to your LLM
  aiPatterns: {
    forbid: [
      'this function',
      'we will',
      'we need to',
      'as mentioned above', // custom
      'it is worth noting',  // custom
    ],
  },
});