@nitpicker/report-google-sheets 0.4.2 → 0.4.3

package/src/data/create-resources.ts

@@ -1,51 +0,0 @@
-import type { CreateSheet } from '../sheets/types.js';
-
-import { reportLog } from '../debug.js';
-import { createCellData } from '../sheets/create-cell-data.js';
-import { defaultCellFormat } from '../sheets/default-cell-format.js';
-
-/**
- * Creates the "Resources" sheet configuration.
- *
- * Lists all network resources (CSS, JS, images, fonts, etc.) discovered
- * during crawling, with one row per unique resource URL. Each row includes
- * HTTP status, content type, size, and the number of pages that reference
- * the resource (with URLs listed in the cell note).
- *
- * Uses `eachResource` (Phase 3) to iterate over the archive's resource
- * table rather than page-by-page iteration.
- */
-export const createResources: CreateSheet = () => {
-	return {
-		name: 'Resources',
-		createHeaders() {
-			return [
-				'URL',
-				'Status Code',
-				'Status Text',
-				'Content Type',
-				'Content Length',
-				'Referrers',
-			];
-		},
-		async eachResource(resource) {
-			reportLog(`Read: Resource referrers (Search: ${resource.url})`);
-			const referrers = await resource.getReferrers();
-			const data = [
-				createCellData({ value: resource.url }, defaultCellFormat),
-				createCellData({ value: resource.status }, defaultCellFormat),
-				createCellData({ value: resource.statusText }, defaultCellFormat),
-				createCellData({ value: resource.contentType }, defaultCellFormat),
-				createCellData({ value: resource.contentLength }, defaultCellFormat),
-				createCellData(
-					{
-						value: `${referrers.length} pages`,
-						note: referrers.join('\n'),
-					},
-					defaultCellFormat,
-				),
-			];
-			return [data];
-		},
-	};
-};

package/src/data/create-violations.spec.ts

@@ -1,95 +0,0 @@
-import type { Report } from '@nitpicker/types';
-
-import { describe, it, expect } from 'vitest';
-
-import { createViolations } from './create-violations.js';
-
-describe('createViolations', () => {
-	it('returns sheet config with name "Violations"', () => {
-		const sheet = createViolations([]);
-		expect(sheet.name).toBe('Violations');
-	});
-
-	it('returns correct headers', () => {
-		const sheet = createViolations([]);
-		const headers = sheet.createHeaders();
-		expect(headers).toEqual(['Validator', 'Severity', 'Rule', 'Code', 'Message', 'URL']);
-	});
-
-	it('generates rows from report violations', () => {
-		const reports: Report[] = [
-			{
-				name: 'axe',
-				violations: [
-					{
-						validator: 'axe',
-						severity: 'serious',
-						rule: 'color-contrast',
-						code: 'color-contrast',
-						message: 'Elements must have sufficient color contrast',
-						url: 'https://example.com/',
-					},
-				],
-			},
-		];
-
-		const sheet = createViolations(reports);
-		const rows = sheet.addRows!();
-
-		expect(rows).toHaveLength(1);
-		expect(rows[0]).toHaveLength(6);
-	});
-
-	it('skips reports without violations', () => {
-		const reports: Report[] = [{ name: 'no-violations' }];
-
-		const sheet = createViolations(reports);
-		const rows = sheet.addRows!();
-
-		expect(rows).toHaveLength(0);
-	});
-
-	it('handles multiple reports with multiple violations', () => {
-		const reports: Report[] = [
-			{
-				name: 'axe',
-				violations: [
-					{
-						validator: 'axe',
-						severity: 'serious',
-						rule: 'rule-1',
-						code: 'code-1',
-						message: 'msg-1',
-						url: 'https://example.com/a',
-					},
-					{
-						validator: 'axe',
-						severity: 'minor',
-						rule: 'rule-2',
-						code: 'code-2',
-						message: 'msg-2',
-						url: 'https://example.com/b',
-					},
-				],
-			},
-			{
-				name: 'markuplint',
-				violations: [
-					{
-						validator: 'markuplint',
-						severity: 'warning',
-						rule: 'rule-3',
-						code: 'code-3',
-						message: 'msg-3',
-						url: 'https://example.com/c',
-					},
-				],
-			},
-		];
-
-		const sheet = createViolations(reports);
-		const rows = sheet.addRows!();
-
-		expect(rows).toHaveLength(3);
-	});
-});

package/src/data/create-violations.ts

@@ -1,47 +0,0 @@
-import type { CreateSheet } from '../sheets/types.js';
-import type { Cell } from '@d-zero/google-sheets';
-
-import { pLog } from '../debug.js';
-import { createCellData } from '../sheets/create-cell-data.js';
-import { defaultCellFormat } from '../sheets/default-cell-format.js';
-
-const log = pLog.extend('Violations');
-
-/**
- * Creates the "Violations" sheet configuration.
- *
- * Aggregates all violations from analyze plugin reports into a single
- * flat table. Uses `addRows` (Phase 4) rather than `eachPage` because
- * violation data comes from the report objects, not from per-page
- * archive iteration. This means it runs in parallel with page/resource
- * processing phases.
- * @param reports
- */
-export const createViolations: CreateSheet = (reports) => {
-	return {
-		name: 'Violations',
-		createHeaders() {
-			return ['Validator', 'Severity', 'Rule', 'Code', 'Message', 'URL'];
-		},
-		addRows: () => {
-			const data: Cell[][] = [];
-			for (const report of reports) {
-				if (!report.violations) {
-					continue;
-				}
-				log('From %s', report.name);
-				for (const violation of report.violations) {
-					data.push([
-						createCellData({ value: violation.validator }, defaultCellFormat),
-						createCellData({ value: violation.severity }, defaultCellFormat),
-						createCellData({ value: violation.rule }, defaultCellFormat),
-						createCellData({ value: violation.code }, defaultCellFormat),
-						createCellData({ value: violation.message }, defaultCellFormat),
-						createCellData({ value: violation.url }, defaultCellFormat),
-					]);
-				}
-			}
-			return data;
-		},
-	};
-};

package/src/debug.ts

@@ -1,7 +0,0 @@
-import debug from 'debug';
-
-export const log = debug('Nitpicker').extend('GoogleSpreadsheet');
-export const sheetLog = log.extend('Sheet');
-export const archiveLog = log.extend('Archive');
-export const reportLog = log.extend('Report');
-export const pLog = log.extend('Plugin');

package/src/index.ts

@@ -1 +0,0 @@
-export { report } from './report.js';

package/src/load-config.spec.ts

@@ -1,37 +0,0 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-
-import { describe, it, expect, vi } from 'vitest';
-
-import { loadConfig } from './load-config.js';
-
-vi.mock('node:fs/promises');
-
-describe('loadConfig', () => {
-	it('returns empty object when filePath is null', async () => {
-		const result = await loadConfig(null);
-		expect(result).toEqual({});
-	});
-
-	it('reads and parses config from absolute path', async () => {
-		const config = { plugins: { analyze: { '@nitpicker/analyze-axe': true } } };
-		vi.mocked(fs.readFile).mockResolvedValue(JSON.stringify(config));
-
-		const result = await loadConfig('/absolute/path/config.json');
-
-		expect(fs.readFile).toHaveBeenCalledWith('/absolute/path/config.json', {
-			encoding: 'utf8',
-		});
-		expect(result).toEqual(config);
-	});
-
-	it('resolves relative path before reading', async () => {
-		const config = {};
-		vi.mocked(fs.readFile).mockResolvedValue(JSON.stringify(config));
-
-		await loadConfig('./relative/config.json');
-
-		const expectedPath = path.resolve('./relative/config.json');
-		expect(fs.readFile).toHaveBeenCalledWith(expectedPath, { encoding: 'utf8' });
-	});
-});

package/src/load-config.ts

@@ -1,17 +0,0 @@
-import type { ConfigJSON } from '@nitpicker/types';
-
-import fs from 'node:fs/promises';
-import path from 'node:path';
-
-/**
- *
- * @param filePath
- */
-export async function loadConfig(filePath: string | null) {
-	if (!filePath) {
-		return {};
-	}
-	const absFilePath = path.isAbsolute(filePath) ? filePath : path.resolve(filePath);
-	const data = await fs.readFile(absFilePath, { encoding: 'utf8' });
-	return JSON.parse(data) as ConfigJSON;
-}

package/src/report.ts

@@ -1,231 +0,0 @@
-import type { CreateSheet } from './sheets/types.js';
-import type { ErrorHandlerMessage } from '@d-zero/google-sheets';
-
-import { Lanes } from '@d-zero/dealer';
-import { authentication } from '@d-zero/google-auth';
-import { Sheets } from '@d-zero/google-sheets';
-import c from 'ansi-colors';
-import enquirer from 'enquirer';
-
-import { getArchive } from './archive.js';
-import { addToSummary } from './data/add-to-summary.js';
-import { createDiscrepancies } from './data/create-discrepancies.js';
-import { createImageList } from './data/create-image-list.js';
-import { createLinks } from './data/create-links.js';
-import { createPageList } from './data/create-page-list.js';
-import { createReferrersRelationalTable } from './data/create-referrers-relational-table.js';
-import { createResourcesRelationalTable } from './data/create-resources-relational-table.js';
-import { createResources } from './data/create-resources.js';
-import { createViolations } from './data/create-violations.js';
-import { archiveLog, log } from './debug.js';
-import { loadConfig } from './load-config.js';
-import { getPluginReports } from './reports/get-plugin-reports.js';
-import { createSheets } from './sheets/create-sheets.js';
-
-/**
- * Parameters for {@link report}.
- */
-export interface ReportParams {
-	/** Path to the `.nitpicker` archive file. */
-	readonly filePath: string;
-	/** URL of the target Google Spreadsheet. */
-	readonly sheetUrl: string;
-	/** Path to the OAuth2 credentials JSON file. */
-	readonly credentialFilePath: string;
-	/** Path to the nitpicker config file, or `null` for defaults. */
-	readonly configPath: string | null;
-	/** Batch size for `getPagesWithRefs()` pagination (default: 100,000). */
-	readonly limit: number;
-}
-
-/**
- * Generates a Google Sheets report from a `.nitpicker` archive file.
- *
- * This is the main entry point for the `nitpicker report` command.
- * It orchestrates the full reporting pipeline:
- *
- * 1. Authenticates with Google Sheets API using OAuth2 credentials.
- * 2. Opens the `.nitpicker` archive and loads its configuration.
- * 3. Loads analyze plugin reports from the archive.
- * 4. Presents an interactive multi-select prompt for the user to
- *    choose which sheets to generate.
- * 5. Delegates to `createSheets()` for phased data generation and upload.
- *
- * Rate limiting from the Google Sheets API (429 / 403) is handled
- * gracefully via the `Sheets.onLog` callback, which displays a
- * countdown timer in the terminal using the `Lanes` progress display.
- * @param params - レポート生成に必要なパラメータ
- * @example
- * ```ts
- * await report({
- *   filePath: './output.nitpicker',
- *   sheetUrl: 'https://docs.google.com/spreadsheets/d/xxx/edit',
- *   credentialFilePath: './credentials.json',
- *   configPath: './nitpicker.config.json',
- *   limit: 100_000,
- * });
- * ```
- */
-export async function report(params: ReportParams) {
-	const { filePath, sheetUrl, credentialFilePath, configPath, limit } = params;
-	log('Initialization');
-
-	const SCOPES = ['https://www.googleapis.com/auth/spreadsheets'] as const;
-	log('Authenticating');
-	const auth = await authentication(credentialFilePath, SCOPES, {
-		tokenFilePath: 'token.json',
-	});
-	log('Authentication succeeded');
-
-	log('Opening archive: %s', filePath);
-	const archive = await getArchive(filePath);
-	log('Archive opened');
-
-	log('Loading config');
-	const config = await loadConfig(configPath);
-	log('Config loaded');
-
-	const plugins = config.plugins?.analyze
-		? Object.keys(config.plugins.analyze)
-		: undefined;
-	log('Loaded plugins: %O', plugins);
-
-	log('Loading plugin reports');
-	const reports = await getPluginReports(archive /*plugins*/);
-	log('Plugin reports loaded: %d', reports.length);
-
-	const sheets = new Sheets(sheetUrl, auth);
-
-	log('Reporting starts');
-
-	const sheetNames = [
-		'Page List' as const,
-		'Links' as const,
-		'Resources' as const,
-		'Images' as const,
-		'Violations' as const,
-		'Discrepancies' as const,
-		'Summary' as const,
-		'Referrers Relational Table' as const,
-		'Resources Relational Table' as const,
-	];
-	type SheetNames = typeof sheetNames;
-
-	log('Choice creating data');
-	const chosenSheets = await enquirer
-		.prompt<{ sheetName: SheetNames }>([
-			{
-				message: 'What do you report?',
-				name: 'sheetName',
-				type: 'multiselect',
-				choices: sheetNames,
-			},
-		])
-		.catch(() => {
-			// enquirer v2.4.1: Ctrl+C 後に readline を二重 close して
-			// ERR_USE_AFTER_CLOSE が unhandled rejection になるため、
-			// 即座に終了して回避する
-			process.exit(0);
-		});
-
-	if (!chosenSheets) {
-		log('Choice creating data');
-		archiveLog('Closes file');
-		await archive.close();
-		return;
-	}
-
-	log('Chosen sheets: %O', chosenSheets.sheetName);
-
-	const createSheetList: CreateSheet[] = [];
-
-	if (chosenSheets.sheetName.includes('Page List')) {
-		createSheetList.push(createPageList);
-	}
-
-	if (chosenSheets.sheetName.includes('Links')) {
-		createSheetList.push(createLinks);
-	}
-
-	if (chosenSheets.sheetName.includes('Discrepancies')) {
-		createSheetList.push(createDiscrepancies);
-	}
-
-	if (chosenSheets.sheetName.includes('Violations')) {
-		createSheetList.push(createViolations);
-	}
-
-	if (chosenSheets.sheetName.includes('Referrers Relational Table')) {
-		createSheetList.push(createReferrersRelationalTable);
-	}
-
-	if (chosenSheets.sheetName.includes('Resources Relational Table')) {
-		createSheetList.push(createResourcesRelationalTable);
-	}
-
-	if (chosenSheets.sheetName.includes('Resources')) {
-		createSheetList.push(createResources);
-	}
-
-	if (chosenSheets.sheetName.includes('Images')) {
-		createSheetList.push(createImageList);
-	}
-
-	// eslint-disable-next-line no-console
-	console.log(`\nGenerating ${createSheetList.length} sheet(s)...\n`);
-
-	const lanes = new Lanes({ verbose: !process.stdout.isTTY, indent: '  ' });
-	log('Lanes created (verbose: %s)', !process.stdout.isTTY);
-
-	const RATE_LIMIT_LANE = 10_000;
-	let countdownSeq = 0;
-	let waitingCount = 0;
-
-	sheets.onLog = (message: ErrorHandlerMessage) => {
-		if (message.waiting && message.waitTime) {
-			waitingCount++;
-			const id = `rateLimit_${countdownSeq++}`;
-			const label =
-				message.message === 'TooManyRequestError'
-					? 'Too Many Requests (429)'
-					: message.message === 'UserRateLimitExceededError'
-						? 'Rate Limit Exceeded (403)'
-						: 'Connection Reset';
-			lanes.update(
-				RATE_LIMIT_LANE,
-				c.yellow(`${label}: waiting %countdown(${message.waitTime}, ${id}, s)%s`),
-			);
-		} else {
-			waitingCount--;
-			if (waitingCount <= 0) {
-				waitingCount = 0;
-				lanes.delete(RATE_LIMIT_LANE);
-			}
-		}
-	};
-
-	log('Reporting starts (limit: %d)', limit);
-	try {
-		await createSheets({
-			sheets,
-			archive,
-			reports,
-			limit,
-			createSheetList,
-			options: { lanes },
-		});
-	} finally {
-		lanes.close();
-	}
-	log('Reporting done');
-	// eslint-disable-next-line no-console
-	console.log('\nReport complete.');
-
-	if (chosenSheets.sheetName.includes('Summary')) {
-		await addToSummary(/*sheets, archive, reports*/);
-	}
-
-	archiveLog('Closes file');
-	await archive.close();
-	log('Done');
-}

package/src/reports/get-plugin-reports.spec.ts

@@ -1,42 +0,0 @@
-import type { Report } from '@nitpicker/types';
-
-import { describe, it, expect, vi } from 'vitest';
-
-import { getPluginReports } from './get-plugin-reports.js';
-
-describe('getPluginReports', () => {
-	it('returns report when archive has analysis data', async () => {
-		const report: Report = {
-			name: 'test-plugin',
-			violations: [],
-		};
-		const archive = {
-			getData: vi.fn().mockResolvedValue(report),
-		};
-
-		const result = await getPluginReports(archive as never);
-
-		expect(archive.getData).toHaveBeenCalledWith('analysis/report');
-		expect(result).toEqual([report]);
-	});
-
-	it('returns empty array when archive has no analysis data', async () => {
-		const archive = {
-			getData: vi.fn().mockResolvedValue(null),
-		};
-
-		const result = await getPluginReports(archive as never);
-
-		expect(result).toEqual([]);
-	});
-
-	it('returns empty array when getData throws', async () => {
-		const archive = {
-			getData: vi.fn().mockRejectedValue(new Error('not found')),
-		};
-
-		const result = await getPluginReports(archive as never);
-
-		expect(result).toEqual([]);
-	});
-});

package/src/reports/get-plugin-reports.ts

@@ -1,24 +0,0 @@
-import type { Archive } from '@nitpicker/crawler';
-import type { Report } from '@nitpicker/types';
-
-import { reportLog } from '../debug.js';
-
-/**
- *
- * @param archive
- */
-export async function getPluginReports(archive: Archive) {
-	const reports: Report[] = [];
-
-	reportLog('Load');
-	try {
-		const report = await archive.getData<Report>('analysis/report');
-		if (report) {
-			reports.push(report);
-		}
-	} catch {
-		reportLog('Failed: report is not found');
-	}
-
-	return reports;
-}

package/src/sheets/create-cell-data.ts

@@ -1 +0,0 @@
-export { createCellData } from '@d-zero/google-sheets';