prettier-cli/src/types.ts at 517f85703412ca57eff6357b72eb908f43a09515 · prettier/prettier-cli · GitHub

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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
type Bin = ReturnType<typeof import("tiny-bin").default>;

type ContextOptions = {
  cursorOffset?: number;
  rangeEnd?: number;
  rangeStart?: number;
};

type FormatOptions = {
  [pluginOption: string]: unknown;
  experimentalOperatorPosition?: "start" | "end";
  experimentalTernaries?: boolean;
  arrowParens?: "avoid" | "always";
  bracketSameLine?: boolean;
  bracketSpacing?: boolean;
  embeddedLanguageFormatting?: "auto" | "off";
  endOfLine?: "lf" | "crlf" | "cr" | "auto";
  htmlWhitespaceSensitivity?: "css" | "strict" | "ignore";
  insertPragma?: boolean;
  jsxSingleQuote?: boolean;
  objectWrap?: "preserve" | "collapse";
  parser?: "flow" | "babel" | "babel-flow" | "babel-ts" | "typescript" | "acorn" | "espree" | "meriyah" | "css" | "less" | "scss" | "json" | "jsonc" | "json5" | "json-stringify" | "graphql" | "markdown" | "mdx" | "vue" | "yaml" | "glimmer" | "html" | "angular" | "lwc"; // prettier-ignore
  plugins?: string[];
  printWidth?: number;
  proseWrap?: "always" | "never" | "preserve";
  quoteProps?: "as-needed" | "consistent" | "preserve";
  requirePragma?: boolean;
  semi?: boolean;
  singleAttributePerLine?: boolean;
  singleQuote?: boolean;
  tabWidth?: number;
  trailingComma?: "all" | "es5" | "none";
  useTabs?: boolean;
  vueIndentScriptAndStyle?: boolean;
};

type FunctionMaybe<T> = T | (() => T);

type Ignore = (filePath: string) => boolean;

type Key = string | number | symbol;

type LazyFormatOptions = FunctionMaybe<PromiseMaybe<FormatOptions>>;

type LogLevel = "error" | "warn" | "log" | "debug" | "silent";

type Options = {
  /* INPUT OPTIONS */
  globs: string[];
  /* OUTPUT OPTIONS */
  check: boolean;
  dump: boolean;
  list: boolean;
  write: boolean;
  /* CONFIG OPTIONS */
  config: boolean;
  configPath: string[] | undefined;
  editorConfig: boolean;
  ignore: boolean;
  ignorePath: string[] | undefined;
  withNodeModules: boolean;
  /* OTHER OPTIONS */
  cache: boolean;
  cacheLocation: string | undefined;
  errorOnUnmatchedPattern: boolean;
  ignoreUnknown: boolean;
  logLevel: LogLevel;
  parallel: boolean;
  parallelWorkers: number;
  stdinFilepath: string | undefined;
  /* CONTEXT OPTIONS */
  contextOptions: ContextOptions;
  /* FORMAT OPTIONS */
  formatOptions: FormatOptions;
};

type PluginsOptions = {
  [option: string]: unknown;
};

type Prettier = typeof import("./prettier_serial.js");

type PrettierConfig = FormatOptions;

type PrettierConfigResolver = (filePath: string) => PrettierConfig;

type PrettierConfigWithOverrides = PrettierConfig & {
  overrides?: {
    filesPositive: string[];
    filesNegative: string[];
    folder: string;
    options: PrettierConfig;
  }[];
};

type PrettierPlugin = import("prettier").Plugin;

type PromiseMaybe<T> = T | Promise<T>;

export type {
  Bin,
  ContextOptions,
  FormatOptions,
  FunctionMaybe,
  Ignore,
  Key,
  LazyFormatOptions,
  LogLevel,
  Options,
  PluginsOptions,
  Prettier,
  PrettierConfig,
  PrettierConfigResolver,
  PrettierConfigWithOverrides,
  PrettierPlugin,
  PromiseMaybe,
};