@nitpicker/report-google-sheets 0.4.1 → 0.4.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nitpicker/report-google-sheets",
-	"version": "0.4.1",
+	"version": "0.4.3",
 	"description": "Nitpicker reporter that outputs crawl and analysis results to Google Sheets",
 	"author": "D-ZERO",
 	"license": "Apache-2.0",
@@ -12,6 +12,9 @@
 	"publishConfig": {
 		"access": "public"
 	},
+	"files": [
+		"lib"
+	],
 	"type": "module",
 	"exports": {
 		".": {
@@ -28,8 +31,8 @@
 		"@d-zero/google-auth": "0.5.6",
 		"@d-zero/google-sheets": "0.6.0",
 		"@d-zero/shared": "0.20.0",
-		"@nitpicker/crawler": "0.4.1",
-		"@nitpicker/types": "0.4.1",
+		"@nitpicker/crawler": "0.4.3",
+		"@nitpicker/types": "0.4.3",
 		"ansi-colors": "4.1.3",
 		"debug": "4.4.3",
 		"enquirer": "2.4.1",
@@ -41,5 +44,5 @@
 		"googleapis": "171.4.0",
 		"vitest": "4.0.18"
 	},
-	"gitHead": "32b83ee38eba7dfd237adb1b41f69e049e8d4ceb"
+	"gitHead": "0f4ca55751be2f83dd5b6622c3502503fc7dfb41"
 }

package/CHANGELOG.md

@@ -1,8 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [0.4.1](https://github.com/d-zero-dev/nitpicker/compare/v0.4.0...v0.4.1) (2026-02-27)
-
-**Note:** Version bump only for package @nitpicker/report-google-sheets

package/src/__tests__/api/create-sheets.api.ts

@@ -1,234 +0,0 @@
-import type { Auth } from '@d-zero/google-auth';
-import type { Report } from '@nitpicker/types';
-
-import { Sheets } from '@d-zero/google-sheets';
-import { google } from 'googleapis';
-import { afterAll, afterEach, beforeAll, describe, expect, it } from 'vitest';
-
-import { createLinks } from '../../data/create-links.js';
-import { createPageList } from '../../data/create-page-list.js';
-import { createResources } from '../../data/create-resources.js';
-import { createViolations } from '../../data/create-violations.js';
-import { createSheets } from '../../sheets/create-sheets.js';
-
-import {
-	type CrawlResult,
-	SPREADSHEET_ID,
-	SPREADSHEET_URL,
-	cleanupCrawl,
-	crawlTestServer,
-	deleteSheet,
-	getAuth,
-	readSheetValues,
-	testSheetName,
-} from './helpers.js';
-
-describe('createSheets pipeline', () => {
-	let auth: Auth;
-	let crawlResult: CrawlResult;
-	const createdSheetIds: number[] = [];
-	const emptyReports: Report[] = [];
-
-	beforeAll(async () => {
-		auth = await getAuth();
-		crawlResult = await crawlTestServer(['http://localhost:8010/'], {
-			recursive: true,
-			fetchExternal: false,
-		});
-	});
-
-	afterEach(async () => {
-		for (const sheetId of createdSheetIds) {
-			try {
-				await deleteSheet(auth, SPREADSHEET_ID, sheetId);
-			} catch {
-				// already deleted or not found
-			}
-		}
-		createdSheetIds.length = 0;
-	});
-
-	afterAll(async () => {
-		if (crawlResult) {
-			await cleanupCrawl(crawlResult);
-		}
-	});
-
-	it('Violations シートを正しく生成できる', async () => {
-		const sheetName = testSheetName('violations');
-		const sheets = new Sheets(SPREADSHEET_URL, auth);
-
-		const createTestViolations = () => {
-			const setting = createViolations(emptyReports);
-			return { ...setting, name: sheetName };
-		};
-
-		await createSheets({
-			sheets,
-			archive: crawlResult.archive,
-			reports: emptyReports,
-			limit: 100,
-			createSheetList: [createTestViolations],
-		});
-
-		const sheet = await sheets.create(sheetName);
-		createdSheetIds.push(sheet.id);
-
-		// Verify headers
-		const values = await readSheetValues(auth, SPREADSHEET_ID, `'${sheetName}'!A1:F1`);
-		expect(values[0]).toEqual([
-			'Validator',
-			'Severity',
-			'Rule',
-			'Code',
-			'Message',
-			'URL',
-		]);
-
-		// No data rows since reports are empty
-		const allValues = await readSheetValues(
-			auth,
-			SPREADSHEET_ID,
-			`'${sheetName}'!A1:F100`,
-		);
-		expect(allValues.length).toBe(1); // header only
-	});
-
-	it('Page List シートを正しく生成できる', async () => {
-		const sheetName = testSheetName('pagelist');
-		const sheets = new Sheets(SPREADSHEET_URL, auth);
-
-		const createTestPageList = () => {
-			const setting = createPageList(emptyReports);
-			return { ...setting, name: sheetName };
-		};
-
-		await createSheets({
-			sheets,
-			archive: crawlResult.archive,
-			reports: emptyReports,
-			limit: 100,
-			createSheetList: [createTestPageList],
-		});
-
-		const sheet = await sheets.create(sheetName);
-		createdSheetIds.push(sheet.id);
-
-		// Verify headers contain expected columns
-		const headerValues = await readSheetValues(
-			auth,
-			SPREADSHEET_ID,
-			`'${sheetName}'!A1:AK1`,
-		);
-		const headers = headerValues[0]!;
-		expect(headers).toContain('Title');
-		expect(headers).toContain('URL');
-		expect(headers).toContain('Status Code');
-		expect(headers).toContain('Internal Links');
-		expect(headers).toContain('External Links');
-
-		// Verify data rows exist (at least 1 page from test server)
-		const allValues = await readSheetValues(
-			auth,
-			SPREADSHEET_ID,
-			`'${sheetName}'!A1:A100`,
-		);
-		expect(allValues.length).toBeGreaterThan(1); // header + at least 1 data row
-
-		// Verify frozen panes and conditional format were applied
-		const sheetsApi = google.sheets({ version: 'v4', auth: auth as unknown });
-		const res = await sheetsApi.spreadsheets.get({
-			spreadsheetId: SPREADSHEET_ID,
-			includeGridData: false,
-			fields: 'sheets(properties,conditionalFormats)',
-		});
-		const targetSheet = res.data.sheets?.find((s) => s.properties?.sheetId === sheet.id);
-
-		expect(targetSheet?.properties?.gridProperties?.frozenColumnCount).toBe(1);
-		expect(targetSheet?.properties?.gridProperties?.frozenRowCount).toBe(1);
-		expect(targetSheet?.conditionalFormats).toBeDefined();
-		expect(targetSheet!.conditionalFormats!.length).toBeGreaterThanOrEqual(1);
-	});
-
-	it('Links シートを正しく生成できる', async () => {
-		const sheetName = testSheetName('links');
-		const sheets = new Sheets(SPREADSHEET_URL, auth);
-
-		const createTestLinks = () => {
-			const setting = createLinks(emptyReports);
-			return { ...setting, name: sheetName };
-		};
-
-		await createSheets({
-			sheets,
-			archive: crawlResult.archive,
-			reports: emptyReports,
-			limit: 100,
-			createSheetList: [createTestLinks],
-		});
-
-		const sheet = await sheets.create(sheetName);
-		createdSheetIds.push(sheet.id);
-
-		// Verify headers
-		const headerValues = await readSheetValues(
-			auth,
-			SPREADSHEET_ID,
-			`'${sheetName}'!A1:H1`,
-		);
-		expect(headerValues[0]).toEqual([
-			'URL',
-			'Page Title',
-			'Status Code',
-			'Status Text',
-			'Content Type',
-			'Redirect From',
-			'Referrers',
-			'Headers',
-		]);
-
-		// Verify data rows exist (links from test server pages)
-		const allValues = await readSheetValues(
-			auth,
-			SPREADSHEET_ID,
-			`'${sheetName}'!A1:A100`,
-		);
-		expect(allValues.length).toBeGreaterThan(1);
-	});
-
-	it('Resources シートを正しく生成できる', async () => {
-		const sheetName = testSheetName('resources');
-		const sheets = new Sheets(SPREADSHEET_URL, auth);
-
-		const createTestResources = () => {
-			const setting = createResources(emptyReports);
-			return { ...setting, name: sheetName };
-		};
-
-		await createSheets({
-			sheets,
-			archive: crawlResult.archive,
-			reports: emptyReports,
-			limit: 100,
-			createSheetList: [createTestResources],
-		});
-
-		const sheet = await sheets.create(sheetName);
-		createdSheetIds.push(sheet.id);
-
-		// Verify headers
-		const headerValues = await readSheetValues(
-			auth,
-			SPREADSHEET_ID,
-			`'${sheetName}'!A1:F1`,
-		);
-		expect(headerValues[0]).toEqual([
-			'URL',
-			'Status Code',
-			'Status Text',
-			'Content Type',
-			'Content Length',
-			'Referrers',
-		]);
-	});
-});

package/src/__tests__/api/helpers.ts

@@ -1,148 +0,0 @@
-import type { Auth } from '@d-zero/google-auth';
-import type { Archive } from '@nitpicker/crawler';
-import type { sheets_v4 } from 'googleapis';
-
-import crypto from 'node:crypto';
-import fs from 'node:fs/promises';
-import os from 'node:os';
-import path from 'node:path';
-
-import { authentication } from '@d-zero/google-auth';
-import { CrawlerOrchestrator } from '@nitpicker/crawler';
-import { google } from 'googleapis';
-
-const SPREADSHEET_ID = (() => {
-	const id = process.env.TEST_SPREADSHEET_ID;
-	if (!id) {
-		throw new Error('TEST_SPREADSHEET_ID environment variable is required for API tests');
-	}
-	return id;
-})();
-const SPREADSHEET_URL = `https://docs.google.com/spreadsheets/d/${SPREADSHEET_ID}/edit`;
-const SCOPES = ['https://www.googleapis.com/auth/spreadsheets'] as const;
-
-export { SPREADSHEET_ID, SPREADSHEET_URL };
-
-/**
- *
- */
-export async function getAuth(): Promise<Auth> {
-	const credentialFilePath = process.env.TEST_CREDENTIALS_PATH ?? 'credentials.json';
-	const tokenFilePath = process.env.TEST_TOKEN_PATH ?? 'token.json';
-	return authentication(credentialFilePath, SCOPES, { tokenFilePath });
-}
-
-/**
- *
- * @param auth
- * @param spreadsheetId
- * @param sheetId
- */
-export async function deleteSheet(
-	auth: Auth,
-	spreadsheetId: string,
-	sheetId: number,
-): Promise<void> {
-	const sheets = google.sheets({ version: 'v4', auth: auth as unknown });
-	await sheets.spreadsheets.batchUpdate({
-		spreadsheetId,
-		requestBody: {
-			requests: [{ deleteSheet: { sheetId } }],
-		},
-	});
-}
-
-/**
- *
- * @param auth
- * @param spreadsheetId
- * @param range
- */
-export async function readSheetValues(
-	auth: Auth,
-	spreadsheetId: string,
-	range: string,
-): Promise<string[][]> {
-	const sheets = google.sheets({ version: 'v4', auth: auth as unknown });
-	const res = await sheets.spreadsheets.values.get({
-		spreadsheetId,
-		range,
-	});
-	return (res.data.values as string[][]) || [];
-}
-
-/**
- *
- * @param auth
- * @param spreadsheetId
- * @param sheetId
- */
-export async function getSheetProperties(
-	auth: Auth,
-	spreadsheetId: string,
-	sheetId: number,
-): Promise<sheets_v4.Schema$Sheet | undefined> {
-	const sheets = google.sheets({ version: 'v4', auth: auth as unknown });
-	const res = await sheets.spreadsheets.get({
-		spreadsheetId,
-		includeGridData: false,
-	});
-	return res.data.sheets?.find((s) => s.properties?.sheetId === sheetId);
-}
-
-/**
- *
- * @param prefix
- */
-export function testSheetName(prefix: string): string {
-	return `__test_${prefix}_${Date.now()}`;
-}
-
-export interface CrawlResult {
-	archive: Archive;
-	tmpDir: string;
-	cwd: string;
-}
-
-/**
- *
- * @param urls
- * @param options
- */
-export async function crawlTestServer(
-	urls: string[],
-	options?: Record<string, unknown>,
-): Promise<CrawlResult> {
-	const cwd = path.join(os.tmpdir(), `nitpicker-api-${crypto.randomUUID()}`);
-	await fs.mkdir(cwd, { recursive: true });
-
-	const orchestrator = await CrawlerOrchestrator.crawling(
-		urls,
-		{
-			cwd,
-			interval: 0,
-			parallels: 1,
-			image: false,
-			...options,
-		},
-		(q) => {
-			q.on('error', (e) => {
-				console.error('[nitpicker:api-test] error:', e); // eslint-disable-line no-console
-			});
-		},
-	);
-
-	return {
-		archive: orchestrator.archive,
-		tmpDir: orchestrator.archive.tmpDir,
-		cwd,
-	};
-}
-
-/**
- *
- * @param result
- */
-export async function cleanupCrawl(result: CrawlResult) {
-	await fs.rm(result.cwd, { recursive: true, force: true });
-}

package/src/__tests__/api/sheets.api.ts

@@ -1,217 +0,0 @@
-import type { Auth } from '@d-zero/google-auth';
-
-import { Sheets } from '@d-zero/google-sheets';
-import { google } from 'googleapis';
-import { afterAll, beforeAll, describe, expect, it } from 'vitest';
-
-import { createCellData } from '../../sheets/create-cell-data.js';
-import { defaultCellFormat } from '../../sheets/default-cell-format.js';
-
-import {
-	SPREADSHEET_ID,
-	SPREADSHEET_URL,
-	deleteSheet,
-	getAuth,
-	getSheetProperties,
-	readSheetValues,
-	testSheetName,
-} from './helpers.js';
-
-describe('Sheets class', () => {
-	let auth: Auth;
-	let sheets: Sheets;
-	const createdSheetIds: number[] = [];
-
-	beforeAll(async () => {
-		auth = await getAuth();
-		sheets = new Sheets(SPREADSHEET_URL, auth);
-	});
-
-	afterAll(async () => {
-		for (const sheetId of createdSheetIds) {
-			try {
-				await deleteSheet(auth, SPREADSHEET_ID, sheetId);
-			} catch {
-				// already deleted or not found
-			}
-		}
-	});
-
-	it('create() で新規シートを作成できる', async () => {
-		const name = testSheetName('new');
-		const sheet = await sheets.create(name);
-		createdSheetIds.push(sheet.id);
-
-		expect(sheet.id).toBeTypeOf('number');
-		expect(sheet.props.title).toBe(name);
-	});
-
-	it('create() で既存シートを返す（キャッシュ）', async () => {
-		const name = testSheetName('cache');
-		const sheet1 = await sheets.create(name);
-		createdSheetIds.push(sheet1.id);
-
-		const sheet2 = await sheets.create(name);
-
-		expect(sheet2.id).toBe(sheet1.id);
-	});
-});
-
-describe('Sheet class — addRowData', () => {
-	let auth: Auth;
-	let sheets: Sheets;
-	let sheetName: string;
-	let sheetId: number;
-
-	beforeAll(async () => {
-		auth = await getAuth();
-		sheets = new Sheets(SPREADSHEET_URL, auth);
-
-		// Use a single sheet for all addRowData tests
-		sheetName = testSheetName('rowdata');
-		const sheet = await sheets.create(sheetName);
-		sheetId = sheet.id;
-
-		// Write header
-		const headers = ['String', 'Number', 'Boolean', 'Null', 'Formula', 'Link'];
-		const headerRow = headers.map((h) =>
-			createCellData({ value: h, textFormat: { bold: true } }, defaultCellFormat),
-		);
-		await sheet.addRowData([headerRow], false);
-
-		// Write data row
-		const dataRow = [
-			createCellData({ value: 'hello world' }, defaultCellFormat),
-			createCellData({ value: 42 }, defaultCellFormat),
-			createCellData({ value: true }, defaultCellFormat),
-			createCellData({ value: null }, defaultCellFormat),
-			createCellData({ value: '=1+2' }, defaultCellFormat),
-			createCellData(
-				{
-					value: 'https://example.com',
-					textFormat: { link: { uri: 'https://example.com' } },
-				},
-				defaultCellFormat,
-			),
-		];
-		await sheet.addRowData([dataRow], true);
-	});
-
-	afterAll(async () => {
-		try {
-			await deleteSheet(auth, SPREADSHEET_ID, sheetId);
-		} catch {
-			// ignore
-		}
-	});
-
-	it('ヘッダー行が正しく書き込まれている', async () => {
-		const values = await readSheetValues(auth, SPREADSHEET_ID, `'${sheetName}'!A1:F1`);
-		expect(values[0]).toEqual(['String', 'Number', 'Boolean', 'Null', 'Formula', 'Link']);
-	});
-
-	it('データ行の各セル型が正しく書き込まれている', async () => {
-		const values = await readSheetValues(auth, SPREADSHEET_ID, `'${sheetName}'!A2:F2`);
-		const row = values[0]!;
-		expect(row[0]).toBe('hello world');
-		expect(row[1]).toBe('42');
-		expect(row[2]).toBe('TRUE');
-		expect(row[3]).toBe(''); // null renders as empty string
-		expect(row[4]).toBe('3'); // =1+2 evaluated
-		expect(row[5]).toBe('https://example.com'); // HYPERLINK shows decoded URL
-	});
-});
-
-describe('Sheet class — formatting', () => {
-	let auth: Auth;
-	let sheets: Sheets;
-	let sheetName: string;
-	let sheetId: number;
-
-	beforeAll(async () => {
-		auth = await getAuth();
-		sheets = new Sheets(SPREADSHEET_URL, auth);
-
-		// Use a single sheet for all formatting tests
-		sheetName = testSheetName('format');
-		const sheet = await sheets.create(sheetName);
-		sheetId = sheet.id;
-
-		// Write enough data to enable frozen/hideCol
-		const headerRow = [
-			createCellData({ value: 'Col1' }, defaultCellFormat),
-			createCellData({ value: 'Col2' }, defaultCellFormat),
-			createCellData({ value: 'Col3' }, defaultCellFormat),
-		];
-		const dataRows = Array.from({ length: 3 }, () => [
-			createCellData({ value: 'A' }, defaultCellFormat),
-			createCellData({ value: 'B' }, defaultCellFormat),
-			createCellData({ value: 'C' }, defaultCellFormat),
-		]);
-		await sheet.addRowData([headerRow], false);
-		await sheet.addRowData(dataRows, true);
-
-		// Apply all formatting at once
-		await sheet.frozen(1, 1);
-		await sheet.hideCol(2);
-		await sheet.conditionalFormat([0], {
-			booleanRule: {
-				condition: {
-					type: 'NUMBER_GREATER_THAN_EQ',
-					values: [{ userEnteredValue: '400' }],
-				},
-				format: {
-					backgroundColor: { red: 0.9 },
-					textFormat: {
-						foregroundColor: { red: 1, green: 1, blue: 1 },
-					},
-				},
-			},
-		});
-	});
-
-	afterAll(async () => {
-		try {
-			await deleteSheet(auth, SPREADSHEET_ID, sheetId);
-		} catch {
-			// ignore
-		}
-	});
-
-	it('frozen() で行列が固定されている', async () => {
-		const sheetData = await getSheetProperties(auth, SPREADSHEET_ID, sheetId);
-		expect(sheetData?.properties?.gridProperties?.frozenColumnCount).toBe(1);
-		expect(sheetData?.properties?.gridProperties?.frozenRowCount).toBe(1);
-	});
-
-	it('hideCol() で列が非表示になっている', async () => {
-		const sheetsApi = google.sheets({ version: 'v4', auth: auth as unknown });
-		const res = await sheetsApi.spreadsheets.get({
-			spreadsheetId: SPREADSHEET_ID,
-			includeGridData: false,
-			fields: 'sheets(properties,data.columnMetadata)',
-			ranges: [`'${sheetName}'`],
-		});
-		const targetSheet = res.data.sheets?.[0];
-		const colMetadata = targetSheet?.data?.[0]?.columnMetadata;
-		expect(colMetadata?.[2]?.hiddenByUser).toBe(true);
-	});
-
-	it('conditionalFormat() で条件付き書式が設定されている', async () => {
-		const sheetsApi = google.sheets({ version: 'v4', auth: auth as unknown });
-		const res = await sheetsApi.spreadsheets.get({
-			spreadsheetId: SPREADSHEET_ID,
-			includeGridData: false,
-			fields: 'sheets(properties,conditionalFormats)',
-		});
-		const targetSheet = res.data.sheets?.find((s) => s.properties?.sheetId === sheetId);
-		const formats = targetSheet?.conditionalFormats;
-		expect(formats).toBeDefined();
-		expect(formats!.length).toBeGreaterThanOrEqual(1);
-
-		const rule = formats![0]!;
-		expect(rule.booleanRule?.condition?.type).toBe('NUMBER_GREATER_THAN_EQ');
-		expect(rule.ranges?.[0]?.startColumnIndex).toBe(0);
-		expect(rule.ranges?.[0]?.endColumnIndex).toBe(1);
-	});
-});

package/src/archive.ts

@@ -1,29 +0,0 @@
-import { Archive } from '@nitpicker/crawler';
-
-import { archiveLog } from './debug.js';
-
-/**
- *
- * @param filePath
- */
-export async function getArchive(filePath: string) {
-	archiveLog('Open file: %s', filePath);
-	const archive = await Archive.open({
-		filePath,
-		openPluginData: true,
-	});
-	archiveLog('File open succeeded');
-
-	const close = async () => {
-		await archive.close();
-		process.exit();
-	};
-
-	archiveLog('Bind close method to SIGINT, SIGBREAK, SIGHUP, SIGABRT events');
-	process.on('SIGINT', close);
-	process.on('SIGBREAK', close);
-	process.on('SIGHUP', close);
-	process.on('SIGABRT', close);
-
-	return archive;
-}

package/src/data/add-to-summary.ts

@@ -1,10 +0,0 @@
-/**
- * Placeholder for the "Summary" sheet generation.
- *
- * Intended to aggregate key metrics from all other sheets into a
- * single overview tab. Not yet implemented; calling this function
- * is currently a no-op.
- */
-export async function addToSummary() {
-	// Not yet implemented
-}