From 8a331bb38e847d80370ae719771dcfb7087231e5 Mon Sep 17 00:00:00 2001 From: Dave Lockhart Date: Tue, 9 Jul 2024 17:11:31 -0400 Subject: [PATCH] fix: split paths out into its own file (#431) --- src/server/cli/vdiff/migrate.js | 2 +- src/server/cli/vdiff/report.js | 2 +- src/server/paths.js | 15 +++++++++++++++ src/server/rollup.config.js | 2 +- src/server/visual-diff-plugin.js | 11 +---------- src/server/visual-diff-reporter.js | 3 ++- test/browser/vdiff.config.js | 2 +- 7 files changed, 22 insertions(+), 15 deletions(-) create mode 100644 src/server/paths.js diff --git a/src/server/cli/vdiff/migrate.js b/src/server/cli/vdiff/migrate.js index 0e44cbce..7b979d22 100755 --- a/src/server/cli/vdiff/migrate.js +++ b/src/server/cli/vdiff/migrate.js @@ -3,7 +3,7 @@ import { appendFile, mkdir, readFile, rename, rm } from 'node:fs/promises'; import { join, normalize, parse } from 'node:path'; import commandLineArgs from 'command-line-args'; import { glob } from 'glob'; -import { PATHS } from '../../visual-diff-plugin.js'; +import { PATHS } from '../../paths.js'; import { stdout } from 'node:process'; async function start(argv = [], local = false) { diff --git a/src/server/cli/vdiff/report.js b/src/server/cli/vdiff/report.js index 79d468b7..d3a7a891 100644 --- a/src/server/cli/vdiff/report.js +++ b/src/server/cli/vdiff/report.js @@ -1,5 +1,5 @@ #!/usr/bin/env node -import { PATHS } from '../../visual-diff-plugin.js'; +import { PATHS } from '../../paths.js'; import { startDevServer } from '@web/dev-server'; export const report = { diff --git a/src/server/paths.js b/src/server/paths.js new file mode 100644 index 00000000..8e91f07e --- /dev/null +++ b/src/server/paths.js @@ -0,0 +1,15 @@ +import { env } from 'node:process'; +import { join } from 'node:path'; + +const isCI = !!env['CI']; +const METADATA_NAME = '.vdiff.json'; +const ROOT_NAME = '.vdiff'; + +export const PATHS = { + FAIL: 'fail', + GOLDEN: 'golden', + PASS: 'pass', + METADATA: isCI ? METADATA_NAME : join(ROOT_NAME, METADATA_NAME), + REPORT_ROOT: '.report', + VDIFF_ROOT: ROOT_NAME +}; diff --git a/src/server/rollup.config.js b/src/server/rollup.config.js index 5087748f..0b8baebe 100644 --- a/src/server/rollup.config.js +++ b/src/server/rollup.config.js @@ -2,7 +2,7 @@ import { cwd } from 'node:process'; import { rollupPluginHTML as html } from '@web/rollup-plugin-html'; import { join } from 'path'; import { nodeResolve } from '@rollup/plugin-node-resolve'; -import { PATHS } from './visual-diff-plugin.js'; +import { PATHS } from './paths.js'; export default { input: join(cwd(), PATHS.VDIFF_ROOT, PATHS.REPORT_ROOT, './temp/index.html'), diff --git a/src/server/visual-diff-plugin.js b/src/server/visual-diff-plugin.js index b2046faf..81790134 100644 --- a/src/server/visual-diff-plugin.js +++ b/src/server/visual-diff-plugin.js @@ -1,21 +1,12 @@ import { access, constants, mkdir, readdir, readFile, rename, rm, stat, writeFile } from 'node:fs/promises'; import { basename, dirname, join } from 'node:path'; import { env } from 'node:process'; +import { PATHS } from './paths.js'; import pixelmatch from 'pixelmatch'; import { PNG } from 'pngjs'; const isCI = !!env['CI']; const DEFAULT_TOLERANCE = 0; // TODO: Support tolerance override? -const METADATA_NAME = '.vdiff.json'; -const ROOT_NAME = '.vdiff'; -export const PATHS = { - FAIL: 'fail', - GOLDEN: 'golden', - PASS: 'pass', - METADATA: isCI ? METADATA_NAME : join(ROOT_NAME, METADATA_NAME), - REPORT_ROOT: '.report', - VDIFF_ROOT: ROOT_NAME -}; async function checkFileExists(fileName) { try { diff --git a/src/server/visual-diff-reporter.js b/src/server/visual-diff-reporter.js index a27ff2f7..27a05591 100644 --- a/src/server/visual-diff-reporter.js +++ b/src/server/visual-diff-reporter.js @@ -1,9 +1,10 @@ import { cpSync, existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from 'node:fs'; import { dirname, join } from 'node:path'; -import { getTestInfo, PATHS } from './visual-diff-plugin.js'; import { env } from 'node:process'; import { execSync } from 'node:child_process'; import { fileURLToPath } from 'node:url'; +import { getTestInfo } from './visual-diff-plugin.js'; +import { PATHS } from './paths.js'; const __dirname = dirname(fileURLToPath(import.meta.url)); const isCI = !!env['CI']; diff --git a/test/browser/vdiff.config.js b/test/browser/vdiff.config.js index 44910371..f5ca024e 100644 --- a/test/browser/vdiff.config.js +++ b/test/browser/vdiff.config.js @@ -1,7 +1,7 @@ import { argv, env } from 'node:process'; import { dirname, join } from 'node:path'; import { readFile, writeFile } from 'node:fs/promises'; -import { PATHS } from '../../src/server/visual-diff-plugin.js'; +import { PATHS } from '../../src/server/paths.js'; import { PNG } from 'pngjs'; const isCI = !!env['CI'];