docs: [no-wrapper-object-types] clean up a bit of phrasing #9363

kirkwaiblinger · 2024-06-15T20:05:54Z

PR Checklist

Addresses an existing open issue: ~~fixes #000~~ followup to https://github.com/typescript-eslint/typescript-eslint/pull/9102/files/f25f33396926cf0bb03eac1d02d8636987d3ec28..e078105858728c2cfe6bdf81a145feae291cb43c#r1635229512
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

typescript-eslint · 2024-06-15T20:05:56Z

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

netlify · 2024-06-15T20:06:13Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`f7d7253`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/668b83dd41b8080008afb753
😎 Deploy Preview	https://deploy-preview-9363--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (🟢 up 5 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 90 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

kirkwaiblinger · 2024-06-15T20:07:43Z

packages/eslint-plugin/docs/rules/no-wrapper-object-types.mdx

@@ -10,13 +10,12 @@ import TabItem from '@theme/TabItem';
 > See **https://typescript-eslint.io/rules/no-wrapper-object-types** for documentation.

 The JavaScript language has a set of language types, but some of them correspond to two TypeScript types, which look similar: `boolean`/`Boolean`, `number`/`Number`, `string`/`String`, `bigint`/`BigInt`, `symbol`/`Symbol`, `object`/`Object`.
-The difference is that the lowercase variants are compiler intrinsics and specify the actual _runtime types_ (that is, the return value when you use the `typeof` operator), while the uppercase variants are _structural types_ defined in the library that can be satisfied by any user-defined object with the right properties, not just the real primitives.
+The difference is that the lowercase variants are compiler intrinsics and specify the actual _runtime types_ (that is, the type indicated when executing `typeof x` at runtime), while the uppercase variants are _structural types_ defined in the library that can be satisfied by any user-defined object with the right properties, including but not limited to the real primitives.


made slight edit here to try to clarify that it's about the runtime typeof operator in TS vs the type-time typeof operator, which also exists.

nx-cloud · 2024-06-15T20:07:54Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit f7d7253. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 1 target

nx run repo-tools:postinstall-script

Sent with 💌 from NxCloud.

JoshuaKGoldberg

🙌 lovely!

Josh-Cena · 2024-06-16T15:04:57Z

packages/eslint-plugin/docs/rules/no-wrapper-object-types.mdx

+It is widely considered a JavaScript best practice to work directly with the built-in primitives, like `0`, rather than objects that "look like" numbers, like `new Number(0)`.
+Primitives are simpler to conceptualize, work with `==` and `===` equality checks -- which their object equivalents do notDeepEqual -- and have well-known behavior around truthiness/falsiness which is common to rely on.


Suggested change

It is widely considered a JavaScript best practice to work directly with the built-in primitives, like `0`, rather than objects that "look like" numbers, like `new Number(0)`.

Primitives are simpler to conceptualize, work with `==` and `===` equality checks -- which their object equivalents do notDeepEqual -- and have well-known behavior around truthiness/falsiness which is common to rely on.

It is widely considered a JavaScript best practice to work directly with the built-in primitives, like `0`, rather than objects that "look like" numbers, like `new Number(0)`.

Primitives work with `==` and `===` equality checks and have more commonly relied-on behavior around truthiness/falsiness, while two objects that wrap the same primitive values do not compare equal, and _all_ wrapper objects are truthy regardless of the wrapped value.

Furthermore TypeScript prevents using `Number` in places that expect `number`—if a function accepts `number`, you cannot pass a value of type `Number` to it.

You also cannot do subtraction on `Number` values.

I'll think about this a bit. Two things I wanna pay attention to

number is the specific example in this section, but it's supposed to make a point about the primitives in general, not just numbers

If we give too much justification, it can seem like this is something controversial that we're just weirdly strongly opinionated about, rather than something that's not even slightly in dispute by anyone. 😆

That's true. Well it's up to your decision. I certainly want to keep this phrasing though:

Primitives work with == and === equality checks and have more commonly relied-on behavior around truthiness/falsiness, while two objects that wrap the same primitive values do not compare equal, and all wrapper objects are truthy regardless of the wrapped value.

Adapted this a bit to make space for examples, each using a different primitive type. Let me know what you think!

JoshuaKGoldberg · 2024-06-22T17:59:18Z

packages/eslint-plugin/docs/rules/no-wrapper-object-types.mdx

@@ -10,13 +10,16 @@ import TabItem from '@theme/TabItem';
 > See **https://typescript-eslint.io/rules/no-wrapper-object-types** for documentation.

 The JavaScript language has a set of language types, but some of them correspond to two TypeScript types, which look similar: `boolean`/`Boolean`, `number`/`Number`, `string`/`String`, `bigint`/`BigInt`, `symbol`/`Symbol`, `object`/`Object`.


While we're here 😄 I'm re-reading this and finding it hard to parse... maybe:

Suggested change

The JavaScript language has a set of language types, but some of them correspond to two TypeScript types, which look similar: `boolean`/`Boolean`, `number`/`Number`, `string`/`String`, `bigint`/`BigInt`, `symbol`/`Symbol`, `object`/`Object`.

The JavaScript language has a set of built-in ("intrinsic") type pairs which look similar: `boolean`/`Boolean`, `number`/`Number`, `string`/`String`, `bigint`/`BigInt`, `symbol`/`Symbol`, and `object`/`Object`.

packages/eslint-plugin/docs/rules/no-wrapper-object-types.mdx

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

codecov · 2024-06-22T21:50:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.42%. Comparing base (d685948) to head (3821222).
Report is 94 commits behind head on v8.

❗ Current head 3821222 differs from pull request most recent head f7d7253

Please upload reports for the commit f7d7253 to get more accurate results.

Additional details and impacted files

@@            Coverage Diff             @@
##               v8    #9363      +/-   ##
==========================================
- Coverage   88.37%   87.42%   -0.95%     
==========================================
  Files         419      390      -29     
  Lines       14610    13245    -1365     
  Branches     4274     3833     -441     
==========================================
- Hits        12911    11580    -1331     
+ Misses       1375     1363      -12     
+ Partials      324      302      -22

Flag	Coverage Δ
unittest	`87.42% <ø> (-0.95%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 52 files with indirect coverage changes

JoshuaKGoldberg

Yay!

Josh-Cena

I have some reservations but I think this generally looks great

Josh-Cena · 2024-06-27T00:19:57Z

packages/eslint-plugin/docs/rules/no-wrapper-object-types.mdx

-JavaScript programs typically work with the real number primitives, rather than objects that "look like" numbers.
-Primitives are simpler to conceptualize and work with `==` and `===` equality checks -- which their object equivalents do notDeepEqual.
-As a result, using the lowercase type names like `number` instead of the uppercase names like `Number` helps make your code behave more reliably.
+The JavaScript language has a set of built-in ("intrinsic") types which look similar: `boolean`/`Boolean`, `number`/`Number`, `string`/`String`, `bigint`/`BigInt`, `symbol`/`Symbol`, and `object`/`Object`.


I think this loses the nuance that we tried hard to keep in the original docs. JavaScript only has eight types: number, object, string, symbol, boolean, bigint, undefined, null. Boolean, Number, etc. are subtypes of object. It's only in TypeScript-land where they are sort of parallel and can be compared to each other.

I actually agree. I would like to go with something more similar to the original wording as well.

Neither here nor there, but

Boolean, Number, etc. are subtypes of object.

TIL that

let o: object = false; // <-- TS error // BUT let b: Boolean = false; o = b; // no error lol

The wrapper types are so bad lol

Yep—everything that doesn't claim to be a primitive is implicitly object, including {}. object does not actually mean "non-primitive"; it just means "is not definitely primitive".

JoshuaKGoldberg

Looks great to me! Just the one nit, not a blocker if you disagree. Thanks! 🎉

packages/eslint-plugin/docs/rules/no-wrapper-object-types.mdx

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

stale

Josh-Cena

Love this!

clean up a bit of phrasing in no-wrapper-object-types

5f6a172

kirkwaiblinger commented Jun 15, 2024

View reviewed changes

directly

13d2fad

kirkwaiblinger mentioned this pull request Jun 15, 2024

feat(eslint-plugin): replace ban-types with no-restricted-types, no-unsafe-function-type, no-wrapper-object-types #9102

Merged

3 tasks

JoshuaKGoldberg approved these changes Jun 16, 2024

View reviewed changes

JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jun 16, 2024

Josh-Cena reviewed Jun 16, 2024

View reviewed changes

kirkwaiblinger added 2 commits June 20, 2024 18:45

pr feedback

2a564bb

touchup

ca4b4ee

kirkwaiblinger requested review from JoshuaKGoldberg and Josh-Cena June 21, 2024 00:49

JoshuaKGoldberg reviewed Jun 22, 2024

View reviewed changes

kirkwaiblinger and others added 2 commits June 22, 2024 15:17

Update packages/eslint-plugin/docs/rules/no-wrapper-object-types.mdx

b7a491d

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

josh goldberg's suggestions

3821222

kirkwaiblinger requested a review from JoshuaKGoldberg June 22, 2024 21:35

JoshuaKGoldberg approved these changes Jun 24, 2024

View reviewed changes

Josh-Cena previously approved these changes Jun 27, 2024

View reviewed changes

change docs again

d6448dc

kirkwaiblinger requested review from JoshuaKGoldberg and Josh-Cena July 3, 2024 07:46

JoshuaKGoldberg approved these changes Jul 6, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-wrapper-object-types.mdx Outdated Show resolved Hide resolved

Update packages/eslint-plugin/docs/rules/no-wrapper-object-types.mdx

6ff7c3e

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

Merge branch 'v8' into kirk-no-wrapper-object-types-docs

f7d7253

Josh-Cena approved these changes Jul 12, 2024

View reviewed changes

kirkwaiblinger merged commit 46dd42f into typescript-eslint:v8 Jul 12, 2024
32 of 61 checks passed

kirkwaiblinger deleted the kirk-no-wrapper-object-types-docs branch July 12, 2024 06:12

kirkwaiblinger mentioned this pull request Jul 12, 2024

feat(eslint-plugin): backport no-unsafe-function type, no-wrapper-object-types from v8 to v7 #9507

Merged

3 tasks

github-actions bot locked as resolved and limited conversation to collaborators Jul 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: [no-wrapper-object-types] clean up a bit of phrasing #9363

docs: [no-wrapper-object-types] clean up a bit of phrasing #9363

kirkwaiblinger commented Jun 15, 2024

typescript-eslint bot commented Jun 15, 2024

netlify bot commented Jun 15, 2024 •

edited

Loading

kirkwaiblinger Jun 15, 2024

nx-cloud bot commented Jun 15, 2024 •

edited

Loading

JoshuaKGoldberg left a comment

Josh-Cena Jun 16, 2024 •

edited

Loading

kirkwaiblinger Jun 16, 2024 •

edited

Loading

Josh-Cena Jun 16, 2024 •

edited

Loading

kirkwaiblinger Jun 21, 2024

JoshuaKGoldberg Jun 22, 2024

codecov bot commented Jun 22, 2024 •

edited

Loading

JoshuaKGoldberg left a comment

Josh-Cena left a comment

Josh-Cena Jun 27, 2024

kirkwaiblinger Jul 3, 2024

kirkwaiblinger Jul 3, 2024

Josh-Cena Jul 4, 2024 •

edited

Loading

JoshuaKGoldberg left a comment

Josh-Cena left a comment

		It is widely considered a JavaScript best practice to work directly with the built-in primitives, like `0`, rather than objects that "look like" numbers, like `new Number(0)`.
		Primitives are simpler to conceptualize, work with `==` and `===` equality checks -- which their object equivalents do notDeepEqual -- and have well-known behavior around truthiness/falsiness which is common to rely on.

		@@ -10,13 +10,16 @@ import TabItem from '@theme/TabItem';
		> See https://typescript-eslint.io/rules/no-wrapper-object-types for documentation.

		The JavaScript language has a set of language types, but some of them correspond to two TypeScript types, which look similar: `boolean`/`Boolean`, `number`/`Number`, `string`/`String`, `bigint`/`BigInt`, `symbol`/`Symbol`, `object`/`Object`.

	The JavaScript language has a set of language types, but some of them correspond to two TypeScript types, which look similar: `boolean`/`Boolean`, `number`/`Number`, `string`/`String`, `bigint`/`BigInt`, `symbol`/`Symbol`, `object`/`Object`.
	The JavaScript language has a set of built-in ("intrinsic") type pairs which look similar: `boolean`/`Boolean`, `number`/`Number`, `string`/`String`, `bigint`/`BigInt`, `symbol`/`Symbol`, and `object`/`Object`.

docs: [no-wrapper-object-types] clean up a bit of phrasing #9363

docs: [no-wrapper-object-types] clean up a bit of phrasing #9363

Conversation

kirkwaiblinger commented Jun 15, 2024

PR Checklist

Overview

typescript-eslint bot commented Jun 15, 2024

netlify bot commented Jun 15, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

kirkwaiblinger Jun 15, 2024

Choose a reason for hiding this comment

nx-cloud bot commented Jun 15, 2024 • edited Loading

☁️ Nx Cloud Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Josh-Cena Jun 16, 2024 • edited Loading

Choose a reason for hiding this comment

kirkwaiblinger Jun 16, 2024 • edited Loading

Choose a reason for hiding this comment

Josh-Cena Jun 16, 2024 • edited Loading

Choose a reason for hiding this comment

kirkwaiblinger Jun 21, 2024

Choose a reason for hiding this comment

JoshuaKGoldberg Jun 22, 2024

Choose a reason for hiding this comment

codecov bot commented Jun 22, 2024 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Josh-Cena left a comment

Choose a reason for hiding this comment

Josh-Cena Jun 27, 2024

Choose a reason for hiding this comment

kirkwaiblinger Jul 3, 2024

Choose a reason for hiding this comment

kirkwaiblinger Jul 3, 2024

Choose a reason for hiding this comment

Josh-Cena Jul 4, 2024 • edited Loading

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Josh-Cena left a comment

Choose a reason for hiding this comment

netlify bot commented Jun 15, 2024 •

edited

Loading

nx-cloud bot commented Jun 15, 2024 •

edited

Loading

Josh-Cena Jun 16, 2024 •

edited

Loading

kirkwaiblinger Jun 16, 2024 •

edited

Loading

Josh-Cena Jun 16, 2024 •

edited

Loading

codecov bot commented Jun 22, 2024 •

edited

Loading

Josh-Cena Jul 4, 2024 •

edited

Loading