Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade TypeScript #102

Merged
merged 3 commits into from
Mar 29, 2020
Merged

Upgrade TypeScript #102

merged 3 commits into from
Mar 29, 2020

Conversation

bobjflong
Copy link
Contributor

No description provided.

@@ -226,6 +223,7 @@ export default class PQueue<QueueType extends Queue<RunFunction, EnqueueOptionsT
/**
Adds a sync or async task to the queue. Always returns a promise.
*/
// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
async add<TaskResultType>(fn: Task<TaskResultType>, options: Partial<EnqueueOptionsType> = {}): Promise<TaskResultType> {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's tricky to use Readonly types here because the {} assignment.

Copy link
Owner

Choose a reason for hiding this comment

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

How so? Can you elaborate? If it's not possible to use readonly here, it sounds like a the linter rule should be adjusted to ignore this case.

Copy link
Contributor Author

@bobjflong bobjflong Mar 27, 2020

Choose a reason for hiding this comment

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

If you type options as

Readonly<Partial<EnqueueOptionsType>> = {}

Then this type error is returned:

Type '{}' is not assignable to type 'Readonly<Partial<EnqueueOptionsType>>'.ts(2322)

And the linter does want options to be Readonly afaict:

source/index.ts:229:58
  ✖  229:58  Parameter should be a read only type

Not an expert, but this indeed could be a linting issue I think. We shouldn't require options to be readonly in this case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let me know what you'd prefer in this case. Happy to look into that linting thing too if it's confirmed an issue.

Copy link
Owner

Choose a reason for hiding this comment

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

If TypeScript doesn't allow it, it's a linter bug. Can you open an issue here: https://github.com/typescript-eslint/typescript-eslint ?

package.json Outdated Show resolved Hide resolved
source/index.ts Outdated Show resolved Hide resolved
source/index.ts Outdated Show resolved Hide resolved
@@ -226,6 +223,7 @@ export default class PQueue<QueueType extends Queue<RunFunction, EnqueueOptionsT
/**
Adds a sync or async task to the queue. Always returns a promise.
*/
// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
async add<TaskResultType>(fn: Task<TaskResultType>, options: Partial<EnqueueOptionsType> = {}): Promise<TaskResultType> {
Copy link
Owner

Choose a reason for hiding this comment

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

How so? Can you elaborate? If it's not possible to use readonly here, it sounds like a the linter rule should be adjusted to ignore this case.

@sindresorhus sindresorhus changed the title Upgrade Typescript versions Upgrade TypeScript versions Mar 29, 2020
@sindresorhus sindresorhus changed the title Upgrade TypeScript versions Upgrade TypeScript Mar 29, 2020
@sindresorhus sindresorhus merged commit 0131f7f into sindresorhus:master Mar 29, 2020
@sindresorhus
Copy link
Owner

👌

@bobjflong
Copy link
Contributor Author

@sindresorhus Without the .eslintignore file, this fails to build for me locally:

[p-queue] npm run test

> p-queue@6.3.0 test /Users/bob/src/p-queue
> xo && npm run build && nyc ava


  bench.ts
  ✖  Parsing error: "parserOptions.project" has been set for @typescript-eslint/parser.
The file does not match your project config: bench.ts.
The file must be included in at least one of the projects provided.      

  test/test.ts
  ✖  Parsing error: "parserOptions.project" has been set for @typescript-eslint/parser.
The file does not match your project config: test/test.ts.
The file must be included in at least one of the projects provided.  

@sindresorhus
Copy link
Owner

I fixed that by upgrading the xo dependency.

@bobjflong
Copy link
Contributor Author

Ah, cool

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants