Home

Index

How to use the format function from prettier

Find comprehensive JavaScript prettier.format code examples handpicked from public code repositorys.

prettier.format is a JavaScript function that automatically formats your code to adhere to a consistent set of rules and style guidelines.

loader.js

171
172
173
174
175
176
177
178
179
180
    }

    configure(getStories, module, false)
`;

const formattedFileContent = prettier.format(fileContent, { parser: 'babel' });

fs.writeFileSync(storybookRequiresLocation, formattedFileContent, {
  encoding: 'utf8',
  flag: 'w',

125

715

+ 8 other calls in file

index.js

GitHub: thakkarparth007/copilot-explorer

444
445
446
447
448
449
450
451
452
453
assert (moduleAst.program.body[0].expression.body.type == "BlockStatement");

const mainBody = moduleAst.program.body[0].expression.body.body;
const moduleCode = generate(babel.types.Program(mainBody)).code;

const moduleCode2 = prettier.format(moduleCode, {
    parser: "babel",
}).trim();

fs.writeFileSync(getModulePath(moduleId), moduleCode2);

238

How does prettier.format work?

prettier.format is a function in the Prettier library that automatically formats JavaScript code to adhere to a consistent set of rules and style guidelines. When you call prettier.format with a string of JavaScript code as its argument, Prettier parses the code and applies a set of rules and heuristics to determine the most appropriate way to format it. These rules cover a wide range of formatting concerns, such as indentation, spacing, line length, and more. By applying these rules consistently to your code, Prettier ensures that your code is easy to read, maintain, and share with others. prettier.format can be used as a standalone tool, integrated into your development workflow, or used in conjunction with a code editor or IDE that supports Prettier. Prettier supports a wide range of JavaScript syntax and has plugins available for other languages such as CSS, HTML, and TypeScript. By automatically formatting your code, Prettier can save you time and reduce the cognitive load of manually formatting your code. It also helps to enforce a consistent code style across your team or project, which can improve collaboration and reduce the likelihood of errors caused by inconsistent formatting.

cli.ts

GitHub: remix-pwa/remix-pwa

121
122
123
124
125
126
127
128
129
130
    "\n" +
    swHook +
    "\n" +
    RootDirNull.replace(/\s\s+/g, " ").slice(index);

const formatted: string = prettier.format(NewContent, { parser: `babel${parser}` });
const cleanRegex: RegExp = /{" "}/g;
const newFormatted: string = formatted.replace(cleanRegex, " ");

const rootArray: string[] = newFormatted.split("\n");

297

+ 11 other calls in file

transform.js

GitHub: SAP/odata-vocabularies

44
45
46
47
48
49
50
51
52
53
  links[latestVersion].rel = "alternate";
  links[alternate].rel = "latest-version";
}
fs.writeFileSync(
  vocabFolder + vocab + ".json",
  prettier.format(JSON.stringify(json, omitLineNumbers), PRETTIER_OPTIONS)
);

const markdown = lib.csdl2markdown(xmlfile, json);
fs.writeFileSync(vocabFolder + vocab + ".md", markdown.join("\n"));

133

Ai Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
const prettier = require("prettier");

// Define some unformatted JavaScript code
const unformattedCode = `function myFunction() {
const myVariable = 'hello';
console.log(myVariable);
}`;

// Format the code using Prettier
const formattedCode = prettier.format(unformattedCode, {
  semi: false,
  singleQuote: true,
});

// Output the formatted code to the console
console.log(formattedCode);

In this example, we start by defining some unformatted JavaScript code in a string. We then pass that code to prettier.format, along with an options object that specifies that we don't want semicolons (semi: false) and we want to use single quotes for strings (singleQuote: true). Prettier then formats the code according to its rules and returns a new string with the formatted code. We output the formatted code to the console using console.log. The output of this example will be the formatted JavaScript code, with consistent indentation, spacing, and other formatting rules applied: javascript Copy code

webpack.config.js

GitHub: nihruk/design-system

14
15
16
17
18
19
20
21
22
23
24
  {
    throwOnUndefined : true,
  },
)
nunjucksEnvironment.addFilter('highlight', (code, language) => highlight.highlight(code, {language}).value)
nunjucksEnvironment.addFilter('prettier', (code, parser) => prettier.format(code, {parser}))


module.exports = (env, args) => {
  const production = args.mode === 'production'
  const configuration = {

+ 20 other calls in file

index.js

GitHub: fatesigner/antdvx

394
395
396
397
398
399
400
401
402
403
// eslint-disable-next-line promise/catch-or-return
prettier.resolveConfig(process.cwd()).then((options) => {
  // eslint-disable-next-line promise/always-return
  if (options) {
    try {
      const content_ = prettier.format(content, {
        ...options,
        parser: 'typescript'
      });
      resolve(content_);

+ 3 other calls in file

prettier.js

GitHub: lenolee16/mock

27
28
29
30
31
32
33
34
35
36
const input = fs.readFileSync(file, 'utf8');
const withParserOptions = {
  ...options,
  parser: fileInfo.inferredParser,
};
const output = prettier.format(input, withParserOptions);
if (output !== input) {
  fs.writeFileSync(file, output, 'utf8');
  console.log(`\x1b[34m ${file} is prettier`);
}

formattedTSDemos.js

GitHub: mui/mui-x

120
121
122
123
124
125
126
127
128
129

const prettierConfig = prettier.resolveConfig.sync(jsPath, {
  config: path.join(workspaceRoot, 'prettier.config.js'),
});
const prettierFormat = (jsSource) =>
  prettier.format(jsSource, { ...prettierConfig, filepath: jsPath });

const prettified = prettierFormat(codeWithPropTypes);
const formatted = fixBabelGeneratorIssues(prettified);
const correctedLineEndings = fixLineEndings(source, formatted);

580

+ 9 other calls in file

run.js

GitHub: LuxScript/LuxScript

724
725
726
727
728
729
730
731
732
733
    document.head.appendChild(script);
}
if (typeof documentdoctype !== 'undefined') {
    html = "<!DOCTYPE html>" + document.documentElement.outerHTML;
}
const formattedHtml = prettier.format(html, {
    parser: "html"
});

if (tok[4] && tok[4]["value"] !== "RIGHT_PAREN") {

index.js

GitHub: Matrix-The-One/debug-react

44
45
46
47
48
49
50
51
52
53
  config: prettierConfigPath,
});
try {
  const input = fs.readFileSync(file, 'utf8');
  if (shouldWrite) {
    const output = prettier.format(input, options);
    if (output !== input) {
      fs.writeFileSync(file, output, 'utf8');
    }
  } else {

formatter.js

GitHub: pizza-777/everscale-solidity-vscode-extension

37
38
39
40
41
42
43
44
45
46
const firstLine = document.lineAt(0);
const lastLine = document.lineAt(document.lineCount - 1);
const content = document.getText();
let formatted;
try {
    formatted = prettier.format(content, options);
} catch (e) {
    console.log(e)
}
if(typeof formatted !== 'undefined'){

test-case.js

GitHub: Xeltax/padlet

254
255
256
257
258
259
260
261
262
263
/**
 * @param {string} actual
 * @returns {string}
 */
print(actual) {
	return Prettier.format(actual, {
		printWidth: 100,
		tabWidth: 4,
		useTabs: true,
		htmlWhitespaceSensitivity: 'ignore',

prettier.js

GitHub: Brncnnr/totara

105
106
107
108
109
110
111
112
113
114
115
116
  return { ...config, parser: parser };
}


function formatCodeWithPath(filePath, code) {
  const config = getConfig(filePath);
  return prettier.format(code, config);
}


module.exports = {
  run,

set-local-paths.js

GitHub: material-identity/EN10168-schemas

22
23
24
25
26
27
28
29
30
31
    break;
  }
}
if (partialsMapHasChanged) {
  const prettierOptions = await prettier.resolveConfig(filePath);
  const newPartialsMap = prettier.format(JSON.stringify(partialsMap, null, 2), {
    ...(prettierOptions || {}),
    parser: 'json',
  });
  await writeFile(filePath, newPartialsMap);

generateSource.cjs

GitHub: LNReader/lnreader

268
269
270
271
272
273
274
275
276

export default ${source.sourceName}Scraper;

`;

const formatContent = prettier.format(content, {
  parser: 'typescript',
  ...prettierConfig,
});

786

+ 3 other calls in file

generatorUtils.js

GitHub: grucloud/grucloud

868
869
870
871
872
873
874
875
876
877
    () => content,
  ]),
  get("output"),
]),
tryCatch(
  (output) => prettier.format(output, { parser: "babel" }),
  (error, output) =>
    pipe([
      tap(() => {
        console.error(error);

+ 7 other calls in file

index.js

GitHub: TDesignOteam/tdesign-api

555
556
557
558
559
560
561
562
563
564
  exportDesc,
].filter(v => !!v);
const str = `${r.join('\n\n')}\n`;
// ts[cmp] = str;
try {
  ts[cmp] = prettier.format(str, prettierConfig);
} catch (e) {
  console.log(chalk.red('格式化失败，请检查生成的文件是否存在语法错误\n'));
  console.warn(e);
}

sync-mdcode-plugin.js

GitHub: AntmJS/vantui

422
423
424
425
426
427
428
429
430
431
432
}


function formatCode(codes) {
  let res = codes
  try {
    res = format(codes, {
      singleQuote: true,
      trailingComma: 'all',
      semi: false,
      parser: 'babel',

495

code.js

GitHub: octokit/plugin-rest-endpoint-methods.js

115
116
117
118
119
120
121
122
123
124
  }
});

writeFileSync(
  ROUTES_PATH,
  prettier.format(
    `import { EndpointsDefaultsAndDecorations } from "../types";
const Endpoints: EndpointsDefaultsAndDecorations = ${JSON.stringify(
  sortKeys(newRoutes, { deep: true })
)}

types.js

GitHub: octokit/plugin-rest-endpoint-methods.js

77
78
79
80
81
82
83
84
85
86
  RestEndpointMethodNamespaceTypes.push(`${namespace.namespace}: {
    ${namespaceMethods.join("\n")}
  }`);
}

const methodTypesSource = prettier.format(
  [
    `import { EndpointInterface, RequestInterface } from "@octokit/types";`,
    `import { RestEndpointMethodTypes } from "./parameters-and-response-types";`,
    "",

Other functions in prettier

Sorted by popularity

prettier.format is the most popular function in prettier (372 examples)

Other popular packages:

Home

About