unqommented/lib/tests/findUncommentedFiles.ignore.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, beforeEach, afterEach } = require('@jest/globals');
const fs = require('fs');
const path = require('path');
const utils = require('../utils');
const localVars = require('../../config/localVars');

const TEST_DIR = './test-dir-ignore';

beforeEach(() => {
  if (!fs.existsSync(TEST_DIR)) {
    fs.mkdirSync(TEST_DIR);
  }
  fs.writeFileSync(path.join(TEST_DIR, 'uncommented.js'), 'const x = 1;');
  const ignoredDirPath = path.join(TEST_DIR, localVars.IGNORED_DIRECTORIES[3]);
  fs.mkdirSync(ignoredDirPath, { recursive: true });
  fs.writeFileSync(path.join(ignoredDirPath, 'ignored.js'), 'const y = 2;');
  fs.writeFileSync(path.join(TEST_DIR, `file${localVars.IGNORED_FILENAME_PATTERNS[0]}js`), 'const z = 3;');
});

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

describe('findUncommentedFiles ignoring rules', () => {
  test('excludes ignored directories and file patterns', async () => {
    const result = await utils.findUncommentedFiles(TEST_DIR);
    expect(result.uncommentedFiles).toEqual(['uncommented.js']);
  });
});