gremlint/src/formatQuery/index.ts

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import { formatSyntaxTrees } from './formatSyntaxTrees';
import { parseToSyntaxTrees } from './parseToSyntaxTrees';
import { recreateQueryStringFromFormattedSyntaxTrees } from './recreateQueryStringFromFormattedSyntaxTrees';
import { GremlintInternalConfig, GremlintUserConfig } from './types';
import { pipe } from './utils';

const withDefaults = (config: Partial<GremlintUserConfig>): GremlintUserConfig => ({
  indentation: 0,
  maxLineLength: 80,
  shouldPlaceDotsAfterLineBreaks: false,
  ...config,
});

const getInternalGremlintConfig = ({
  indentation,
  maxLineLength,
  shouldPlaceDotsAfterLineBreaks,
}: GremlintUserConfig): GremlintInternalConfig => ({
  globalIndentation: indentation,
  localIndentation: 0,
  maxLineLength: maxLineLength - indentation,
  shouldPlaceDotsAfterLineBreaks,
  shouldStartWithDot: false,
  shouldEndWithDot: false,
  horizontalPosition: 0,
});

export const formatQuery = (query: string, config?: Partial<GremlintUserConfig>): string => {
  const internalConfig = getInternalGremlintConfig(withDefaults(config ?? {}));
  return pipe(
    parseToSyntaxTrees,
    formatSyntaxTrees(internalConfig),
    recreateQueryStringFromFormattedSyntaxTrees(internalConfig),
  )(query);
};