feat(experimental-utils): move isTypeReadonly from eslint-plugin to experimental-utils #3658

RebeccaStevens · 2021-07-25T22:06:42Z

files moved:

isTypeReadonly
nullThrows
propertyTypes

typescript-eslint · 2021-07-25T22:06:47Z

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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

nx-cloud · 2021-07-25T22:10:52Z

☁️ Nx Cloud Report

CI ran the following commands for commit edb5bc9. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 48 targets

Sent with 💌 from NxCloud.

codecov · 2021-07-25T22:14:55Z

Codecov Report

Merging #3658 (edb5bc9) into main (4bb55a2) will decrease coverage by 2.00%.
The diff coverage is 30.76%.

@@            Coverage Diff             @@
##             main    #3658      +/-   ##
==========================================
- Coverage   93.88%   91.88%   -2.01%     
==========================================
  Files         297      168     -129     
  Lines       11193     8382    -2811     
  Branches     3253     2666     -587     
==========================================
- Hits        10509     7702    -2807     
- Misses        416      481      +65     
+ Partials      268      199      -69

Flag	Coverage Δ
unittest	`91.88% <30.76%> (-2.01%)`	⬇️

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

Impacted Files	Coverage Δ
...slint-plugin/src/rules/no-unnecessary-condition.ts	`98.30% <ø> (ø)`
...ackages/eslint-plugin/src/util/getWrappingFixer.ts	`100.00% <ø> (ø)`
packages/type-utils/src/containsAllTypesByName.ts	`0.00% <0.00%> (ø)`
...ges/type-utils/src/getConstrainedTypeAtLocation.ts	`0.00% <0.00%> (ø)`
packages/type-utils/src/getContextualType.ts	`0.00% <0.00%> (ø)`
packages/type-utils/src/getDeclaration.ts	`0.00% <0.00%> (ø)`
packages/type-utils/src/getSourceFileOfNode.ts	`0.00% <0.00%> (ø)`
packages/type-utils/src/getTokenAtPosition.ts	`0.00% <0.00%> (ø)`
packages/type-utils/src/getTypeName.ts	`0.00% <0.00%> (ø)`
packages/type-utils/src/isTypeReadonly.ts	`0.00% <0.00%> (ø)`
... and 157 more

bradzacher

Hmm.. This might be a problem for some of our consumers.
Many consumers of @typescript-eslint/experimental-utils do so in environments that don't actually use typescript.

for example eslint-plugin-jest can be used by non-TS projects, but because the plugin is written in TS they use experimental-utils.

Could you please test two things for me:

(1) do a raw install of the plugin into a folder with no `typescript` dependency.

eg

cd /tmp
mkdir ts-eslint-test-3658
cd ts-eslint-test-3658
yarn add file:~/path/to/your/checkout/packages/experimental-utils

I believe that this should be the correct command to add a local path, and it should show warnings. I think.

The idea is that this should install fine with no warnings about missing dependencies.

We might be able to get around the warning by explicitly marking the TS dependency as optional:
https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/package.json#L68-L72

(2) make sure it doesn't crash when imported from an environment without TS installed.

cd /tmp/ts-eslint-test-3658
node --eval="require('@typescript-eslint/experimental-utils')"

This should not crash (I might have got the node command wrong... also try node and then executing the require in the REPL).

This should execute without crashing.

packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts

packages/experimental-utils/typings/typescript.d.ts

RebeccaStevens · 2021-08-01T09:10:26Z

I added typescript and tsutils as optional peer dependencies and conditionally loaded them when needed so that environments without typescript don't have issues.

…roject Once typescript-eslint/typescript-eslint#3658 is merged, this commit can be reverted

bradzacher · 2021-10-29T16:57:09Z

No problemo - thanks for all your work!

To make things easier for you lets see if we can get this merged sooner rather than later so we don't have to keep rebasing and dealing with merge conflicts!

I'll see if I can find some time this weekend to get this merged.

RebeccaStevens · 2021-10-30T08:51:10Z

Sounds good.
Thanks 😄

netlify · 2021-11-11T01:10:50Z

❌ Deploy Preview for typescript-eslint failed.

🔨 Explore the source changes: edb5bc9

🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/61ccafa134fc990007340b8b

bradzacher · 2021-11-11T08:33:19Z

update: I haven't forgotten about this - on my todo list. Hopefully this weekend.

RebeccaStevens · 2021-12-07T11:51:46Z

@bradzacher Updated again.

bradzacher · 2021-12-29T18:36:05Z

sorry it took me so long to get back to this!
I rebased, fixed the integration tests, and moved more of our type utils across.
I'll merge this as soon as the checks pass!

…roject Once typescript-eslint/typescript-eslint#3658 is merged, this commit can be reverted

RebeccaStevens mentioned this pull request Jul 26, 2021

new prefer-readonly-type rule eslint-functional/eslint-plugin-functional#237

Closed

bradzacher added the enhancement New feature or request label Aug 1, 2021

bradzacher requested changes Aug 1, 2021

View reviewed changes

packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts Outdated Show resolved Hide resolved

packages/experimental-utils/typings/typescript.d.ts Outdated Show resolved Hide resolved

bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Aug 1, 2021

RebeccaStevens force-pushed the feat/move-isTypeReadonly branch from 9726276 to d6e98f1 Compare August 1, 2021 09:04

RebeccaStevens force-pushed the feat/move-isTypeReadonly branch from d6e98f1 to e531d15 Compare August 1, 2021 09:29

bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label Aug 2, 2021

RebeccaStevens mentioned this pull request Aug 3, 2021

New rule: prefer-readonly-type-alias eslint-functional/eslint-plugin-functional#255

Closed

RebeccaStevens changed the title ~~feat(experimental-utils): move some util function files from eslint-plugin to experimental-utils~~ feat(experimental-utils): move isTypeReadonly from eslint-plugin to experimental-utils Aug 6, 2021

RebeccaStevens mentioned this pull request Aug 8, 2021

Updated prefer-readonly-type rule eslint-functional/eslint-plugin-functional#256

Closed

RebeccaStevens mentioned this pull request Aug 15, 2021

New rule: prefer-readonly-type-declaration eslint-functional/eslint-plugin-functional#259

Closed

RebeccaStevens force-pushed the feat/move-isTypeReadonly branch from 1f840cb to 5fd2cc1 Compare August 30, 2021 06:59

RebeccaStevens force-pushed the feat/move-isTypeReadonly branch 2 times, most recently from 66f8343 to 81dd8df Compare September 6, 2021 17:40

RebeccaStevens force-pushed the feat/move-isTypeReadonly branch from 88ac9ab to d73a71a Compare October 19, 2021 04:14

bradzacher self-assigned this Oct 30, 2021

RebeccaStevens force-pushed the feat/move-isTypeReadonly branch from d73a71a to 58ec395 Compare November 11, 2021 01:10

RebeccaStevens force-pushed the feat/move-isTypeReadonly branch 2 times, most recently from c9a11da to 4fc58d2 Compare November 18, 2021 00:06

RebeccaStevens force-pushed the feat/move-isTypeReadonly branch 3 times, most recently from f665577 to 481dd62 Compare December 7, 2021 11:27

RebeccaStevens and others added 2 commits December 29, 2021 09:49

feat: create new package type-utils

7742976

feat: fix tests, move more utils

b482f03

bradzacher force-pushed the feat/move-isTypeReadonly branch from 481dd62 to b482f03 Compare December 29, 2021 18:35

bradzacher previously approved these changes Dec 29, 2021

View reviewed changes

bradzacher dismissed their stale review via 063c353 December 29, 2021 18:45

bradzacher previously approved these changes Dec 29, 2021

View reviewed changes

test: fix tests

edb5bc9

bradzacher dismissed their stale review via edb5bc9 December 29, 2021 18:57

bradzacher force-pushed the feat/move-isTypeReadonly branch from 063c353 to edb5bc9 Compare December 29, 2021 18:57

bradzacher merged commit a9eb0b9 into typescript-eslint:main Dec 29, 2021

leotm mentioned this pull request Jan 5, 2022

Update typescript-eslint monorepo to v5.9.0 (minor) leotm/react-native-template-new-architecture#266

Merged

1 task

bradzacher mentioned this pull request Jan 15, 2022

feat(experimental-utils): moved types eslint-plugin util to experimental-utils #3317

Closed

3 tasks

github-actions bot locked as resolved and limited conversation to collaborators Jan 29, 2022

RebeccaStevens deleted the feat/move-isTypeReadonly branch March 10, 2023 23:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(experimental-utils): move isTypeReadonly from eslint-plugin to experimental-utils #3658

feat(experimental-utils): move isTypeReadonly from eslint-plugin to experimental-utils #3658

RebeccaStevens commented Jul 25, 2021 •

edited by bradzacher

Loading

typescript-eslint bot commented Jul 25, 2021

nx-cloud bot commented Jul 25, 2021 •

edited

Loading

codecov bot commented Jul 25, 2021 •

edited

Loading

bradzacher left a comment •

edited

Loading

RebeccaStevens commented Aug 1, 2021 •

edited

Loading

bradzacher commented Oct 29, 2021

RebeccaStevens commented Oct 30, 2021

netlify bot commented Nov 11, 2021 •

edited

Loading

bradzacher commented Nov 11, 2021

RebeccaStevens commented Dec 7, 2021

bradzacher commented Dec 29, 2021

feat(experimental-utils): move isTypeReadonly from eslint-plugin to experimental-utils #3658

feat(experimental-utils): move isTypeReadonly from eslint-plugin to experimental-utils #3658

Conversation

RebeccaStevens commented Jul 25, 2021 • edited by bradzacher Loading

typescript-eslint bot commented Jul 25, 2021

nx-cloud bot commented Jul 25, 2021 • edited Loading

☁️ Nx Cloud Report

codecov bot commented Jul 25, 2021 • edited Loading

Codecov Report

bradzacher left a comment • edited Loading

Choose a reason for hiding this comment

(1) do a raw install of the plugin into a folder with no typescript dependency.

(2) make sure it doesn't crash when imported from an environment without TS installed.

RebeccaStevens commented Aug 1, 2021 • edited Loading

bradzacher commented Oct 29, 2021

RebeccaStevens commented Oct 30, 2021

netlify bot commented Nov 11, 2021 • edited Loading

bradzacher commented Nov 11, 2021

RebeccaStevens commented Dec 7, 2021

bradzacher commented Dec 29, 2021

RebeccaStevens commented Jul 25, 2021 •

edited by bradzacher

Loading

nx-cloud bot commented Jul 25, 2021 •

edited

Loading

codecov bot commented Jul 25, 2021 •

edited

Loading

bradzacher left a comment •

edited

Loading

(1) do a raw install of the plugin into a folder with no `typescript` dependency.

RebeccaStevens commented Aug 1, 2021 •

edited

Loading

netlify bot commented Nov 11, 2021 •

edited

Loading