thumbsup/bin/thumbsup.js

#!/usr/bin/env node

var yargs = require('yargs');
var path  = require('path');
var index = require('../src/index');

console.log('');
var opts = yargs
  .usage('Usages:\n' +
         '  thumbsup [required] [options]\n' +
         '  thumbsup --config config.json')
  .wrap(null)
  .group('input', 'Required:')
  .group('output', 'Required:')
  .help('help')
  .options({

    // ------------------------------------
    // Required arguments
    // ------------------------------------

    'input': {
      description: 'Path to the folder with all photos/videos',
      normalize: true,
      demand: true
    },
    'output': {
      description: 'Output path for the static website',
      normalize: true,
      demand: true
    },

    // ------------------------------------
    // Optional arguments
    // ------------------------------------

    'index': {
      description: 'Filename of the home page',
      'default': 'index.html'
    },
    'title': {
      description: 'Website title',
      'default': 'Photo album'
    },
    'footer': {
      description: 'Text or HTML footer',
      'default': null
    },
    'thumb-size': {
      description: 'Pixel size of the square thumbnails',
      type: 'number',
      'default': 120
    },
    'large-size': {
      description: 'Pixel height of the fullscreen photos',
      type: 'number',
      'default': 1000
    },
    'original-photos': {
      description: 'Allow download of full-size photos',
      type: 'boolean',
      'default': false
    },
    'original-videos': {
      description: 'Allow download of full-size videos',
      type: 'boolean',
      'default': false
    },
    'albums-output-folder': {
      description: 'Output subfolder for HTML albums (default: root of gallery)',
      'default': '.'
    },
    'albums-from': {
      description: 'How to group media into albums',
      choices: ['folders', 'date'],
      'default': 'folders'
    },
    'albums-date-format': {
      description: 'How albums are named in <date> mode [moment.js pattern]',
      'default': 'YYYY-MM'
    },
    // Deprecated for <sort-albums>
    'sort-folders': {
      description: 'How to sort albums [deprecated]',
      choices: ['name', 'date']
    },
    'sort-albums-by': {
      description: 'How to sort albums',
      choices: ['title', 'start-date', 'end-date'],
      'default': 'start-date'
    },
    'sort-albums-direction': {
      description: 'Album sorting direction',
      choices: ['asc', 'desc'],
      'default': 'asc'
    },
    'sort-media-by': {
      description: 'How to sort photos and videos',
      choices: ['filename', 'date'],
      'default': 'date'
    },
    'sort-media-direction': {
      description: 'Media sorting direction',
      choices: ['asc', 'desc'],
      'default': 'asc'
    },
    'theme': {
      description: 'Name of the gallery theme to apply',
      choices: ['classic', 'cards', 'mosaic'],
      'default': 'classic'
    },
    'css': {
      description: 'Path to a CSS/LESS file for styling',
      normalize: true
    },
    'google-analytics': {
      description: 'Code for Google Analytics tracking',
      type: 'string'
    },
    'config': {
      description: 'JSON config file (one key per argument)',
      normalize: true
    }
  })
  .config('config')
  .epilogue('The optional JSON config should contain a single object with one key ' +
            'per argument, not including the leading "--". For example:\n\n' +
            '{ "sort-albums-by": "start-date" }')
  .argv;


// Compatibility
if (opts['sort-folders'] == 'name') opts['sort-albums-by'] = 'title';
if (opts['sort-folders'] == 'date') opts['sort-albums-by'] = 'start-date';

index.build({
  input:             path.resolve(opts['input']),
  output:            path.resolve(opts['output']),
  title:             opts['title'],
  thumbSize:         opts['thumb-size'],
  largeSize:         opts['large-size'],
  originalPhotos:    opts['original-photos'],
  originalVideos:    opts['original-videos'],
  albumsFrom:        opts['albums-from'],
  albumsDateFormat:  opts['albums-date-format'],
  sortAlbumsBy:      opts['sort-albums-by'],
  sortAlbumsDirection: opts['sort-albums-direction'],
  sortMediaBy:       opts['sort-media-by'],
  sortMediaDirection: opts['sort-media-direction'],
  theme:             opts['theme'],
  css:               opts['css'],
  googleAnalytics:   opts['google-analytics'],
  index:             opts['index'],
  footer:            opts['footer'],
  albumsOutputFolder: opts['albums-output-folder']
});