tidyrs 0.0.0 → 0.2.0

package/index.d.ts

@@ -0,0 +1,104 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+
+/**
+ * Which binding artifact the generated loader actually loaded: `'native'` for
+ * a native addon, otherwise the `platformArchABI` of the WASI flavor. Every
+ * flavor napi-rs can build is listed, because `NAPI_RS_NATIVE_LIBRARY_PATH`
+ * can point the loader at a WASI artifact this package does not build itself.
+ */
+export declare const __napiBindingTarget: 'native' | 'wasm32-wasi' | 'wasm32-wasip1'
+
+/** Whether a file is formatted already. `embed` receives each piece of code in another language, as for `format`. */
+export declare function check(source: string, options?: FormatOptions, embed?: (request: EmbedRequest) => string | undefined): boolean
+
+/** A piece of embedded code for the host to format. */
+export interface EmbedRequest {
+  code: string
+  /** Prettier's name for the parser: `babel`, `typescript`, `css`, `json`, ... */
+  language: string
+  kind: 'block' | 'expression' | 'attribute' | 'frontmatter'
+  /** How many indents the code starts at. Indent the lines after the first by this much. */
+  indent: number
+  /**
+   * The width of the text before the code on its first line, after the indents, as `name="` before an attribute
+   * value. Print the code after this much.
+   */
+  prefix: number
+  /** The width of the text after the code on its last line, as the `"` that closes such a value. */
+  suffix: number
+  width: number
+  /** JavaScript that is a module, not a classic script. */
+  module: boolean
+}
+
+/** Format a file. `embed` receives each piece of code in another language. */
+export declare function format(source: string, options?: FormatOptions, embed?: (request: EmbedRequest) => string | undefined): string
+
+/** Options for `format`: the options of a `tidy.json` file, and what to format. */
+export interface FormatOptions {
+  /** The language. Default: by `filepath`, and HTML without one. */
+  parser?: 'html' | 'vue' | 'mjml' | 'handlebars' | 'tempura' | 'css' | 'scss' | 'less' | 'json' | 'jsonc' | 'json5' | 'json-stringify' | 'yaml' | 'toml' | 'dockerfile' | 'ini' | 'gitconfig' | 'graphql' | 'babel' | 'typescript' | 'babel-ts' | 'xml' | 'markdown'
+  /** The file's path, which decides the language and some details. */
+  filepath?: string
+  /** Hand embedded code to `embed`, and format the style sheets, JSON, YAML and TOML it declines. Default: true. */
+  embedded?: boolean
+  /** The line width. Default: 80. */
+  width?: number
+  /** The width of an indent. Default: 2. */
+  indent?: number
+  /** Indent with tabs. Default: false. */
+  tabs?: boolean
+  eol?: 'lf' | 'crlf' | 'cr'
+  /** Default: `auto`, and `strict` for XML. */
+  whitespace?: 'strict' | 'auto' | 'ignore'
+  /** Quotes in Handlebars, style sheets, JSON5, YAML and JS. Default: `double`. */
+  quote?: 'double' | 'single'
+  /** Trailing commas in SCSS, JSONC, JSON5, YAML flow collections, TOML arrays and JS. Default: true. */
+  trailingComma?: boolean
+  /** Spaces inside the braces of JSON and JS objects and YAML flow mappings. Default: true. */
+  bracketSpacing?: boolean
+  bracketSameLine?: boolean
+  singleAttributePerLine?: boolean
+  /** The ignore directive. Default: `prettier-ignore`. */
+  ignore?: string
+  /** Options for HTML only: the shared ones above. */
+  html?: Record<string, unknown>
+  /** Options for Vue only: the shared ones, and `indentBlocks`. */
+  vue?: Record<string, unknown>
+  /** Options for Handlebars only: the shared ones, and `dialect`. */
+  handlebars?: Record<string, unknown>
+  /** Options for style sheets only: the shared ones above. */
+  css?: Record<string, unknown>
+  /** Options for JSON only: the shared ones, and `quoteProps` and `objectWrap`. */
+  json?: Record<string, unknown>
+  /** Options for YAML only: the shared ones, and `wrap` (`preserve`, `always` or `never`). */
+  yaml?: Record<string, unknown>
+  /** Options for TOML only: the shared ones, and taplo's, in camel case: `alignEntries`, `reorderKeys`, ... */
+  toml?: Record<string, unknown>
+  /**
+   * Options for Dockerfiles only: the shared ones, and dprint-plugin-dockerfile's `indentStages` and
+   * `healthcheckCmdNewLine`.
+   */
+  dockerfile?: Record<string, unknown>
+  /** Options for INI only: the shared ones, and `spaceAroundEquals`. */
+  ini?: Record<string, unknown>
+  /** Options for GraphQL only: the shared ones. */
+  graphql?: Record<string, unknown>
+  /**
+   * Options for JavaScript and TypeScript, also where tidy formats them in other languages: the shared ones,
+   * `trailingComma` as `all`, `es5` or `none`, and `semi`, `jsxSingleQuote`, `quoteProps`, `arrowParens`,
+   * `objectWrap`, `experimentalTernaries`, `experimentalOperatorPosition` and `jsdoc`. Imports are sorted with oxfmt's
+   * `sortImports`, or with `plugins` that lists `@trivago/prettier-plugin-sort-imports`,
+   * `@ianvs/prettier-plugin-sort-imports` or `prettier-plugin-organize-imports` and that plugin's options
+   * (`importOrder`, `importOrderSeparation`, `organizeImportsTypeOrder`, ...). Off by default.
+   */
+  js?: Record<string, unknown>
+  /** Options for XML only: the shared ones, and `selfClosingSpace`, `sortAttributes` and `attributeQuotes`. */
+  xml?: Record<string, unknown>
+  /**
+   * Options for Markdown only: `width` and `ignore`, a `preset` (`prettier` or `preserve`), and `wrap`, `bullet`,
+   * `emphasis`, `strong`, `numbering`, `rule`, `fence` and `heading`, which override the preset.
+   */
+  markdown?: Record<string, unknown>
+}