@percy/cli-config 1.0.0 → 1.0.1

package/dist/config.js

@@ -0,0 +1,9 @@
+import command from '@percy/cli-command';
+import create from './create.js';
+import validate from './validate.js';
+import migrate from './migrate.js';
+export const config = command('config', {
+  description: 'Manage Percy config files',
+  commands: [create, validate, migrate]
+});
+export default config;

package/dist/create.js

@@ -0,0 +1,73 @@
+import fs from 'fs';
+import path from 'path';
+import command, { PercyConfig } from '@percy/cli-command';
+const DEFAULT_FILES = {
+  rc: '.percyrc',
+  yaml: '.percy.yaml',
+  yml: '.percy.yml',
+  json: '.percy.json',
+  js: '.percy.js'
+};
+const FILETYPES = Object.keys(DEFAULT_FILES);
+export const create = command('create', {
+  description: 'Create a Percy config file',
+  args: [{
+    name: 'filepath',
+    description: 'Optional config filepath'
+  }],
+  flags: [{
+    name: 'rc',
+    description: 'Create a .percyrc file',
+    conflicts: FILETYPES.filter(t => t !== 'rc'),
+    type: 'boolean'
+  }, {
+    name: 'yaml',
+    description: 'Create a .percy.yaml file',
+    conflicts: FILETYPES.filter(t => t !== 'yaml'),
+    type: 'boolean'
+  }, {
+    name: 'yml',
+    description: 'Create a .percy.yml file',
+    conflicts: FILETYPES.filter(t => t !== 'yml'),
+    type: 'boolean'
+  }, {
+    name: 'json',
+    description: 'Create a .percy.json file',
+    conflicts: FILETYPES.filter(t => t !== 'json'),
+    type: 'boolean'
+  }, {
+    name: 'js',
+    description: 'Create a .percy.js file',
+    conflicts: FILETYPES.filter(t => t !== 'js'),
+    type: 'boolean'
+  }],
+  examples: ['$0', '$0 --yaml', '$0 --json', '$0 --js', '$0 --rc', '$0 ./config/percy.yml']
+}, async ({
+  flags,
+  args,
+  log,
+  exit
+}) => {
+  // discern the filetype
+  let filetype = args.filepath ? path.extname(args.filepath).replace(/^./, '') : FILETYPES.find(t => flags[t]) ?? 'yml'; // verify the filetype is supported
+
+  if (!DEFAULT_FILES[filetype]) {
+    exit(1, `Unsupported filetype: ${filetype}`);
+  } // default filepath based on filetype
+
+
+  let filepath = args.filepath || DEFAULT_FILES[filetype]; // verify the file does not already exist
+
+  if (fs.existsSync(filepath)) {
+    exit(1, `Percy config already exists: ${filepath}`);
+  } // write stringified default config options to the filepath
+
+
+  let format = ['rc', 'yaml', 'yml'].includes(filetype) ? 'yaml' : filetype;
+  fs.mkdirSync(path.dirname(filepath), {
+    recursive: true
+  });
+  fs.writeFileSync(filepath, PercyConfig.stringify(format));
+  log.info(`Created Percy config: ${filepath}`);
+});
+export default create;

package/dist/index.js

@@ -0,0 +1,4 @@
+export { default, config } from './config.js';
+export { create } from './create.js';
+export { validate } from './validate.js';
+export { migrate } from './migrate.js';

package/dist/migrate.js

@@ -0,0 +1,81 @@
+import fs from 'fs';
+import path from 'path';
+import command, { PercyConfig } from '@percy/cli-command';
+export const migrate = command('migrate', {
+  description: 'Migrate a Percy config file to the latest version',
+  args: [{
+    name: 'filepath',
+    description: 'Current config filepath, detected by default'
+  }, {
+    name: 'output',
+    description: 'New config filepath to write to, defaults to \'filepath\''
+  }],
+  flags: [{
+    name: 'dry-run',
+    description: 'Print the new config without writing it',
+    short: 'd'
+  }],
+  examples: ['$0', '$0 --dry-run', '$0 ./config/percy.yml', '$0 .percy.yml .percy.js']
+}, async ({
+  args,
+  flags,
+  log,
+  exit
+}) => {
+  let {
+    config,
+    filepath: input
+  } = PercyConfig.search(args.filepath);
+  let output = args.output ? path.resolve(args.output) : input;
+  if (!config) exit(1, 'Config file not found');
+  log.info(`Found config file: ${path.relative('', input)}`); // if migrating versions, warn when latest
+
+  if (input === output && config.version === 2) {
+    exit(0, 'Config is already the latest version');
+  } // migrate config
+
+
+  log.info('Migrating config file...');
+  let format = path.extname(output).replace(/^./, '') || 'yaml';
+  let migrated = PercyConfig.migrate(config); // prefer kebab-case for yaml
+
+  if (/^ya?ml$/.test(format)) {
+    migrated = PercyConfig.normalize(migrated, {
+      schema: '/config',
+      kebab: true
+    });
+  } // stringify to the desired format
+
+
+  let body = PercyConfig.stringify(format, migrated);
+
+  if (!flags.dryRun) {
+    let content = body;
+
+    if (path.basename(output) === 'package.json') {
+      // update the package.json entry by reading and modifying it
+      let pkg = JSON.parse(fs.readFileSync(output));
+      content = PercyConfig.stringify(format, { ...pkg,
+        percy: migrated
+      });
+    } else if (input === output) {
+      // rename input if it is the output
+      let {
+        dir,
+        name,
+        ext
+      } = path.parse(input);
+      fs.renameSync(input, path.join(dir, `${name}.old${ext}`));
+    } // write to output
+
+
+    fs.writeFileSync(output, content);
+  }
+
+  log.info('Config file migrated!'); // when dry-running, print config to stdout when finished
+
+  if (flags.dryRun) {
+    log.stdout.write('\n' + body);
+  }
+});
+export default migrate;

package/dist/validate.js

@@ -0,0 +1,29 @@
+import command, { PercyConfig } from '@percy/cli-command';
+export const validate = command('validate', {
+  description: 'Validate a Percy config file',
+  args: [{
+    name: 'filepath',
+    description: 'Config filepath, detected by default'
+  }],
+  examples: ['$0', '$0 ./config/percy.yml']
+}, async ({
+  args,
+  log,
+  exit
+}) => {
+  // verify a config file can be located
+  let {
+    config,
+    filepath
+  } = PercyConfig.search(args.filepath);
+  if (!config) exit(1, 'Config file not found'); // when `bail` is true, .load() returns undefined when validation fails
+
+  let result = PercyConfig.load({
+    path: filepath,
+    print: true,
+    bail: true
+  }); // exit 1 when config is empty
+
+  if (!result) exit(1);
+});
+export default validate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-config",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -14,7 +14,7 @@
     "node": ">=14"
   },
   "files": [
-    "./dist"
+    "dist"
   ],
   "main": "./dist/index.js",
   "type": "module",
@@ -32,7 +32,7 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.0.0"
+    "@percy/cli-command": "1.0.1"
   },
-  "gitHead": "6df509421a60144e4f9f5d59dc57a5675372a0b2"
+  "gitHead": "38917e6027299d6cd86008e2ccd005d90bbf89c0"
 }