diff --git a/.github/ISSUE_TEMPLATE/formatting.md b/.github/ISSUE_TEMPLATE/formatting.md index abaa3fc7a..2a2cbaa05 100644 --- a/.github/ISSUE_TEMPLATE/formatting.md +++ b/.github/ISSUE_TEMPLATE/formatting.md @@ -16,7 +16,7 @@ BEFORE SUBMITTING AN ISSUE: 2. We get a lot of requests for adding options, but Prettier is built on the principle of being opinionated about code formatting. This means we add options only in the case of strict technical necessity. - Find out more: https://prettier.io/docs/en/option-philosophy.html + Find out more: https://prettier.io/docs/option-philosophy Don't fill the form below manually! Let a program create a report for you: diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e25b50c1..96de8533f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3194,7 +3194,7 @@ export const getVehicleDescriptor = async ( - Config: Match dotfiles in config overrides ([#6194] by [@duailibe]) - When using [`overrides`](https://prettier.io/docs/en/configuration.html#configuration-overrides) in the config file, Prettier was not matching dotfiles (files that start with `.`). This was fixed in 1.18.1 + When using [`overrides`](https://prettier.io/docs/configuration#configuration-overrides) in the config file, Prettier was not matching dotfiles (files that start with `.`). This was fixed in 1.18.1 [#6190]: https://github.com/prettier/prettier/pull/6190 [#6194]: https://github.com/prettier/prettier/pull/6194 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d1807222a..c8db04091 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ yarn test ## Tests -The tests use [Jest snapshots](https://facebook.github.io/jest/docs/en/snapshot-testing.html). You can make changes and run `jest -u` (or `yarn test -u`) to update the snapshots. Then run `git diff` to take a look at what changed. Always update the snapshots when opening a PR. +The tests use [Jest snapshots](https://jestjs.io/docs/snapshot-testing). You can make changes and run `jest -u` (or `yarn test -u`) to update the snapshots. Then run `git diff` to take a look at what changed. Always update the snapshots when opening a PR. Each test directory in `tests/format` has a `format.test.js` file that controls how exactly the rest of the files in the directory are used for tests. This file must contain one or more calls to the `runFormatTest` global function. For example, in directories with JavaScript formatting tests, `format.test.js` generally looks like this: diff --git a/README.md b/README.md index 90da72dd1..ce24c9cc6 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@
- + Your favorite language? diff --git a/docs/configuration.md b/docs/configuration.md index f3258fabc..d0ba417dc 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -58,7 +58,7 @@ JS (ES Modules): // prettier.config.js, .prettierrc.js, prettier.config.mjs, or .prettierrc.mjs /** - * @see https://prettier.io/docs/en/configuration.html + * @see https://prettier.io/docs/configuration * @type {import("prettier").Config} */ const config = { @@ -77,7 +77,7 @@ JS (CommonJS): // prettier.config.js, .prettierrc.js, prettier.config.cjs, or .prettierrc.cjs /** - * @see https://prettier.io/docs/en/configuration.html + * @see https://prettier.io/docs/configuration * @type {import("prettier").Config} */ const config = { diff --git a/docs/ignore.md b/docs/ignore.md index 2634632c5..6ba181dde 100644 --- a/docs/ignore.md +++ b/docs/ignore.md @@ -191,4 +191,4 @@ For one-off commands, when you want to exclude some files without adding them to prettier . "!**/*.{js,jsx,vue}" --write ``` -See [fast-glob](https://prettier.io/docs/en/cli.html#file-patterns) to learn more about advanced glob syntax. +See [fast-glob](https://prettier.io/docs/cli#file-patterns) to learn more about advanced glob syntax. diff --git a/docs/options.md b/docs/options.md index 26af94e64..113648163 100644 --- a/docs/options.md +++ b/docs/options.md @@ -146,7 +146,7 @@ Print trailing commas wherever possible in multi-line comma-separated syntactic Valid options: -- `"all"` - Trailing commas wherever possible (including [function parameters and calls](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Trailing_commas#Trailing_commas_in_functions)). To run, JavaScript code formatted this way needs an engine that supports ES2017 (Node.js 8+ or a modern browser) or [downlevel compilation](https://babeljs.io/docs/en/index). This also enables trailing commas in type parameters in TypeScript (supported since TypeScript 2.7 released in January 2018). +- `"all"` - Trailing commas wherever possible (including [function parameters and calls](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Trailing_commas#Trailing_commas_in_functions)). To run, JavaScript code formatted this way needs an engine that supports ES2017 (Node.js 8+ or a modern browser) or [downlevel compilation](https://babeljs.io/docs/index). This also enables trailing commas in type parameters in TypeScript (supported since TypeScript 2.7 released in January 2018). - `"es5"` - Trailing commas where valid in ES5 (objects, arrays, etc.). Trailing commas in type parameters in TypeScript and Flow. - `"none"` - No trailing commas. @@ -314,7 +314,7 @@ Valid options: - `"css"` (via [postcss](https://github.com/postcss/postcss)) _First available in v1.7.1_ - `"scss"` (via [postcss-scss](https://github.com/postcss/postcss-scss)) _First available in v1.7.1_ - `"less"` (via [postcss-less](https://github.com/shellscape/postcss-less)) _First available in v1.7.1_ -- `"json"` (via [@babel/parser parseExpression](https://babeljs.io/docs/en/next/babel-parser.html#babelparserparseexpressioncode-options)) _First available in v1.5.0_ +- `"json"` (via [@babel/parser parseExpression](https://babeljs.io/docs/babel-parser#babelparserparseexpressioncode-options)) _First available in v1.5.0_ - `"json5"` (same parser as `"json"`, but outputs as [json5](https://json5.org/)) _First available in v1.13.0_ - `"jsonc"` (same parser as `"json"`, but outputs as "JSON with Comments") _First available in v3.2.0_ - `"json-stringify"` (same parser as `"json"`, but outputs like `JSON.stringify`) _First available in v1.13.0_ diff --git a/src/index.d.ts b/src/index.d.ts index 87b4f2588..c3e43e54f 100644 --- a/src/index.d.ts +++ b/src/index.d.ts @@ -578,7 +578,7 @@ export interface CursorResult { } /** - * `format` is used to format text using Prettier. [Options](https://prettier.io/docs/en/options.html) may be provided to override the defaults. + * `format` is used to format text using Prettier. [Options](https://prettier.io/docs/options) may be provided to override the defaults. */ export function format(source: string, options?: Options): Promise; @@ -627,7 +627,7 @@ export interface ResolveConfigOptions { * * A promise is returned which will resolve to: * - * - An options object, providing a [config file](https://prettier.io/docs/en/configuration.html) was found. + * - An options object, providing a [config file](https://prettier.io/docs/configuration) was found. * - `null`, if no file was found. * * The promise will be rejected if there was an error parsing the configuration file. diff --git a/src/main/multiparser.js b/src/main/multiparser.js index 34cb1a217..47fc24722 100644 --- a/src/main/multiparser.js +++ b/src/main/multiparser.js @@ -27,7 +27,7 @@ async function printEmbeddedLanguages( if (embed.length > 2) { throw new Error( - "printer.embed has too many parameters. The API changed in Prettier v3. Please update your plugin. See https://prettier.io/docs/en/plugins.html#optional-embed", + "printer.embed has too many parameters. The API changed in Prettier v3. Please update your plugin. See https://prettier.io/docs/plugins#optional-embed", ); } diff --git a/src/standalone.d.ts b/src/standalone.d.ts index 953ccf49c..67945fa32 100644 --- a/src/standalone.d.ts +++ b/src/standalone.d.ts @@ -17,7 +17,7 @@ export function formatWithCursor( ): Promise; /** - * `format` is used to format text using Prettier. [Options](https://prettier.io/docs/en/options.html) may be provided to override the defaults. + * `format` is used to format text using Prettier. [Options](https://prettier.io/docs/options) may be provided to override the defaults. */ export function format(source: string, options?: Options): Promise; diff --git a/tests/format/js/babel-plugins/__snapshots__/format.test.js.snap b/tests/format/js/babel-plugins/__snapshots__/format.test.js.snap index e782597aa..611091975 100644 --- a/tests/format/js/babel-plugins/__snapshots__/format.test.js.snap +++ b/tests/format/js/babel-plugins/__snapshots__/format.test.js.snap @@ -46,7 +46,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-async-generator-functions +// https://babeljs.io/docs/babel-plugin-proposal-async-generator-functions async function* agf() { await 1; @@ -54,7 +54,7 @@ async function* agf() { } =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-async-generator-functions +// https://babeljs.io/docs/babel-plugin-proposal-async-generator-functions async function* agf() { await 1; @@ -338,7 +338,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-class-properties +// https://babeljs.io/docs/babel-plugin-proposal-class-properties class Bork { //Property initializer syntax @@ -366,7 +366,7 @@ class Bork { console.log(Bork.staticFunction()); // > "babelIsCool" =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-class-properties +// https://babeljs.io/docs/babel-plugin-proposal-class-properties class Bork { //Property initializer syntax @@ -470,7 +470,7 @@ class C extends HTMLElement { exports[`decorators.js [acorn] format 1`] = ` "Unexpected character '@' (3:1) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-decorators + 1 | // https://babeljs.io/docs/babel-plugin-proposal-decorators 2 | > 3 | @annotation | ^ @@ -482,7 +482,7 @@ Cause: Unexpected character '@' (3:0)" exports[`decorators.js [espree] format 1`] = ` "Unexpected character '@' (3:1) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-decorators + 1 | // https://babeljs.io/docs/babel-plugin-proposal-decorators 2 | > 3 | @annotation | ^ @@ -498,7 +498,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-decorators +// https://babeljs.io/docs/babel-plugin-proposal-decorators @annotation class MyClass { } @@ -529,7 +529,7 @@ function enumerable(value) { } =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-decorators +// https://babeljs.io/docs/babel-plugin-proposal-decorators @annotation class MyClass {} @@ -674,7 +674,7 @@ class Foo { exports[`do-expressions.js [acorn] format 1`] = ` "Unexpected token (3:9) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-do-expressions + 1 | // https://babeljs.io/docs/babel-plugin-proposal-do-expressions 2 | > 3 | let a = do { | ^ @@ -686,7 +686,7 @@ Cause: Unexpected token (3:8)" exports[`do-expressions.js [espree] format 1`] = ` "Unexpected token do (3:9) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-do-expressions + 1 | // https://babeljs.io/docs/babel-plugin-proposal-do-expressions 2 | > 3 | let a = do { | ^ @@ -698,7 +698,7 @@ Cause: Unexpected token do" exports[`do-expressions.js [meriyah] format 1`] = ` "Unexpected token: 'do' (3:9) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-do-expressions + 1 | // https://babeljs.io/docs/babel-plugin-proposal-do-expressions 2 | > 3 | let a = do { | ^^ @@ -714,7 +714,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-do-expressions +// https://babeljs.io/docs/babel-plugin-proposal-do-expressions let a = do { if(x > 10) { @@ -727,7 +727,7 @@ let a = do { let a = x > 10 ? 'big' : 'small'; =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-do-expressions +// https://babeljs.io/docs/babel-plugin-proposal-do-expressions let a = do { if (x > 10) { @@ -748,7 +748,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-syntax-dynamic-import +// https://babeljs.io/docs/babel-plugin-syntax-dynamic-import // There is no example code on babel website @@ -758,7 +758,7 @@ import('./prettier.mjs').then(module => console.log(module)); import(prettier).then(module => console.log(module)); =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-syntax-dynamic-import +// https://babeljs.io/docs/babel-plugin-syntax-dynamic-import // There is no example code on babel website @@ -875,13 +875,13 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-export-default-from +// https://babeljs.io/docs/babel-plugin-proposal-export-default-from export v from 'mod'; =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-export-default-from +// https://babeljs.io/docs/babel-plugin-proposal-export-default-from export v from "mod"; @@ -894,12 +894,12 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-export-namespace-from +// https://babeljs.io/docs/babel-plugin-proposal-export-namespace-from export * as ns from 'mod'; =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-export-namespace-from +// https://babeljs.io/docs/babel-plugin-proposal-export-namespace-from export * as ns from "mod"; @@ -908,7 +908,7 @@ export * as ns from "mod"; exports[`flow.js [__babel_estree] format 1`] = ` "Unexpected token, expected "," (3:17) - 1 | // https://babeljs.io/docs/en/babel-preset-flow + 1 | // https://babeljs.io/docs/babel-preset-flow 2 | > 3 | function foo(one: any, two: number, three?): string {} | ^ @@ -918,7 +918,7 @@ Cause: Unexpected token, expected "," (3:16)" exports[`flow.js [acorn] format 1`] = ` "Unexpected token (3:17) - 1 | // https://babeljs.io/docs/en/babel-preset-flow + 1 | // https://babeljs.io/docs/babel-preset-flow 2 | > 3 | function foo(one: any, two: number, three?): string {} | ^ @@ -928,7 +928,7 @@ Cause: Unexpected token (3:16)" exports[`flow.js [babel] format 1`] = ` "Unexpected token, expected "," (3:17) - 1 | // https://babeljs.io/docs/en/babel-preset-flow + 1 | // https://babeljs.io/docs/babel-preset-flow 2 | > 3 | function foo(one: any, two: number, three?): string {} | ^ @@ -942,12 +942,12 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-preset-flow +// https://babeljs.io/docs/babel-preset-flow function foo(one: any, two: number, three?): string {} =====================================output===================================== -// https://babeljs.io/docs/en/babel-preset-flow +// https://babeljs.io/docs/babel-preset-flow function foo(one: any, two: number, three?): string {} @@ -960,12 +960,12 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-preset-flow +// https://babeljs.io/docs/babel-preset-flow function foo(one: any, two: number, three?): string {} =====================================output===================================== -// https://babeljs.io/docs/en/babel-preset-flow +// https://babeljs.io/docs/babel-preset-flow function foo(one: any, two: number, three?): string {} @@ -974,7 +974,7 @@ function foo(one: any, two: number, three?): string {} exports[`flow.js [espree] format 1`] = ` "Unexpected token : (3:17) - 1 | // https://babeljs.io/docs/en/babel-preset-flow + 1 | // https://babeljs.io/docs/babel-preset-flow 2 | > 3 | function foo(one: any, two: number, three?): string {} | ^ @@ -984,7 +984,7 @@ Cause: Unexpected token :" exports[`flow.js [meriyah] format 1`] = ` "Expected ')' (3:17) - 1 | // https://babeljs.io/docs/en/babel-preset-flow + 1 | // https://babeljs.io/docs/babel-preset-flow 2 | > 3 | function foo(one: any, two: number, three?): string {} | ^ @@ -994,7 +994,7 @@ Cause: [3:16-3:17]: Expected ')'" exports[`function-bind.js [acorn] format 1`] = ` "Unexpected token (3:5) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-function-bind + 1 | // https://babeljs.io/docs/babel-plugin-proposal-function-bind 2 | > 3 | obj::func | ^ @@ -1006,7 +1006,7 @@ Cause: Unexpected token (3:4)" exports[`function-bind.js [espree] format 1`] = ` "Unexpected token : (3:5) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-function-bind + 1 | // https://babeljs.io/docs/babel-plugin-proposal-function-bind 2 | > 3 | obj::func | ^ @@ -1018,7 +1018,7 @@ Cause: Unexpected token :" exports[`function-bind.js [meriyah] format 1`] = ` "Unexpected token: ':' (3:5) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-function-bind + 1 | // https://babeljs.io/docs/babel-plugin-proposal-function-bind 2 | > 3 | obj::func | ^ @@ -1034,7 +1034,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-function-bind +// https://babeljs.io/docs/babel-plugin-proposal-function-bind obj::func // is equivalent to: @@ -1053,7 +1053,7 @@ func.call(obj, val) obj.func.call(obj, val) =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-function-bind +// https://babeljs.io/docs/babel-plugin-proposal-function-bind obj::func; // is equivalent to: @@ -1115,7 +1115,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-function-sent +// https://babeljs.io/docs/babel-plugin-proposal-function-sent function* generator() { console.log("Sent", function.sent); @@ -1127,7 +1127,7 @@ iterator.next(1); // Logs "Sent 1" iterator.next(2); // Logs "Yield 2" =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-function-sent +// https://babeljs.io/docs/babel-plugin-proposal-function-sent function* generator() { console.log("Sent", function.sent); @@ -1227,7 +1227,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-syntax-import-meta +// https://babeljs.io/docs/babel-plugin-syntax-import-meta // Enabled by default https://github.com/babel/babel/pull/11406 @@ -1247,7 +1247,7 @@ printWidth: 80 })(); =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-syntax-import-meta +// https://babeljs.io/docs/babel-plugin-syntax-import-meta // Enabled by default https://github.com/babel/babel/pull/11406 @@ -1275,7 +1275,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-syntax-jsx +// https://babeljs.io/docs/babel-plugin-syntax-jsx var profile =
@@ -1283,7 +1283,7 @@ var profile =
; =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-syntax-jsx +// https://babeljs.io/docs/babel-plugin-syntax-jsx var profile = (
@@ -1301,7 +1301,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-logical-assignment-operators +// https://babeljs.io/docs/babel-plugin-proposal-logical-assignment-operators a ||= b; obj.a.b ||= c; @@ -1310,7 +1310,7 @@ a &&= b; obj.a.b &&= c; =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-logical-assignment-operators +// https://babeljs.io/docs/babel-plugin-proposal-logical-assignment-operators a ||= b; obj.a.b ||= c; @@ -1393,12 +1393,12 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-nullish-coalescing-operator +// https://babeljs.io/docs/babel-plugin-proposal-nullish-coalescing-operator var foo = object.foo ?? "default"; =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-nullish-coalescing-operator +// https://babeljs.io/docs/babel-plugin-proposal-nullish-coalescing-operator var foo = object.foo ?? "default"; @@ -1411,7 +1411,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-numeric-separator +// https://babeljs.io/docs/babel-plugin-proposal-numeric-separator let budget = 1_000_000_000_000; @@ -1449,7 +1449,7 @@ let c = message & 0xff; console.log(c.toString(16), b); // c0, 192 =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-numeric-separator +// https://babeljs.io/docs/babel-plugin-proposal-numeric-separator let budget = 1_000_000_000_000; @@ -1495,7 +1495,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-transform-object-rest-spread +// https://babeljs.io/docs/babel-plugin-transform-object-rest-spread let { x, y, ...z } = { x: 1, y: 2, a: 3, b: 4 }; console.log(x); // 1 @@ -1506,7 +1506,7 @@ let n = { x, y, ...z }; console.log(n); // { x: 1, y: 2, a: 3, b: 4 } =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-transform-object-rest-spread +// https://babeljs.io/docs/babel-plugin-transform-object-rest-spread let { x, y, ...z } = { x: 1, y: 2, a: 3, b: 4 }; console.log(x); // 1 @@ -1525,7 +1525,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-optional-catch-binding +// https://babeljs.io/docs/babel-plugin-proposal-optional-catch-binding try { throw 0; @@ -1542,7 +1542,7 @@ try { } =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-optional-catch-binding +// https://babeljs.io/docs/babel-plugin-proposal-optional-catch-binding try { throw 0; @@ -1567,7 +1567,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-optional-chaining +// https://babeljs.io/docs/babel-plugin-proposal-optional-chaining const obj = { foo: { @@ -1631,7 +1631,7 @@ const obj4 = { const ret = delete obj?.foo?.bar?.baz; // true =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-optional-chaining +// https://babeljs.io/docs/babel-plugin-proposal-optional-chaining const obj = { foo: { @@ -1776,7 +1776,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-partial-application +// https://babeljs.io/docs/babel-plugin-proposal-partial-application function add(x, y) { return x + y; } @@ -1799,7 +1799,7 @@ o.f(?, x, ?) // partial application for any arg super.f(?) // partial application allowed for call on |SuperProperty| =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-partial-application +// https://babeljs.io/docs/babel-plugin-proposal-partial-application function add(x, y) { return x + y; @@ -1866,7 +1866,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-pipeline-operator +// https://babeljs.io/docs/babel-plugin-proposal-pipeline-operator // https://github.com/valtech-nyc/proposal-fsharp-pipelines promise @@ -1902,7 +1902,7 @@ newScore //=> 57 let newScore = boundScore(0, 100, add(7, double(person.score))); =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-pipeline-operator +// https://babeljs.io/docs/babel-plugin-proposal-pipeline-operator // https://github.com/valtech-nyc/proposal-fsharp-pipelines promise @@ -1977,7 +1977,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-pipeline-operator +// https://babeljs.io/docs/babel-plugin-proposal-pipeline-operator // https://github.com/js-choi/proposal-hack-pipes return list @@ -1987,7 +1987,7 @@ return list // (The % token isn't final; it might instead be @ or ? or #.) =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-pipeline-operator +// https://babeljs.io/docs/babel-plugin-proposal-pipeline-operator // https://github.com/js-choi/proposal-hack-pipes return list |> take(prefix.length, %) |> equals(%, prefix); @@ -2039,7 +2039,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-pipeline-operator +// https://babeljs.io/docs/babel-plugin-proposal-pipeline-operator // https://github.com/tc39/proposal-pipeline-operator/ let result = exclaim(capitalize(doubleSay("hello"))); @@ -2053,7 +2053,7 @@ let result = "hello" result //=> "Hello, hello!" =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-pipeline-operator +// https://babeljs.io/docs/babel-plugin-proposal-pipeline-operator // https://github.com/tc39/proposal-pipeline-operator/ let result = exclaim(capitalize(doubleSay("hello"))); @@ -2194,7 +2194,7 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-private-methods +// https://babeljs.io/docs/babel-plugin-proposal-private-methods // Test for \`classPrivateProperties\` and \`classPrivateMethods\` @@ -2215,7 +2215,7 @@ class Counter extends HTMLElement { } =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-private-methods +// https://babeljs.io/docs/babel-plugin-proposal-private-methods // Test for \`classPrivateProperties\` and \`classPrivateMethods\` @@ -2406,7 +2406,7 @@ import.source("x"); exports[`throw-expressions.js [acorn] format 1`] = ` "Unexpected token (3:23) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-throw-expressions + 1 | // https://babeljs.io/docs/babel-plugin-proposal-throw-expressions 2 | > 3 | function test(param = throw new Error('required!')) { | ^ @@ -2418,7 +2418,7 @@ Cause: Unexpected token (3:22)" exports[`throw-expressions.js [espree] format 1`] = ` "Unexpected token throw (3:23) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-throw-expressions + 1 | // https://babeljs.io/docs/babel-plugin-proposal-throw-expressions 2 | > 3 | function test(param = throw new Error('required!')) { | ^ @@ -2430,7 +2430,7 @@ Cause: Unexpected token throw" exports[`throw-expressions.js [meriyah] format 1`] = ` "Unexpected token: 'throw' (3:23) - 1 | // https://babeljs.io/docs/en/babel-plugin-proposal-throw-expressions + 1 | // https://babeljs.io/docs/babel-plugin-proposal-throw-expressions 2 | > 3 | function test(param = throw new Error('required!')) { | ^^^^^ @@ -2446,14 +2446,14 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-throw-expressions +// https://babeljs.io/docs/babel-plugin-proposal-throw-expressions function test(param = throw new Error('required!')) { const test = param === true || throw new Error('Falsy!'); } =====================================output===================================== -// https://babeljs.io/docs/en/babel-plugin-proposal-throw-expressions +// https://babeljs.io/docs/babel-plugin-proposal-throw-expressions function test(param = throw new Error("required!")) { const test = param === true || throw new Error("Falsy!"); @@ -2464,7 +2464,7 @@ function test(param = throw new Error("required!")) { exports[`typescript.js [__babel_estree] format 1`] = ` "Unexpected token (3:8) - 1 | // https://babeljs.io/docs/en/babel-preset-typescript + 1 | // https://babeljs.io/docs/babel-preset-typescript 2 | > 3 | const x: number = 0; | ^ @@ -2474,7 +2474,7 @@ Cause: Unexpected token (3:7)" exports[`typescript.js [acorn] format 1`] = ` "Unexpected token (3:8) - 1 | // https://babeljs.io/docs/en/babel-preset-typescript + 1 | // https://babeljs.io/docs/babel-preset-typescript 2 | > 3 | const x: number = 0; | ^ @@ -2484,7 +2484,7 @@ Cause: Unexpected token (3:7)" exports[`typescript.js [babel] format 1`] = ` "Unexpected token (3:8) - 1 | // https://babeljs.io/docs/en/babel-preset-typescript + 1 | // https://babeljs.io/docs/babel-preset-typescript 2 | > 3 | const x: number = 0; | ^ @@ -2498,12 +2498,12 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-preset-typescript +// https://babeljs.io/docs/babel-preset-typescript const x: number = 0; =====================================output===================================== -// https://babeljs.io/docs/en/babel-preset-typescript +// https://babeljs.io/docs/babel-preset-typescript const x: number = 0; @@ -2516,12 +2516,12 @@ parsers: ["babel", "babel-ts", "babel-flow"] printWidth: 80 | printWidth =====================================input====================================== -// https://babeljs.io/docs/en/babel-preset-typescript +// https://babeljs.io/docs/babel-preset-typescript const x: number = 0; =====================================output===================================== -// https://babeljs.io/docs/en/babel-preset-typescript +// https://babeljs.io/docs/babel-preset-typescript const x: number = 0; @@ -2530,7 +2530,7 @@ const x: number = 0; exports[`typescript.js [espree] format 1`] = ` "Unexpected token : (3:8) - 1 | // https://babeljs.io/docs/en/babel-preset-typescript + 1 | // https://babeljs.io/docs/babel-preset-typescript 2 | > 3 | const x: number = 0; | ^ @@ -2540,7 +2540,7 @@ Cause: Unexpected token :" exports[`typescript.js [meriyah] format 1`] = ` "Missing initializer in const declaration (3:8) - 1 | // https://babeljs.io/docs/en/babel-preset-typescript + 1 | // https://babeljs.io/docs/babel-preset-typescript 2 | > 3 | const x: number = 0; | ^ diff --git a/tests/format/js/babel-plugins/async-generators.js b/tests/format/js/babel-plugins/async-generators.js index d3fc2cdac..841bf6f7f 100644 --- a/tests/format/js/babel-plugins/async-generators.js +++ b/tests/format/js/babel-plugins/async-generators.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-async-generator-functions +// https://babeljs.io/docs/babel-plugin-proposal-async-generator-functions async function* agf() { await 1; diff --git a/tests/format/js/babel-plugins/class-properties.js b/tests/format/js/babel-plugins/class-properties.js index 916c975a6..c8b1c083b 100644 --- a/tests/format/js/babel-plugins/class-properties.js +++ b/tests/format/js/babel-plugins/class-properties.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-class-properties +// https://babeljs.io/docs/babel-plugin-proposal-class-properties class Bork { //Property initializer syntax diff --git a/tests/format/js/babel-plugins/decorators.js b/tests/format/js/babel-plugins/decorators.js index 03744072c..470f28340 100644 --- a/tests/format/js/babel-plugins/decorators.js +++ b/tests/format/js/babel-plugins/decorators.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-decorators +// https://babeljs.io/docs/babel-plugin-proposal-decorators @annotation class MyClass { } diff --git a/tests/format/js/babel-plugins/do-expressions.js b/tests/format/js/babel-plugins/do-expressions.js index 5a139893d..13f276b14 100644 --- a/tests/format/js/babel-plugins/do-expressions.js +++ b/tests/format/js/babel-plugins/do-expressions.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-do-expressions +// https://babeljs.io/docs/babel-plugin-proposal-do-expressions let a = do { if(x > 10) { diff --git a/tests/format/js/babel-plugins/dynamic-import.js b/tests/format/js/babel-plugins/dynamic-import.js index bd361096d..8c891a02a 100644 --- a/tests/format/js/babel-plugins/dynamic-import.js +++ b/tests/format/js/babel-plugins/dynamic-import.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-syntax-dynamic-import +// https://babeljs.io/docs/babel-plugin-syntax-dynamic-import // There is no example code on babel website diff --git a/tests/format/js/babel-plugins/export-default-from.js b/tests/format/js/babel-plugins/export-default-from.js index 67a17a8e4..ce824ceed 100644 --- a/tests/format/js/babel-plugins/export-default-from.js +++ b/tests/format/js/babel-plugins/export-default-from.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-export-default-from +// https://babeljs.io/docs/babel-plugin-proposal-export-default-from export v from 'mod'; diff --git a/tests/format/js/babel-plugins/export-namespace-from.js b/tests/format/js/babel-plugins/export-namespace-from.js index 9c06dcd5b..6525bdc75 100644 --- a/tests/format/js/babel-plugins/export-namespace-from.js +++ b/tests/format/js/babel-plugins/export-namespace-from.js @@ -1,3 +1,3 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-export-namespace-from +// https://babeljs.io/docs/babel-plugin-proposal-export-namespace-from export * as ns from 'mod'; diff --git a/tests/format/js/babel-plugins/flow.js b/tests/format/js/babel-plugins/flow.js index 44c0e3305..ae8f62f3d 100644 --- a/tests/format/js/babel-plugins/flow.js +++ b/tests/format/js/babel-plugins/flow.js @@ -1,3 +1,3 @@ -// https://babeljs.io/docs/en/babel-preset-flow +// https://babeljs.io/docs/babel-preset-flow function foo(one: any, two: number, three?): string {} diff --git a/tests/format/js/babel-plugins/function-bind.js b/tests/format/js/babel-plugins/function-bind.js index 41075578e..144e94edb 100644 --- a/tests/format/js/babel-plugins/function-bind.js +++ b/tests/format/js/babel-plugins/function-bind.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-function-bind +// https://babeljs.io/docs/babel-plugin-proposal-function-bind obj::func // is equivalent to: diff --git a/tests/format/js/babel-plugins/function-sent.js b/tests/format/js/babel-plugins/function-sent.js index f7fc8e3d0..e2601b0e5 100644 --- a/tests/format/js/babel-plugins/function-sent.js +++ b/tests/format/js/babel-plugins/function-sent.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-function-sent +// https://babeljs.io/docs/babel-plugin-proposal-function-sent function* generator() { console.log("Sent", function.sent); diff --git a/tests/format/js/babel-plugins/import-meta.js b/tests/format/js/babel-plugins/import-meta.js index 3ef8f5a96..0bc02cea0 100644 --- a/tests/format/js/babel-plugins/import-meta.js +++ b/tests/format/js/babel-plugins/import-meta.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-syntax-import-meta +// https://babeljs.io/docs/babel-plugin-syntax-import-meta // Enabled by default https://github.com/babel/babel/pull/11406 diff --git a/tests/format/js/babel-plugins/jsx.js b/tests/format/js/babel-plugins/jsx.js index f5a6d9ef0..d2ff9e336 100644 --- a/tests/format/js/babel-plugins/jsx.js +++ b/tests/format/js/babel-plugins/jsx.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-syntax-jsx +// https://babeljs.io/docs/babel-plugin-syntax-jsx var profile =
diff --git a/tests/format/js/babel-plugins/logical-assignment-operators.js b/tests/format/js/babel-plugins/logical-assignment-operators.js index 43e332171..fba4a46c0 100644 --- a/tests/format/js/babel-plugins/logical-assignment-operators.js +++ b/tests/format/js/babel-plugins/logical-assignment-operators.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-logical-assignment-operators +// https://babeljs.io/docs/babel-plugin-proposal-logical-assignment-operators a ||= b; obj.a.b ||= c; diff --git a/tests/format/js/babel-plugins/nullish-coalescing-operator.js b/tests/format/js/babel-plugins/nullish-coalescing-operator.js index b786659b2..2ad3de0ca 100644 --- a/tests/format/js/babel-plugins/nullish-coalescing-operator.js +++ b/tests/format/js/babel-plugins/nullish-coalescing-operator.js @@ -1,3 +1,3 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-nullish-coalescing-operator +// https://babeljs.io/docs/babel-plugin-proposal-nullish-coalescing-operator var foo = object.foo ?? "default"; diff --git a/tests/format/js/babel-plugins/numeric-separator.js b/tests/format/js/babel-plugins/numeric-separator.js index 3ea80118c..23066a9dc 100644 --- a/tests/format/js/babel-plugins/numeric-separator.js +++ b/tests/format/js/babel-plugins/numeric-separator.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-numeric-separator +// https://babeljs.io/docs/babel-plugin-proposal-numeric-separator let budget = 1_000_000_000_000; diff --git a/tests/format/js/babel-plugins/object-rest-spread.js b/tests/format/js/babel-plugins/object-rest-spread.js index 6e9ffbff0..df90dd669 100644 --- a/tests/format/js/babel-plugins/object-rest-spread.js +++ b/tests/format/js/babel-plugins/object-rest-spread.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-transform-object-rest-spread +// https://babeljs.io/docs/babel-plugin-transform-object-rest-spread let { x, y, ...z } = { x: 1, y: 2, a: 3, b: 4 }; console.log(x); // 1 diff --git a/tests/format/js/babel-plugins/optional-catch-binding.js b/tests/format/js/babel-plugins/optional-catch-binding.js index 1327104c7..969b3ebeb 100644 --- a/tests/format/js/babel-plugins/optional-catch-binding.js +++ b/tests/format/js/babel-plugins/optional-catch-binding.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-optional-catch-binding +// https://babeljs.io/docs/babel-plugin-proposal-optional-catch-binding try { throw 0; diff --git a/tests/format/js/babel-plugins/optional-chaining.js b/tests/format/js/babel-plugins/optional-chaining.js index d0d584205..10522a9f2 100644 --- a/tests/format/js/babel-plugins/optional-chaining.js +++ b/tests/format/js/babel-plugins/optional-chaining.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-optional-chaining +// https://babeljs.io/docs/babel-plugin-proposal-optional-chaining const obj = { foo: { diff --git a/tests/format/js/babel-plugins/partial-application.js b/tests/format/js/babel-plugins/partial-application.js index 6aaee6003..a7b6f59b2 100644 --- a/tests/format/js/babel-plugins/partial-application.js +++ b/tests/format/js/babel-plugins/partial-application.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-partial-application +// https://babeljs.io/docs/babel-plugin-proposal-partial-application function add(x, y) { return x + y; } diff --git a/tests/format/js/babel-plugins/pipeline-operator-fsharp.js b/tests/format/js/babel-plugins/pipeline-operator-fsharp.js index 66a798372..feaad1f7b 100644 --- a/tests/format/js/babel-plugins/pipeline-operator-fsharp.js +++ b/tests/format/js/babel-plugins/pipeline-operator-fsharp.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-pipeline-operator +// https://babeljs.io/docs/babel-plugin-proposal-pipeline-operator // https://github.com/valtech-nyc/proposal-fsharp-pipelines promise diff --git a/tests/format/js/babel-plugins/pipeline-operator-hack.js b/tests/format/js/babel-plugins/pipeline-operator-hack.js index 553e20358..1d8c19a51 100644 --- a/tests/format/js/babel-plugins/pipeline-operator-hack.js +++ b/tests/format/js/babel-plugins/pipeline-operator-hack.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-pipeline-operator +// https://babeljs.io/docs/babel-plugin-proposal-pipeline-operator // https://github.com/js-choi/proposal-hack-pipes return list diff --git a/tests/format/js/babel-plugins/pipeline-operator-minimal.js b/tests/format/js/babel-plugins/pipeline-operator-minimal.js index e15c9d95c..a57a2bffb 100644 --- a/tests/format/js/babel-plugins/pipeline-operator-minimal.js +++ b/tests/format/js/babel-plugins/pipeline-operator-minimal.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-pipeline-operator +// https://babeljs.io/docs/babel-plugin-proposal-pipeline-operator // https://github.com/tc39/proposal-pipeline-operator/ let result = exclaim(capitalize(doubleSay("hello"))); diff --git a/tests/format/js/babel-plugins/private-methods.js b/tests/format/js/babel-plugins/private-methods.js index 0a9fc7c9f..fed338759 100644 --- a/tests/format/js/babel-plugins/private-methods.js +++ b/tests/format/js/babel-plugins/private-methods.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-private-methods +// https://babeljs.io/docs/babel-plugin-proposal-private-methods // Test for `classPrivateProperties` and `classPrivateMethods` diff --git a/tests/format/js/babel-plugins/throw-expressions.js b/tests/format/js/babel-plugins/throw-expressions.js index 3cded2284..2fb5facde 100644 --- a/tests/format/js/babel-plugins/throw-expressions.js +++ b/tests/format/js/babel-plugins/throw-expressions.js @@ -1,4 +1,4 @@ -// https://babeljs.io/docs/en/babel-plugin-proposal-throw-expressions +// https://babeljs.io/docs/babel-plugin-proposal-throw-expressions function test(param = throw new Error('required!')) { const test = param === true || throw new Error('Falsy!'); diff --git a/tests/format/js/babel-plugins/typescript.js b/tests/format/js/babel-plugins/typescript.js index 7fe7124f3..9b0f9b2ba 100644 --- a/tests/format/js/babel-plugins/typescript.js +++ b/tests/format/js/babel-plugins/typescript.js @@ -1,3 +1,3 @@ -// https://babeljs.io/docs/en/babel-preset-typescript +// https://babeljs.io/docs/babel-preset-typescript const x: number = 0; diff --git a/tests/format/misc/errors/js/format.test.js b/tests/format/misc/errors/js/format.test.js index ae4a491e1..37c98fd8f 100644 --- a/tests/format/misc/errors/js/format.test.js +++ b/tests/format/misc/errors/js/format.test.js @@ -10,7 +10,7 @@ runFormatTest( "const i = %DebugPrint;", // partialApplication - // https://babeljs.io/docs/en/babel-plugin-proposal-partial-application#invalid-usage + // https://babeljs.io/docs/babel-plugin-proposal-partial-application#invalid-usage "f(x + ?)", // `?` not in top-level Arguments of call "x + ?", // `?` not in top-level Arguments of call "?.f()", // `?` not in top-level Arguments of call diff --git a/tests/integration/__tests__/__snapshots__/plugin-api-embed.js.snap b/tests/integration/__tests__/__snapshots__/plugin-api-embed.js.snap index 5df728ade..86bf2f6a8 100644 --- a/tests/integration/__tests__/__snapshots__/plugin-api-embed.js.snap +++ b/tests/integration/__tests__/__snapshots__/plugin-api-embed.js.snap @@ -7,4 +7,4 @@ exports[`embed API in plugins with new signature should work 1`] = ` " `; -exports[`embed API in plugins with outdated signature should cause error 1`] = `"printer.embed has too many parameters. The API changed in Prettier v3. Please update your plugin. See https://prettier.io/docs/en/plugins.html#optional-embed"`; +exports[`embed API in plugins with outdated signature should cause error 1`] = `"printer.embed has too many parameters. The API changed in Prettier v3. Please update your plugin. See https://prettier.io/docs/plugins#optional-embed"`; diff --git a/website/README.md b/website/README.md index 04c8961c3..53af163b0 100644 --- a/website/README.md +++ b/website/README.md @@ -22,7 +22,7 @@ https://prettier.io/ This starts a server hosting the website locally at `http://localhost:3000/`. Any changes to the site's source files are reflected after refreshing the page, i.e. the server does not need to be restarted to show changes. - When working on the docs, you need to go to `http://localhost:3000/docs/en/next/index.html` (note “next”) to see your changes. + When working on the docs, you need to go to `http://localhost:3000/docs/next/index.html` (note “next”) to see your changes. ## Docusaurus @@ -40,7 +40,7 @@ The Playground is not integrated with the Docusaurus infrastructure. Its UI (`we The entry point of the playground is at `static/playground/index.html`. -Another part of the Playground is a web worker where formatting happens. It’s not managed by webpack and resides directly in `static/worker.js`. It expects to find the [UMD bundles of Prettier](https://prettier.io/docs/en/browser.html) in `static/lib/`. That’s why running `yarn build:website` or `PULL_REQUEST=true yarn build:website` in the project root is a required step. +Another part of the Playground is a web worker where formatting happens. It’s not managed by webpack and resides directly in `static/worker.js`. It expects to find the [UMD bundles of Prettier](https://prettier.io/docs/browser) in `static/lib/`. That’s why running `yarn build:website` or `PULL_REQUEST=true yarn build:website` in the project root is a required step. Finally, there is a service worker that caches Prettier’s relatively heavy bundles (`static/service-worker.js`). @@ -54,7 +54,7 @@ id: doc1 # used for docs to find each other and to map links title: Document Title layout: docs1 # used to determine different sidebar groupings category: Sidebar Category 1 # Category on the sidebar under which this doc goes -permalink: docs/en/doc1.html # link to the document that is used for site +permalink: docs/doc1.html # link to the document that is used for site previous: doc0 # previous doc on sidebar for navigation next: doc2 # next doc on the sidebar for navigation # don’t include next if this is the last doc; don’t include previous if first doc diff --git a/website/blog/2017-11-07-1.8.0.md b/website/blog/2017-11-07-1.8.0.md index 1e4396c2d..fe467eebb 100644 --- a/website/blog/2017-11-07-1.8.0.md +++ b/website/blog/2017-11-07-1.8.0.md @@ -43,7 +43,7 @@ you and you may call me V. ``` > ~~Note: We're considering adding an option for this, check [#3183](https://github.com/prettier/prettier/pull/3183) for discussion.~~ -> Update: We've added an option in `1.8.2` called [`--no-prose-wrap`](https://prettier.io/docs/en/options.html#prose-wrap) +> Update: We've added an option in `1.8.2` called [`--no-prose-wrap`](https://prettier.io/docs/options#prose-wrap) > Note for CJK users: If your markdown renderer does not support CJK line ending, you'll have to use plugin like [markdown-it-perfect-newline-for-cjk](https://www.npmjs.com/package/markdown-it-perfect-newline-for-cjk), [hexo-filter-fix-cjk-spacing](https://www.npmjs.com/package/hexo-filter-fix-cjk-spacing), etc. to remove additional spaces. > @@ -134,7 +134,7 @@ const markdown = md` #### Add option to insert `@format` to first docblock if absent ([#2865](https://github.com/prettier/prettier/pull/2865)) by [@samouri](https://github.com/samouri) -In 1.7, we added an option called `--require-pragma` to require files contain an `/** @format */` pragma to be formatted. In order to add this pragma to a large set of files you can now use [`--insert-pragma`](https://prettier.io/docs/en/cli.html#insert-pragma) flag. +In 1.7, we added an option called `--require-pragma` to require files contain an `/** @format */` pragma to be formatted. In order to add this pragma to a large set of files you can now use [`--insert-pragma`](https://prettier.io/docs/cli#insert-pragma) flag. ``` prettier --write "folder/**/*.js" --insert-pragma @@ -142,7 +142,7 @@ prettier --write "folder/**/*.js" --insert-pragma #### Add `--loglevel` option ([#2992](https://github.com/prettier/prettier/pull/2992)) by [@ikatyang](https://github.com/ikatyang) -This [nifty feature](https://prettier.io/docs/en/cli.html#loglevel) allows you to opt in (or out) of Prettier's logging. We've also cleaned up the logging substantially since 1.7. +This [nifty feature](https://prettier.io/docs/cli#loglevel) allows you to opt in (or out) of Prettier's logging. We've also cleaned up the logging substantially since 1.7. ```bash diff --git a/website/blog/2018-01-10-1.10.0.md b/website/blog/2018-01-10-1.10.0.md index 2caa5ba04..a5d2b4202 100644 --- a/website/blog/2018-01-10-1.10.0.md +++ b/website/blog/2018-01-10-1.10.0.md @@ -456,4 +456,4 @@ Similarly, "JSON with comments" will also be detected. [#3643]: https://github.com/prettier/prettier/pull/3643 [#3649]: https://github.com/prettier/prettier/pull/3649 [#3694]: https://github.com/prettier/prettier/pull/3694 -[plugin api]: https://prettier.io/docs/en/plugins.html +[plugin api]: https://prettier.io/docs/plugins diff --git a/website/blog/2018-04-09-plugin-php-0.1.md b/website/blog/2018-04-09-plugin-php-0.1.md index 1b02652e4..2cefbe1ed 100644 --- a/website/blog/2018-04-09-plugin-php-0.1.md +++ b/website/blog/2018-04-09-plugin-php-0.1.md @@ -17,7 +17,7 @@ Adding support for a new language to Prettier requires two things: While we could benefit from existing work on the parsing side, the printer had to be developed from scratch to support all of PHP's various AST node types. Our first alpha release today means that we are confident that the printer can re-print your code without breaking it. -If you'd like to read more about the plugin API, see [the docs](https://prettier.io/docs/en/plugins.html). +If you'd like to read more about the plugin API, see [the docs](https://prettier.io/docs/plugins). ## Philosophy diff --git a/website/blog/2018-04-11-1.12.0.md b/website/blog/2018-04-11-1.12.0.md index d1309ec48..25ea7e081 100644 --- a/website/blog/2018-04-11-1.12.0.md +++ b/website/blog/2018-04-11-1.12.0.md @@ -218,7 +218,7 @@ const { #### Support hasPragma/insertPragma ([#4275](https://github.com/prettier/prettier/pull/4275) by [@ikatyang](https://github.com/ikatyang)) -Prettier 1.7.0 and 1.8.0 introduced two new options, [`--require-pragma`](https://prettier.io/docs/en/options.html#require-pragma) and [`--insert-pragma`](https://prettier.io/docs/en/options.html#insert-pragma). However, these options were only supported in JavaScript. Now these options are available in Markdown, too! +Prettier 1.7.0 and 1.8.0 introduced two new options, [`--require-pragma`](https://prettier.io/docs/options#require-pragma) and [`--insert-pragma`](https://prettier.io/docs/options#insert-pragma). However, these options were only supported in JavaScript. Now these options are available in Markdown, too! ```md @@ -232,7 +232,7 @@ A long time ago, in my hometown of Ericsburgh... When using tools such as [all-contributors](https://github.com/kentcdodds/all-contributors) or [markdown-toc](https://github.com/jonschlinkert/markdown-toc), users were running into situations where autogenerated Markdown content was formatted oddly by Prettier, or Prettier's `--list-different` mode was flagging autogenerated content that the user didn't care about formatting. -To solve these problems, we have added a new type of ignore comment to Markdown, called [Range Ignore](https://prettier.io/docs/en/ignore.html#range-ignore): +To solve these problems, we have added a new type of ignore comment to Markdown, called [Range Ignore](https://prettier.io/docs/ignore#range-ignore): ```md @@ -267,7 +267,7 @@ Prettier 1.11.1 failed to parse the new style; we now support both styles. #### Move pragma detection/insertion to plugins ([#3685](https://github.com/prettier/prettier/pull/3685) by [@duailibe](https://github.com/duailibe)) -Prettier plugins can now include a `hasPragma` function in their [parser](https://prettier.io/docs/en/plugins.html#parsers) and an `insertPragma` function in their [printer](https://prettier.io/docs/en/plugins.html#printers) to opt-in to `--insert-pragma` and `--require-pragma` support. These are their signatures: +Prettier plugins can now include a `hasPragma` function in their [parser](https://prettier.io/docs/plugins#parsers) and an `insertPragma` function in their [printer](https://prettier.io/docs/plugins#printers) to opt-in to `--insert-pragma` and `--require-pragma` support. These are their signatures: ```ts function hasPragma(text: string): boolean; @@ -883,7 +883,7 @@ Prettier 1.11.1 did not handle self-closing style or script tags correctly in vu #### Fix printing ignored files with --debug-check ([#4066](https://github.com/prettier/prettier/pull/4066) by [@duailibe](https://github.com/duailibe)) -Prettier 1.11.1 was mistakenly outputting the contents of ignored files when the [`--debug-check`](https://prettier.io/docs/en/cli.html#debug-check) flag was used. In Prettier 1.12.0, the contents of ignored files are no longer written to stdout. +Prettier 1.11.1 was mistakenly outputting the contents of ignored files when the [`--debug-check`](https://prettier.io/docs/cli#debug-check) flag was used. In Prettier 1.12.0, the contents of ignored files are no longer written to stdout. --- diff --git a/website/blog/2018-05-27-1.13.0.md b/website/blog/2018-05-27-1.13.0.md index 53e06155c..287c2273c 100644 --- a/website/blog/2018-05-27-1.13.0.md +++ b/website/blog/2018-05-27-1.13.0.md @@ -32,7 +32,7 @@ formatButton.addEventListener("click", function() { }); ``` -Read more about it in the [docs](https://prettier.io/docs/en/browser.html) or try it on this [JS Bin](https://jsbin.com/vabiyomoso/edit?html,output). +Read more about it in the [docs](https://prettier.io/docs/browser) or try it on this [JS Bin](https://jsbin.com/vabiyomoso/edit?html,output). #### Don't default to the JavaScript parser ([#4528] by [@duailibe]) @@ -51,13 +51,13 @@ When using the JavaScript API, `prettier.format` and `prettier.formatWithCursor` When invoking Prettier from the API, there was no way to find out if a file should be ignored or not (for `.prettierignore`) so editor integration plugins would have to implement this logic. Also, there was no way to find out if a file was supported by Prettier, so users would need to call Prettier anyway. In 1.13 there's a way to check if a parser will be inferred (and which one) and if the file is ignored or not before actually calling `format`. -You can read more about this in the [docs](https://prettier.io/docs/en/api.html#prettiergetfileinfofilepath-options). +You can read more about this in the [docs](https://prettier.io/docs/api#prettiergetfileinfofilepath-options). #### Support for global Prettier and plugins ([#4192] by [@kachkaev]) When installing Prettier and plugins globally, Prettier was not able to automatically load plugins because it searched for them in the nearest `package.json`. Now Prettier will look for plugins in the `node_modules` directory it's installed in. Additionally, for cases where Prettier can't find the plugins automatically (because of other setups we haven't added support for), a new `--plugin-search-dir` option was added so you can specify where Prettier should search for plugins. -You can read more about this in the [Plugin docs](https://prettier.io/docs/en/plugins.html#using-plugins). +You can read more about this in the [Plugin docs](https://prettier.io/docs/plugins#using-plugins). #### Improve cursor offset tracking ([#4397] by [@ds300]) @@ -133,7 +133,7 @@ d3.select("body") #### Format new `describe.each` table in Jest 23 ([#4423] by [@ikatyang]) -Jest 23 introduced a new feature called [data driven tests](https://facebook.github.io/jest/docs/en/api.html#describeeachtable-name-fn) where you can describe examples to test in a table. Prettier 1.13 includes support for this feature, and will automatically indent the table when using data driven tests. +Jest 23 introduced a new feature called [data driven tests](https://jestjs.io/docs/api#describename-fn) where you can describe examples to test in a table. Prettier 1.13 includes support for this feature, and will automatically indent the table when using data driven tests. ```js diff --git a/website/blog/2018-07-29-1.14.0.md b/website/blog/2018-07-29-1.14.0.md index f49fdc2fe..01c6399c1 100644 --- a/website/blog/2018-07-29-1.14.0.md +++ b/website/blog/2018-07-29-1.14.0.md @@ -46,7 +46,7 @@ Output: (`--prose-wrap always`) that it’s my very good honour to meet you and you may call me V. ``` -> Note: the [`proseWrap`](https://prettier.io/docs/en/options.html#prose-wrap) option is set to `preserve` by default so you’ll have to specify `always` or `never` to enable this feature. +> Note: the [`proseWrap`](https://prettier.io/docs/options#prose-wrap) option is set to `preserve` by default so you’ll have to specify `always` or `never` to enable this feature. ##### Ignore a portion of the file @@ -96,8 +96,8 @@ content #### Support `requirePragma`/`insertPragma` in every language ([#4688], [#4699], [#4713] by [@ikatyang]) Prettier 1.7.0 and 1.8.0 introduced two new options: -[`--require-pragma`](https://prettier.io/docs/en/options.html#require-pragma) and -[`--insert-pragma`](https://prettier.io/docs/en/options.html#insert-pragma). +[`--require-pragma`](https://prettier.io/docs/options#require-pragma) and +[`--insert-pragma`](https://prettier.io/docs/options#insert-pragma). However, these options were only supported in a few languages. Now these options are available in every language, including YAML! @@ -662,7 +662,7 @@ const doBothThings = async () => { #### Allow top level `super` and `await` ([#4823] by [@ikatyang]) `super` and `await` are not allowed to be in places other than classes and async functions, respectively, -but our [range format](https://prettier.io/docs/en/options.html#range) option didn’t quite work properly when selecting the contents of a function. +but our [range format](https://prettier.io/docs/options#range) option didn’t quite work properly when selecting the contents of a function. Prettier 1.14 allows them to be everywhere. @@ -958,7 +958,7 @@ Prettier 1.14 correctly recognizes these characters so they won’t be transform #### Support range format for Vue files ([#4868] by [@ikatyang]) -Previously, [range formatting](https://prettier.io/docs/en/options.html#range) was not available in Vue, +Previously, [range formatting](https://prettier.io/docs/options#range) was not available in Vue, but Prettier 1.14 adds support for it. ### GraphQL diff --git a/website/blog/2018-11-07-1.15.0.md b/website/blog/2018-11-07-1.15.0.md index 989eac711..677c7ad59 100644 --- a/website/blog/2018-11-07-1.15.0.md +++ b/website/blog/2018-11-07-1.15.0.md @@ -116,7 +116,7 @@ Prettier uses filename to infer which parser to use. Here's the default patterns Make sure your filename matches the correct parser (especially for Angular users); if it does not, you will have to manually specify which parser to use via the [overrides] field. -[overrides]: https://prettier.io/docs/en/configuration.html#configuration-overrides +[overrides]: https://prettier.io/docs/configuration#configuration-overrides Note that framework-specific formatting won't be triggered in `--parser html`. diff --git a/website/blog/2019-01-20-1.16.0.md b/website/blog/2019-01-20-1.16.0.md index 21e944f1d..36ebc1d4d 100644 --- a/website/blog/2019-01-20-1.16.0.md +++ b/website/blog/2019-01-20-1.16.0.md @@ -100,7 +100,7 @@ The `babylon` parser name is now deprecated but it still works. If you need to change your config due to this change, please take a second to read [our docs on the `parser` option], especially the note at the bottom. -[our docs on the `parser` option]: https://prettier.io/docs/en/configuration.html#setting-the-parser-docs-en-optionshtml-parser-option +[our docs on the `parser` option]: https://prettier.io/docs/configuration#setting-the-parser-docs-en-optionshtml-parser-option ### Flow diff --git a/website/blog/2019-11-09-1.19.0.md b/website/blog/2019-11-09-1.19.0.md index 48c2a5ba1..7ab4e097e 100644 --- a/website/blog/2019-11-09-1.19.0.md +++ b/website/blog/2019-11-09-1.19.0.md @@ -13,7 +13,7 @@ This release adds the long awaited `--vue-indent-script-and-style` option, suppo #### Add `--vue-indent-script-and-style` ([#6157] by [@kamilic]) -The new [`--vue-indent-script-and-style`](https://prettier.io/docs/en/options.html#vue-files-script-and-style-tags-indentation) option controls whether or not to indent the code inside `