summaryrefslogtreecommitdiff
path: root/app/assets/javascripts/lib/utils/grammar.js
blob: 18f9e2ed8468c0efe61ee13f8c7b0ae302f3d477 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
import { sprintf, s__ } from '~/locale';

/**
 * Combines each given item into a noun series sentence fragment. It does this
 * in a way that supports i18n by giving context and punctuation to the locale
 * functions.
 *
 * **Examples:**
 *
 * - `["A", "B"] => "A and B"`
 * - `["A", "B", "C"] => "A, B, and C"`
 *
 * **Why only nouns?**
 *
 * Some languages need a bit more context to translate other series.
 *
 * @param {String[]} items
 */
export const toNounSeriesText = items => {
  if (items.length === 0) {
    return '';
  } else if (items.length === 1) {
    return items[0];
  } else if (items.length === 2) {
    return sprintf(s__('nounSeries|%{firstItem} and %{lastItem}'), {
      firstItem: items[0],
      lastItem: items[1],
    });
  }

  return items.reduce((item, nextItem, idx) =>
    idx === items.length - 1
      ? sprintf(s__('nounSeries|%{item}, and %{lastItem}'), { item, lastItem: nextItem })
      : sprintf(s__('nounSeries|%{item}, %{nextItem}'), { item, nextItem }),
  );
};

export default {
  toNounSeriesText,
};