unqommented/lib/tests/hasUncommentedCode.comments.test.js

A Node.js utility that quickly identifies files with uncommented code in your codebase. Designed for developers who want to efficiently tell LLMs exactly which files need comments added.

require('qtests/setup');
const { test, expect, describe, beforeAll, afterAll } = require('@jest/globals');
const fs = require('fs');
const path = require('path');
const utils = require('../utils');

const TEST_DIR = './comment-tests';
let blockFile;
let mixedFile;

beforeAll(() => {
  if (!fs.existsSync(TEST_DIR)) {
    fs.mkdirSync(TEST_DIR);
  }
  blockFile = path.join(TEST_DIR, 'block.js');
  mixedFile = path.join(TEST_DIR, 'mixed.js');
  fs.writeFileSync(blockFile, '/* comment */');
  fs.writeFileSync(mixedFile, 'const x = 1; // comment');
});

afterAll(() => {
  fs.rmSync(TEST_DIR, { recursive: true, force: true });
});

describe('hasUncommentedCode comment variations', () => {
  test('returns false for file with only block comment', async () => {
    const result = await utils.hasUncommentedCode(blockFile);
    expect(result).toBe(false);
  });

  test('returns true for file with code and trailing comment', async () => {
    const result = await utils.hasUncommentedCode(mixedFile);
    expect(result).toBe(true);
  });
});