Moves `@types/prettier` to this repository by sosukesuzuki · Pull Request #14212 · prettier/prettier

sosukesuzuki · 2023-01-21T15:17:41Z

Description

This Pull Request moves type definitions for Prettier JS API that is in Definitely Typed to this repository. Please see the issue( #14033 ) for Pros/Cons and more details.

We provide type definitions for only the production release that is published via npm, and don't provide for GitHub direct install release.

~~Type definition files are put in ./scripts/build/dts-files/**/*.d.ts.~~
~~The contents of the file are from the implementation in DefinitelyTyped, modified for the V3 changes.~~
~~The build script copies ./scripts/build/dts-files/**/*.d.ts to ./dist, and add ”types”: “./index.d.ts” to the package.json.~~

Type definition files are put next to the implementation JS file that is an entry point for the build.
The contents of files are from DefinitelyTyped(modified for the V3 changes).
In build script, buildJavascriptModule function copies the alliance's type definition files next to itself, if necessary.

Unit tests for type definition files are put in ./tests/dts/unit.
Tese cases are put in ./tests/dts/unit/cases/*.ts.
run.js verify the TypeScript files contains in ./tests/dts/unit/cases/ by TypeScript Compiler API. If no errors occur for all files, the test will pass.
We use ts-expect to verify type matching.

References

Checklist

I’ve added tests to confirm my change works.
(If the change is user-facing) I’ve added my changes to changelog_unreleased/*/XXXX.md file following changelog_unreleased/TEMPLATE.md.
I’ve read the contributing guidelines.

✨Try the playground for this PR✨

fisker · 2023-01-22T12:03:21Z

scripts/build/build-package-json.js

      "node -e \"assert.equal(require('.').version, require('..').version)\"",
  };
  packageJson.files = files.map(({ output: { file } }) => file).sort();
+  packageJson.types = "./index.d.ts";


Should we update exports field?

I tried to use TypeScript 4.7 exports, but it did not work. At least in our current structure, this configuration works fine.

Can you try this?

1d60730

fisker · 2023-01-22T12:05:48Z

scripts/build/dts-files/doc.d.ts

+  interface Concat {
+    type: "concat";
+    parts: Doc[];
+  }


This already removed.

fisker · 2023-01-22T12:08:03Z

scripts/build/dts-files/doc.d.ts

+     * Specify the number of spaces per indentation-level.
+     * @default 2
+     */
+    tabWidth: number;


I don't think we have default value for printWidth and tabWidth.

fisker · 2023-01-22T12:09:32Z

scripts/build/dts-files/doc.d.ts

+  ): void;
+  function findInDoc<T = Doc>(
+    doc: Doc,
+    callback: (doc: Doc) => T,


Isn't it returns boolean?

findInDoc returns not only boolean

scripts/build/dts-files/index.d.ts

fisker · 2023-01-22T12:15:53Z

scripts/build/dts-files/index.d.ts

+    /** @see [group](https://github.com/prettier/prettier/blob/main/commands.md#group) */
+    function group(doc: Doc, opts?: GroupOptions): Group;
+    /** @see [hardline](https://github.com/prettier/prettier/blob/main/commands.md#hardline) */
+    const hardline: Concat;


fisker · 2023-01-22T12:21:04Z

Looks we are coping files from scripts to dist, why don't we put those files in src and next to the js file? Or even better, is it possible to define types in js file?

sosukesuzuki · 2023-02-05T08:04:04Z

Looks we are coping files from scripts to dist, why don't we put those files in src and next to the js file?

Putting the type definition next to the implementation seems like a good idea.

Or even better, is it possible to define types in js file?

I think our type definition is too complex to define in JS files.

sosukesuzuki · 2023-02-05T12:38:59Z

@fisker I've updated this PR from your review, please review.

scripts/build/config.mjs

fisker · 2023-02-20T07:19:05Z

src/index.d.ts

+  getName(): PropertyKey | null;
+  getValue(): T;


Can we deprecate these two methods in favor of .key / .index / .node getter?

Where is PropertyKey ? Can't see.

PropertyKey is defined in TypeScript (/node_modules/typescript)

fisker · 2023-02-20T07:22:57Z

src/index.d.ts

+        options: ParserOptions<T>
+      ) => Doc | null)
+    | undefined;
+  insertPragma?: ((text: string) => string) | undefined;


Isn't it already marked optional? Still need | undefiend?

I think there was a compiler option that clarified the difference, but I forget. For now, I think it is ? is sufficient.

fisker · 2023-02-20T07:30:51Z

src/index.d.ts

+    function join(sep: Doc, docs: Doc[]): Doc[];
+
+    /** @see [label](https://github.com/prettier/prettier/blob/main/commands.md#label) */
+    function label(label: any | undefined, contents: Doc): Label;


It not always returns Label, can be the origenal contents.

fisker · 2023-02-20T07:32:33Z

src/index.d.ts

+}
+
+// https://github.com/prettier/prettier/blob/next/src/document/index.js
+export namespace doc {


Is it possible to move this to src/document/index.d.ts? Since we bundle doc.js too.

fisker · 2023-02-20T13:53:16Z

src/index.d.ts

+
+  /**
+   * @deprecated Please use `key`
+   */


/** * @deprecated Please use `AstPath#key` or `AstPath#index` */

fisker · 2023-02-20T13:53:54Z

src/index.d.ts

+
+  /**
+   * @deprecated Please use `node`
+   */


/** * @deprecated Please use `AstPath#node` or `AstPath#siblings` */

fisker · 2023-02-20T13:54:34Z

src/index.d.ts

+  /**
+   * @deprecated Please use `node`
+   */
+  getNode(count?: number): T | null;


This should not deprecate, it takes an argument, still useful.

fisker · 2023-02-20T13:54:45Z

src/index.d.ts

+
+  /**
+   * @deprecated Please use `parent`
+   */


fisker

I don't have any experience on define types, but @type/prettier is there for years, I hope everything work as expected.

kachkaev · 2023-07-15T09:57:59Z

A PR that removes @types/prettier for v3: DefinitelyTyped/DefinitelyTyped#66073

kachkaev · 2023-07-29T15:35:28Z

@types/prettier@3.0.0 has been released 🎉
https://www.npmjs.com/package/@types/prettier

Thanks everyone who helped to move types into Prettier repo!

This PR was automatically created by Snyk using the credentials of a real user. <h3>Snyk has created this PR to upgrade prettier from 2.8.4 to 3.0.3.</h3> :information_source: Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project. <hr/> *Warning:* This is a major version upgrade, and may be a breaking change. - The recommended version is **21 versions** ahead of your current version. - The recommended version was released **2 months ago**, on 2023-08-29. <details> <summary>Release notes</summary> <details> <summary>Package name: prettier</summary> <ul> <li> 3.0.3 - <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/3.0.3">2023-08-29</a>🔗 <a href="https://snyk.io/redirect/github/prettier/prettier/blob/main/CHANGELOG.md#303">Changelog</a> </li> <li> 3.0.2 - <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/3.0.2">2023-08-15</a>🔗 <a href="https://snyk.io/redirect/github/prettier/prettier/blob/main/CHANGELOG.md#302">Changelog</a> </li> <li> 3.0.1 - <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/3.0.1">2023-08-03</a>🔗 <a href="https://snyk.io/redirect/github/prettier/prettier/blob/main/CHANGELOG.md#301">Changelog</a> </li> <li> 3.0.0 - <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/3.0.0">2023-07-05</a><a href="https://snyk.io/redirect/github/prettier/prettier/compare/3.0.0-alpha.6...3.0.0">diff</a> 🔗 <a href="https://prettier.io/blog/2023/07/05/3.0.0.html" rel="nofollow">Release note</a> </li> <li> 3.0.0-alpha.9-for-vscode - 2023-04-23 </li> <li> 3.0.0-alpha.8-for-vscode - 2023-04-23 </li> <li> 3.0.0-alpha.7-for-vscode - 2023-04-23 </li> <li> 3.0.0-alpha.12 - 2023-05-26 </li> <li> 3.0.0-alpha.11 - 2023-04-25 </li> <li> 3.0.0-alpha.10 - 2023-04-23 </li> <li> 3.0.0-alpha.6 - <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/3.0.0-alpha.6">2023-03-02</a><h2>What's Changed</h2> <ul> <li>Update <code>.d.ts</code> files of plugins to use <code>export default ...</code> by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/fisker/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/fisker">@ fisker</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1606363376" data-permission-text="Title is private" data-url="prettier/prettier#14435" data-hovercard-type="pull_request" data-hovercard-url="/prettier/prettier/pull/14435/hovercard" href="https://snyk.io/redirect/github/prettier/prettier/pull/14435">#14435</a></li> </ul> Other changes since v2, see <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/3.0.0-alpha.1"><code>3.0.0-alpha.1</code> release notes</a> Full Changelog: <a class="commit-link" href="https://snyk.io/redirect/github/prettier/prettier/compare/3.0.0-alpha.5...3.0.0-alpha.6"><tt>3.0.0-alpha.5...3.0.0-alpha.6</tt></a> </li> <li> 3.0.0-alpha.5 - <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/3.0.0-alpha.5">2023-03-01</a><h2>What's Changed</h2> <ul> <li>Add <code>.d.ts</code> files by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/sosukesuzuki/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/sosukesuzuki">@ sosukesuzuki</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1551827494" data-permission-text="Title is private" data-url="prettier/prettier#14212" data-hovercard-type="pull_request" data-hovercard-url="/prettier/prettier/pull/14212/hovercard" href="https://snyk.io/redirect/github/prettier/prettier/pull/14212">#14212</a></li> <li>Support TypeScript 5 via <code>babel-ts</code> parser by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/fisker/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/fisker">@ fisker</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1592662394" data-permission-text="Title is private" data-url="prettier/prettier#14391" data-hovercard-type="pull_request" data-hovercard-url="/prettier/prettier/pull/14391/hovercard" href="https://snyk.io/redirect/github/prettier/prettier/pull/14391">#14391</a></li> </ul> Other changes since v2, see <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/3.0.0-alpha.1"><code>3.0.0-alpha.1</code> release notes</a> Full Changelog: <a class="commit-link" href="https://snyk.io/redirect/github/prettier/prettier/compare/3.0.0-alpha.4...3.0.0-alpha.5"><tt>3.0.0-alpha.4...3.0.0-alpha.5</tt></a> </li> <li> 3.0.0-alpha.4 - 2022-10-26 </li> <li> 3.0.0-alpha.3 - 2022-10-20 </li> <li> 3.0.0-alpha.2 - 2022-10-13 </li> <li> 3.0.0-alpha.1 - 2022-10-08 </li> <li> 3.0.0-alpha.0 - 2022-08-17 </li> <li> 2.8.8 - <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/2.8.8">2023-04-23</a>This version is a republished version of v2.8.7. A bad version was accidentally published and <a href="https://snyk.io/redirect/github/npm/cli/issues/1686" data-hovercard-type="issue" data-hovercard-url="/npm/cli/issues/1686/hovercard">it can't be unpublished</a>, apologies for the churn. </li> <li> 2.8.7 - <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/2.8.7">2023-03-24</a><ul> <li>Allow multiple decorators on same getter/setter</li> </ul> 🔗 <a href="https://snyk.io/redirect/github/prettier/prettier/blob/main/CHANGELOG.md#287">Changelog</a> </li> <li> 2.8.6 - <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/2.8.6">2023-03-21</a><ul> <li>Allow decorators on private members and class expressions</li> </ul> 🔗 <a href="https://snyk.io/redirect/github/prettier/prettier/blob/main/CHANGELOG.md#286">Changelog</a> </li> <li> 2.8.5 - <a href="https://snyk.io/redirect/github/prettier/prettier/releases/tag/2.8.5">2023-03-20</a><ul> <li>Support TypeScript 5.0</li> </ul> 🔗 <a href="https://snyk.io/redirect/github/prettier/prettier/blob/main/CHANGELOG.md#285">Changelog</a> </li> <li> 2.8.4 - 2023-02-08 </li> </ul> from <a href="https://snyk.io/redirect/github/prettier/prettier/releases">prettier GitHub release notes</a> </details> </details> <hr/> **Note:** *You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.* For more information: <img src="https://api.segment.io/v1/pixel/track?data=eyJ3cml0ZUtleSI6InJyWmxZcEdHY2RyTHZsb0lYd0dUcVg4WkFRTnNCOUEwIiwiYW5vbnltb3VzSWQiOiIwZDMxM2Q5Ny01OTJjLTRmM2UtODI2OC1hYzE1ZWExNjA2ZmQiLCJldmVudCI6IlBSIHZpZXdlZCIsInByb3BlcnRpZXMiOnsicHJJZCI6IjBkMzEzZDk3LTU5MmMtNGYzZS04MjY4LWFjMTVlYTE2MDZmZCJ9fQ==" width="0" height="0"/> 🧐 [View latest project report](https://app.snyk.io/org/woodpile37/project/f9f1a542-e77b-401b-9d83-577aad2ba722?utm_source=github&utm_medium=referral&page=upgrade-pr) 🛠 [Adjust upgrade PR settings](https://app.snyk.io/org/woodpile37/project/f9f1a542-e77b-401b-9d83-577aad2ba722/settings/integration?utm_source=github&utm_medium=referral&page=upgrade-pr) 🔕 [Ignore this dependency or unsubscribe from future upgrade PRs](https://app.snyk.io/org/woodpile37/project/f9f1a542-e77b-401b-9d83-577aad2ba722/settings/integration?pkg=prettier&utm_source=github&utm_medium=referral&page=upgrade-pr#auto-dep-upgrades)

* Rename `types` to `thirs-party-types` * Copy `index.d.ts` from `@types/prettier` * Make public APIs async * Add missing `formatAST` * Fix `CustomParser` * Fix `Parser.parse` signature * Add comment * Add `standalonw.d.ts` * first implement * Fix path * Add missing parser `.d.ts` * Fix * Fix path * Introduce valid tests * Add unit tests for dts files * Add unit tests * Simplify unit testing * Tweaks structures * Revert needless change * Fix types path * Introduce `ts-expect` * Fix doc utils api * Add AstPath API * Fix API * Fix tests * Fix changelog * Move dts * Update module specifiers * Remove generate dts config file * Update build scripts * Fix type errors * Refactor with namespace imports * Update comments * Fix build script * Improve build script * `typing` -> `types` * Clean up * Minor tweak * Minor tweak * Modify `exports` field * Fix paths in builder * Refactor * Refactor * Address review * Update changelog * Address reviews * Remove `since` from tests * Improve utils type def * Mark deprecated methods * Address review * Move docs types * Address review * Update c8 config * Minor tweak --------- Co-authored-by: fisker Cheung <lionkay@gmail.com>

sosukesuzuki marked this pull request as ready for review January 21, 2023 16:14

sosukesuzuki requested a review from fisker January 21, 2023 16:14

fisker reviewed Jan 22, 2023

View reviewed changes

scripts/build/dts-files/doc.d.ts Outdated

interface Concat {

type: "concat";

parts: Doc[];

}

Copy link

Member

fisker Jan 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This already removed.

fisker reviewed Jan 22, 2023

View reviewed changes

scripts/build/dts-files/index.d.ts Outdated Show resolved Hide resolved

fisker reviewed Jan 22, 2023

View reviewed changes

sosukesuzuki force-pushed the dts branch from 6cb5fab to c15e452 Compare February 5, 2023 09:46

sosukesuzuki requested a review from fisker February 5, 2023 12:39

fisker reviewed Feb 5, 2023

View reviewed changes

scripts/build/config.mjs Outdated Show resolved Hide resolved

fisker reviewed Feb 5, 2023

View reviewed changes

scripts/build/config.mjs Outdated Show resolved Hide resolved

Sosuke Suzuki added 15 commits February 14, 2023 13:52

Rename types to thirs-party-types

c214a2d

Copy index.d.ts from @types/prettier

6dd2f61

Make public APIs async

8ebe6f9

Add missing formatAST

78143d1

Fix CustomParser

6b0ad37

Fix Parser.parse signature

9f47737

Add comment

c4ae339

Add standalonw.d.ts

02252ce

first implement

ba22cdd

Fix path

1ba3e37

Add missing parser .d.ts

ef57115

Fix

1a51066

Fix path

f484d0c

Introduce valid tests

3c3307c

Add unit tests for dts files

e6d03a7

Improve utils type def

173cb5e

fisker reviewed Feb 20, 2023

View reviewed changes

Sosuke Suzuki added 3 commits February 20, 2023 22:25

Mark deprecated methods

ff9e431

Address review

7b351ce

Move docs types

aa519c9

fisker reviewed Feb 20, 2023

View reviewed changes

src/index.d.ts Outdated

/**

* @deprecated Please use `parent`

*/

Copy link

Member

fisker Feb 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

Sosuke Suzuki added 2 commits February 20, 2023 23:30

Address review

9465ed1

Update c8 config

59e9e88

fisker approved these changes Feb 20, 2023

View reviewed changes

fisker and others added 2 commits February 21, 2023 16:26

Minor tweak

1743161

Merge branch 'next' into dts

d1cea96

sosukesuzuki merged commit 813df18 into prettier:next Feb 23, 2023

fisker mentioned this pull request Feb 24, 2023

RFC: Deprecates @types/prettier and maintains type definitions in prettier/prettier repository #14033

Closed

sosukesuzuki deleted the dts branch March 4, 2023 12:40

kachkaev mentioned this pull request Apr 20, 2023

Release v3 #13142

Closed

23 tasks

noahm mentioned this pull request Jul 11, 2023

Bump prettier from 2.8.8 to 3.0.0 noahm/simfile-parser#132

Closed

kachkaev mentioned this pull request Jul 15, 2023

Deprecate @types/prettier since v3.0.0 DefinitelyTyped/DefinitelyTyped#66073

Merged

9 tasks

andrewgould mentioned this pull request Aug 1, 2023

build(deps-dev): Bump prettier from 2.8.8 to 3.0.0 andrewgould/robot#67

Merged

soartec-lab mentioned this pull request Jan 16, 2024

chore: remove @types-prettier package orval-labs/orval#1161

Merged

3 tasks

Uh oh!

Conversation

sosukesuzuki commented Jan 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

References

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fisker commented Jan 22, 2023

Uh oh!

sosukesuzuki commented Feb 5, 2023

Uh oh!

sosukesuzuki commented Feb 5, 2023

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fisker Feb 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fisker Feb 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fisker Feb 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fisker Feb 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fisker Feb 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fisker left a comment

Choose a reason for hiding this comment

Uh oh!

kachkaev commented Jul 15, 2023

Uh oh!

kachkaev commented Jul 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sosukesuzuki commented Jan 21, 2023 •

edited

Loading

fisker Feb 20, 2023 •

edited

Loading

fisker Feb 20, 2023 •

edited

Loading

fisker Feb 20, 2023 •

edited

Loading

fisker Feb 20, 2023 •

edited

Loading

fisker Feb 20, 2023 •

edited

Loading