@shopify/slate/src/index.js

Slate CLI tools

#!/usr/bin/env node

import {readdirSync} from 'fs';
import {join, normalize} from 'path';
import {yellow, red} from 'chalk';
import figures from 'figures';
import findRoot from 'find-root';
import updateNotifier from 'update-notifier';
import program from '@shopify/commander';
import {hasDependency} from './utils';

/**
 * Find closest package.json to be at root of theme.
 *
 * @param {string} directory - A path.
 */
function getThemeRoot(directory) {
  try {
    return normalize(findRoot(directory));
  } catch (err) {
    return null;
  }
}

/**
 * Check package.json for slate-tools.
 *
 * @param {string} themeRoot - The path for the root of the theme.
 */
function checkForSlateTools(themeRoot) {
  const pkgPath = join(themeRoot, 'package.json');
  const pkg = require(pkgPath);

  return hasDependency('@shopify/slate-tools', pkg);
}

/**
 * Output information if/else slate theme directory.
 *
 * @param {boolean} isSlateTheme - Whether in slate theme or not.
 */
function outputSlateThemeCheck(isSlateTheme) {
  if (isSlateTheme) {
    return;
  }

  console.log('');
  console.log(yellow(`  ${figures.cross} You are not in a slate theme directory`));
  console.log('    For a full list of commands, generate a new theme or switch to an existing slate theme directory');
  console.log('');
}

const currentDirectory = __dirname;
const workingDirectory = process.cwd();
const pkg = require(join(currentDirectory, normalize('../package.json')));

// Notify for updates every 1 week
updateNotifier({
  pkg,
  updateCheckInterval: 1000 * 60 * 60 * 24 * 7,
}).notify();

// Global commands
require('./commands/theme').default(program);
require('./commands/migrate').default(program);
require('./commands/version').default(program);

// Dynamically add in theme commands
const themeRoot = getThemeRoot(workingDirectory);
const isSlateTheme = (themeRoot && checkForSlateTools(themeRoot));

if (isSlateTheme) {
  const slateToolsCommands = join(themeRoot, normalize('/node_modules/@shopify/slate-tools/lib/commands'));

  readdirSync(slateToolsCommands)
    .filter((file) => ~file.search(/^[^\.].*\.js$/)) // eslint-disable-line no-useless-escape
    .forEach((file) => require(join(slateToolsCommands, file)).default(program));
}


// Custom help
program.on('--helpStart', () => {
  outputSlateThemeCheck(isSlateTheme);
});

program.on('--helpEnd', () => {
  console.log('  Docs:');
  console.log('');
  console.log('     https://shopify.github.io/slate/');
  console.log('');
});

// Unknown command
program.on('*', () => {
  console.log('');
  console.log(red(`  ${figures.cross} Unknown command: ${program.args.join(' ')}`));
  console.log('');
  program.help();
});

program.parse(process.argv);

// output help if no commands or options passed
if (!process.argv.slice(2).length) {
  program.help();
}