feat: Move shared types into their own package #425

bradzacher · 2019-04-11T22:39:22Z

Happy to change the name of the package, wasn't sure what to call it.

This PR moves the ESLint override types (and the createRule function) out of the eslint-plugin package and into a new package.

This should make it easier for people to consume our libraries when writing rules they don't want to submit here (because they're internal rules, etc), or when they're writing an eslint plugin in typescript.

… users

codecov · 2019-04-12T00:14:45Z

Codecov Report

Merging #425 into master will decrease coverage by 0.73%.
The diff coverage is 68.88%.

@@            Coverage Diff            @@
##           master    #425      +/-   ##
=========================================
- Coverage   96.23%   95.5%   -0.74%     
=========================================
  Files          83      88       +5     
  Lines        4067    4093      +26     
  Branches     1149    1150       +1     
=========================================
- Hits         3914    3909       -5     
- Misses         52      82      +30     
- Partials      101     102       +1

Impacted Files	Coverage Δ
...ackages/eslint-plugin/src/rules/prefer-includes.ts	`100% <ø> (ø)`	⬆️
...slint-plugin/src/rules/no-unnecessary-qualifier.ts	`96.07% <ø> (ø)`	⬆️
packages/eslint-plugin/src/rules/array-type.ts	`91.35% <ø> (ø)`	⬆️
packages/eslint-plugin/src/rules/member-naming.ts	`100% <ø> (ø)`	⬆️
...plugin/src/rules/prefer-string-starts-ends-with.ts	`100% <ø> (ø)`	⬆️
...s/experimental-utils/src/eslint-utils/deepMerge.ts	`88.23% <ø> (ø)`
packages/typescript-estree/src/ast-converter.ts	`100% <ø> (ø)`	⬆️
packages/parser/src/scope/scopes.ts	`100% <ø> (ø)`	⬆️
...xperimental-utils/src/eslint-utils/applyDefault.ts	`83.33% <ø> (ø)`
...slint-plugin/src/rules/prefer-namespace-keyword.ts	`100% <ø> (ø)`	⬆️
... and 68 more

packages/eslint-plugin/src/rules/await-thenable.ts

packages/parser/src/parser.ts

packages/typescript-estree/src/parser-options.ts

JamesHenry

This looks really good! I will start using it right away on the stuff I mentioned on slack.

However, please could we call it:

@typescript-eslint/experimental-utils

I think it would be really useful for it to initially not fall under proper semver to give us chance to "move fast and break things" for a bit. As we use it outside the monorepo we might well find things we need to tweak.

So we could have experimental in the name and then a corresponding disclaimer in the README of the package that that is what our plan is. "Feel free to use it, but no guarantees between minor version s"

We can then promote it to be just:

@typescript-eslint/utils

In v2.0.0.

WDYT?

bradzacher · 2019-05-09T01:29:30Z

@typescript-eslint/experimental-utils

Sounds like a good idea!
I'll make the change now :)

# Conflicts: # packages/eslint-plugin/src/rules/no-extra-parens.ts # packages/eslint-plugin/tests/RuleTester.ts # packages/eslint-plugin/typings/ts-eslint.d.ts

# Conflicts: # packages/eslint-plugin/src/rules/no-unnecessary-type-assertion.ts

# Conflicts: # packages/eslint-plugin/tests/RuleTester.ts # packages/eslint-plugin/tests/rules/indent/indent.test.ts # packages/eslint-plugin/typings/ts-eslint.d.ts

SimenB · 2019-06-03T08:27:28Z

Hello! 👋

This should make it easier for people to consume our libraries when writing rules they don't want to submit here (because they're internal rules, etc), or when they're writing an eslint plugin in typescript.

I tried to do this, and it broke horribly since the utils depend on typescript. Is that on purpose? I'd like to author the plugin in TS, but that shouldn't be visible to consumers of the plugin.

Sorta related, I got a type error in the test unless I specified the TS parser - are the plugins compatible with the standard parser, or will the type safety be wrong if another parser is used?

Ref jest-community/eslint-plugin-jest#269

See: #425 (comment)

bradzacher · 2019-06-03T15:20:59Z

@SimenB - there's no direct dependency on typescript, but there is a peer dependency:
https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/experimental-utils/package.json#L42-L45

The package re-exports some things from typescript-estree via the default entry point
https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/experimental-utils/src/index.ts#L9-L14

Which causes the package to init, and it has a dependency of typescript (it's marked as a peer dep to help out the create-react-app folks that do some dual install stuff (#443).

I'll put up a fix so that this doesn't happen.

See: #425 (comment)

SimenB · 2019-06-03T16:06:54Z

Ah, that's awesome! Thanks.

Thoughts on not specifying parser in RuleTester?

typescript-eslint/packages/experimental-utils/src/ts-eslint/RuleTester.ts

Line 58 in fac5c7d

parser: '@typescript-eslint/parser';

I'd like to run tests with the default eslint parser

bradzacher · 2019-06-03T16:09:59Z

feel free to open a PR if you want!
I thought about that but was deferring on it till someone complained :)
Happy to have it as a generic so that it is easy to enforce a specific parser string at compile time.

SimenB · 2019-06-03T16:15:32Z

Hehe, fair enough! I'll see what I can do

Happy to have it as a generic so that it is easy to enforce a specific parser string at compile time.

How so? I thought to just make it parser?: string

bradzacher added 7 commits March 27, 2019 15:15

temp commit

2dc9a9b

Move ts-eslint into the utils package

f3fad76

Merge branch 'master' into utils-pkg

19de75f

move createRule into the util package

cd9adcc

run prettier

f935bf6

move util tests to the correct package

db1bc9d

switch to * as ts within typescript-estree to better support external…

77f3eab

… users

bradzacher added the enhancement New feature or request label Apr 11, 2019

bradzacher requested a review from a team April 11, 2019 22:39

yarn format

ddf0791

j-f1 reviewed Apr 12, 2019

View reviewed changes

packages/eslint-plugin/src/rules/await-thenable.ts Show resolved Hide resolved

j-f1 requested a review from a team April 12, 2019 18:46

bradzacher mentioned this pull request Apr 20, 2019

feat(eslint-plugin): Begin rewrite of indent rule #439

Merged

Merge branch 'master', add docs

f6fb95f

bradzacher marked this pull request as ready for review April 27, 2019 03:13

bradzacher added 2 commits May 6, 2019 17:56

Merge branch 'master' into utils-pkg

4632095

Merge branch 'master' into utils-pkg

c65855e

bradzacher requested review from JamesHenry and removed request for a team May 7, 2019 01:00

bradzacher added 2 commits May 8, 2019 08:59

Merge branch 'master' into utils-pkg

da3bb37

Merge branch 'master' into utils-pkg

e4b56a5

JamesHenry reviewed May 9, 2019

View reviewed changes

packages/parser/src/parser.ts Outdated Show resolved Hide resolved

JamesHenry reviewed May 9, 2019

View reviewed changes

packages/typescript-estree/src/parser-options.ts Outdated Show resolved Hide resolved

JamesHenry requested changes May 9, 2019

View reviewed changes

rename to experimental-utils, update readme

d3bd94f

bradzacher mentioned this pull request May 9, 2019

2.0.0 Breaking Changes #501

Closed

14 tasks

bradzacher added 2 commits May 8, 2019 19:04

Merge branch 'master' into utils-pkg

3b7a46f

# Conflicts: # packages/eslint-plugin/src/rules/no-extra-parens.ts # packages/eslint-plugin/tests/RuleTester.ts # packages/eslint-plugin/typings/ts-eslint.d.ts

Merge branch 'master' into utils-pkg

04b1842

# Conflicts: # packages/eslint-plugin/src/rules/no-unnecessary-type-assertion.ts

Merge branch 'master' into utils-pkg

38cbede

# Conflicts: # packages/eslint-plugin/tests/RuleTester.ts # packages/eslint-plugin/tests/rules/indent/indent.test.ts # packages/eslint-plugin/typings/ts-eslint.d.ts

bradzacher added awaiting response Issues waiting for a reply from the OP or another party and removed awaiting response Issues waiting for a reply from the OP or another party labels May 9, 2019

JamesHenry approved these changes May 10, 2019

View reviewed changes

bradzacher merged commit a7a03ce into master May 10, 2019

bradzacher deleted the utils-pkg branch May 10, 2019 16:10

SimenB mentioned this pull request May 10, 2019

Rewrite in TypeScript jest-community/eslint-plugin-jest#256

Closed

35 tasks

bradzacher added a commit that referenced this pull request Jun 3, 2019

fix(experimental-utils): Avoid typescript import at runtime

ee481b4

See: #425 (comment)

bradzacher mentioned this pull request Jun 3, 2019

fix(experimental-utils): Avoid typescript import at runtime #584

Merged

bradzacher added a commit that referenced this pull request Jun 3, 2019

fix(experimental-utils): Avoid typescript import at runtime (#584)

fac5c7d

See: #425 (comment)

SimenB mentioned this pull request Jul 17, 2019

fix(utils): RuleTester should not require a parser #713

Merged

github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Move shared types into their own package #425

feat: Move shared types into their own package #425

bradzacher commented Apr 11, 2019 •

edited

Loading

codecov bot commented Apr 12, 2019 •

edited

Loading

JamesHenry left a comment

bradzacher commented May 9, 2019

SimenB commented Jun 3, 2019

bradzacher commented Jun 3, 2019

SimenB commented Jun 3, 2019 •

edited

Loading

bradzacher commented Jun 3, 2019

SimenB commented Jun 3, 2019 •

edited

Loading

feat: Move shared types into their own package #425

feat: Move shared types into their own package #425

Conversation

bradzacher commented Apr 11, 2019 • edited Loading

codecov bot commented Apr 12, 2019 • edited Loading

Codecov Report

JamesHenry left a comment

Choose a reason for hiding this comment

bradzacher commented May 9, 2019

SimenB commented Jun 3, 2019

bradzacher commented Jun 3, 2019

SimenB commented Jun 3, 2019 • edited Loading

bradzacher commented Jun 3, 2019

SimenB commented Jun 3, 2019 • edited Loading

bradzacher commented Apr 11, 2019 •

edited

Loading

codecov bot commented Apr 12, 2019 •

edited

Loading

SimenB commented Jun 3, 2019 •

edited

Loading

SimenB commented Jun 3, 2019 •

edited

Loading