sql-formatter-plus/src/sqlFormatter.js

Formats whitespace in a SQL query to make it more readable

import Db2Formatter from './languages/Db2Formatter';
import N1qlFormatter from './languages/N1qlFormatter';
import PlSqlFormatter from './languages/PlSqlFormatter';
import StandardSqlFormatter from './languages/StandardSqlFormatter';

/**
 * Format whitespace in a query to make it easier to read.
 *
 * @param {String} query
 * @param {Object} cfg
 *  @param {String} cfg.language Query language, default is Standard SQL
 *  @param {String} cfg.indent Characters used for indentation, default is "  " (2 spaces)
 *  @param {Bool} cfg.uppercase Converts keywords to uppercase
 *  @param {Integer} cfg.linesBetweenQueries How many line breaks between queries
 *  @param {Object} cfg.params Collection of params for placeholder replacement
 * @return {String}
 */
export const format = (query, cfg = {}) => {
  switch (cfg.language) {
    case 'db2':
      return new Db2Formatter(cfg).format(query);
    case 'n1ql':
      return new N1qlFormatter(cfg).format(query);
    case 'pl/sql':
      return new PlSqlFormatter(cfg).format(query);
    case 'sql':
    case undefined:
      return new StandardSqlFormatter(cfg).format(query);
    default:
      throw Error(`Unsupported SQL dialect: ${cfg.language}`);
  }
};

export default { format };