‼️ NOTICE: @types/[email protected] breaks builds #20319

corymhall · 2022-05-12T20:36:30Z

Describe the bug

A recent release of @types/prettier (2.6.1) updated the minimum typescript version from 3.7 to 4.2, which is not supported.

@types/prettier is a transitive dependency

npm explain @types/prettier                                                                                                                                                       
@types/[email protected] dev                                                                                                                                                           
node_modules/@types/prettier                                                                                                                                                        
  @types/prettier@"^2.1.5" from [email protected]                                                                                                                                
  node_modules/jest-snapshot                                                                                                                                                        
    jest-snapshot@"^27.5.1" from @jest/[email protected]                                                                                                                                  
    node_modules/@jest/core                                                                                                                                                         
      @jest/core@"^27.5.1" from [email protected]

Expected Behavior

No error.

Current Behavior

When trying to build a typescript app you get the error message:

node_modules/@types/prettier/index.d.ts:41:54 - error TS2315: Type 'IsTuple' is not generic.

41 type IndexProperties<T extends { length: number }> = IsTuple<T> extends true
                                                        ~~~~~~~~~~

node_modules/@types/prettier/index.d.ts:53:6 - error TS2456: Type alias 'IsTuple' circularly references itself.

53 type IsTuple<T> = T extends [] ? true : T extends [infer First, ...infer Remain] ? IsTuple<Remain> : false;
        ~~~~~~~

node_modules/@types/prettier/index.d.ts:53:65 - error TS2574: A rest element type must be an array type.

53 type IsTuple<T> = T extends [] ? true : T extends [infer First, ...infer Remain] ? IsTuple<Remain> : false;
                                                                   ~~~~~~~~~~~~~~~

node_modules/@types/prettier/index.d.ts:53:84 - error TS2315: Type 'IsTuple' is not generic.

53 type IsTuple<T> = T extends [] ? true : T extends [infer First, ...infer Remain] ? IsTuple<Remain> : false;
                                                                                      ~~~~~~~~~~~~~~~

node_modules/@types/prettier/index.d.ts:96:5 - error TS2589: Type instantiation is excessively deep and possibly infinite.

96     call<
       ~~~~

node_modules/@types/prettier/index.d.ts:131:5 - error TS2589: Type instantiation is excessively deep and possibly infinite.

131     each<
        ~~~~

node_modules/@types/prettier/index.d.ts:165:5 - error TS2589: Type instantiation is excessively deep and possibly infinite.

165     map<
        ~~~


Found 7 errors.

Reproduction Steps

Step 1 - create a new CDK app

cdk init --language=typescript app

Step 2 - Try to build

npm run build

Possible Solution

Pin @types/prettier to 2.6.0 in devDependencies

package.json

{
  "devDependencies": {
    "@types/prettier": "2.6.0"
  }
}

Additional Information/Context

No response

CDK CLI Version

2.24.0

Framework Version

No response

Node.js Version

16.14.0

OS

Linux

Language

Typescript

Language Version

No response

Other information

No response

The text was updated successfully, but these errors were encountered:

corymhall · 2022-05-12T20:39:16Z

Issue in DefinitelyTyped
DefinitelyTyped/DefinitelyTyped#60310

biffgaut · 2022-05-12T21:12:53Z

We're seeing it too.

biffgaut · 2022-05-12T21:24:51Z

Any build of a brand new CDK program is breaking:

AWS/Constructs/clients
▶ md pretty

AWS/Constructs/clients
▶ cd pretty

Constructs/clients/pretty
▶ cdk init --language typescript

Applying project template app for typescript
# Welcome to your CDK TypeScript project

This is a blank project for TypeScript development with CDK.

The `cdk.json` file tells the CDK Toolkit how to execute your app.

## Useful commands

* `npm run build`   compile typescript to js
* `npm run watch`   watch for changes and compile
* `npm run test`    perform the jest unit tests
* `cdk deploy`      deploy this stack to your default AWS account/region
* `cdk diff`        compare deployed stack with current state
* `cdk synth`       emits the synthesized CloudFormation template

Initializing a new git repository...
bin/pretty.ts:18:  // env: { account: '123456789012', region: 'us-east-1' },

[ERROR] Matched one or more prohibited patterns

Possible mitigations:
- Mark false positives as allowed using: git config --add secrets.allowed ...
- Mark false positives as allowed by adding regular expressions to .gitallowed at repository's root directory
- List your configured patterns: git config --get-all secrets.patterns
- List your configured allowed patterns: git config --get-all secrets.allowed
- List your configured allowed patterns in .gitallowed at repository's root directory
- Use --no-verify if this is a one-time false positive
Unable to initialize git repository for your project.
Executing npm install...
npm WARN deprecated [email protected]: See https://github.com/lydell/source-map-url#deprecated
npm WARN deprecated [email protected]: Please see https://github.com/lydell/urix#deprecated
npm WARN deprecated [email protected]: https://github.com/lydell/resolve-url#deprecated
npm WARN deprecated [email protected]: See https://github.com/lydell/source-map-resolve#deprecated
npm WARN deprecated [email protected]: some dependency vulnerabilities fixed, support for node < 10 dropped, and newer ECMAScript syntax/features added
npm notice
npm notice New minor version of npm available! 8.3.0 -> 8.10.0
npm notice Changelog: https://github.com/npm/cli/releases/tag/v8.10.0
npm notice Run npm install -g [email protected] to update!
npm notice
✅ All done!


Constructs/clients/pretty  master ✗                                                                                         ✚ ◒
▶ npm run build

> [email protected] build
> tsc

node_modules/@types/prettier/index.d.ts:41:54 - error TS2315: Type 'IsTuple' is not generic.

41 type IndexProperties<T extends { length: number }> = IsTuple<T> extends true
                                                        ~~~~~~~~~~

node_modules/@types/prettier/index.d.ts:53:6 - error TS2456: Type alias 'IsTuple' circularly references itself.

53 type IsTuple<T> = T extends [] ? true : T extends [infer First, ...infer Remain] ? IsTuple<Remain> : false;
        ~~~~~~~

node_modules/@types/prettier/index.d.ts:53:65 - error TS2574: A rest element type must be an array type.

53 type IsTuple<T> = T extends [] ? true : T extends [infer First, ...infer Remain] ? IsTuple<Remain> : false;
                                                                   ~~~~~~~~~~~~~~~

node_modules/@types/prettier/index.d.ts:53:84 - error TS2315: Type 'IsTuple' is not generic.

53 type IsTuple<T> = T extends [] ? true : T extends [infer First, ...infer Remain] ? IsTuple<Remain> : false;
                                                                                      ~~~~~~~~~~~~~~~

node_modules/@types/prettier/index.d.ts:96:5 - error TS2589: Type instantiation is excessively deep and possibly infinite.

96     call<
       ~~~~

node_modules/@types/prettier/index.d.ts:131:5 - error TS2589: Type instantiation is excessively deep and possibly infinite.

131     each<
        ~~~~

node_modules/@types/prettier/index.d.ts:165:5 - error TS2589: Type instantiation is excessively deep and possibly infinite.

165     map<
        ~~~


Found 7 errors.

npm notice
npm notice New minor version of npm available! 8.3.0 -> 8.10.0
npm notice Changelog: https://github.com/npm/cli/releases/tag/v8.10.0
npm notice Run npm install -g [email protected] to update!
npm notice

Constructs/clients/pretty  master ✗                                                                                        ✚ ◒  ⍉
▶

Here is the package.json for the project:

{
  "name": "pretty",
  "version": "0.1.0",
  "bin": {
    "pretty": "bin/pretty.js"
  },
  "scripts": {
    "build": "tsc",
    "watch": "tsc -w",
    "test": "jest",
    "cdk": "cdk"
  },
  "devDependencies": {
    "@types/jest": "^26.0.10",
    "@types/node": "10.17.27",
    "jest": "^26.4.2",
    "ts-jest": "^26.2.0",
    "aws-cdk": "2.20.0",
    "ts-node": "^9.0.0",
    "typescript": "~3.9.7"
  },
  "dependencies": {
    "aws-cdk-lib": "2.20.0",
    "constructs": "^10.0.0",
    "source-map-support": "^0.5.16"
  }
}

Constructs/clients/pretty  master ✗                                                                                        ✚ ◒  ⍉
▶ cdk --version
2.20.0 (build 738ef49)

@types/prettier is a transitive dependency of `jest`. Version `2.6.1` introduced a breaking change by increasing the minimum supported version of typescript to `4.2`. See related issue for more information. re #20319 ---- ### All Submissions: * [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

---- ### All Submissions: * [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*---- ### All Submissions: * [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* @types/prettier is a transitive dependency of `jest`. Version `2.6.1` introduced a breaking change by increasing the minimum supported version of typescript to `4.2`. See related issue for more information. re #20319 ---- ### All Submissions: * [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

re aws/aws-cdk#20319 The other option is to do what is mentioned in the referenced issue and add a devDependency for `@types/prettier`, but since it is possible to upgrade `typescript` that seems like the better option.

Addresses the issue described in aws/aws-cdk#20319 --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

johnnyshankman · 2022-05-17T15:19:01Z

+1 Had the same issue this morning.

Solved it by pinning the version to 2.6.0 in my devDependencies and suddenly no issues.

"devDependencies": {
    "@aws-cdk/assertions": "1.143.0",
    "@types/node": "10.17.27",
    "aws-cdk": "1.143.0",
    "ts-node": "^9.0.0",
    "typescript": "~3.9.7",
    "@types/prettier": "2.6.0"
  },

I previously did not have any declaration for the @types/prettier package.

Update: Having this across many of my builds and been making this same update in many places now.

aws/aws-cdk#20319

@types/prettier is a transitive dependency of `jest`. Version `2.6.1` introduced a breaking change by increasing the minimum supported version of typescript to `4.2`. See related issue for more information. re aws#20319 ---- ### All Submissions: * [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

github-actions · 2022-08-02T12:56:58Z

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

re aws/aws-cdk#20319 The other option is to do what is mentioned in the referenced issue and add a devDependency for `@types/prettier`, but since it is possible to upgrade `typescript` that seems like the better option.

corymhall added bug This issue is a bug. p0 needs-triage This issue or PR still needs to be triaged. labels May 12, 2022

corymhall changed the title ~~@types/[email protected] breaks builds~~ ‼️ NOTICE: @types/[email protected] breaks builds May 12, 2022

corymhall pinned this issue May 12, 2022

corymhall self-assigned this May 12, 2022

biffgaut mentioned this issue May 12, 2022

Issue - Builds breaking in @types/prettier/index.d.ts awslabs/aws-solutions-constructs#697

Closed

corymhall mentioned this issue May 12, 2022

chore: pin @types/prettier to 2.6.0 #20322

Merged

4 tasks

corymhall mentioned this issue May 12, 2022

chore(release): v1.156.1 #20324

Merged

12 tasks

biffgaut mentioned this issue May 13, 2022

fix(@types/prettier 2.6.0): Pin @types/prettier 2.6.0 til 2.6.1 issue resolved awslabs/aws-solutions-constructs#698

Merged

corymhall mentioned this issue May 13, 2022

chore(deps): update typescript to 4.6.0 aws-samples/aws-cdk-examples#676

Merged

Chriscbr mentioned this issue May 16, 2022

fix: pin @types/prettier on JsiiProject projen/projen#1855

Merged

aripalo added a commit to alma-cdk/openapix that referenced this issue May 18, 2022

fix: pj build issue related to @types/prettier bug

488bb4c

aws/aws-cdk#20319

peterwoodworth removed the needs-triage This issue or PR still needs to be triaged. label May 19, 2022

SlootSantos added a commit to SlootSantos/dns-cdk-pipeline that referenced this issue May 22, 2022

fix prettier version to work around see: aws/aws-cdk#20319

93ea366

suhussai mentioned this issue May 27, 2022

Recent @types/prettier release breaks TypeScript build of TenantPipeline aws-samples/aws-saas-factory-ref-solution-serverless-saas#27

Closed

madeline-k unpinned this issue May 30, 2022

flochaz mentioned this issue Jun 7, 2022

Argument of type 'this' is not assignable to parameter of type 'Construct'. awslabs/aws-bootstrap-kit#102

Closed

corymhall closed this as completed Aug 2, 2022

laithalsaadoon mentioned this issue Mar 22, 2023

make deploy failed on TypeScript/Prettier linting due to old TypeScript version aws-samples/voice-enabled-patient-diary#11

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

‼️ NOTICE: @types/[email protected] breaks builds #20319

‼️ NOTICE: @types/[email protected] breaks builds #20319

corymhall commented May 12, 2022 •

edited

Loading

corymhall commented May 12, 2022

biffgaut commented May 12, 2022

biffgaut commented May 12, 2022

johnnyshankman commented May 17, 2022 •

edited

Loading

github-actions bot commented Aug 2, 2022

‼️ NOTICE: @types/[email protected] breaks builds #20319

‼️ NOTICE: @types/[email protected] breaks builds #20319

Comments

corymhall commented May 12, 2022 • edited Loading

Describe the bug

Expected Behavior

Current Behavior

Reproduction Steps

Possible Solution

Additional Information/Context

CDK CLI Version

Framework Version

Node.js Version

OS

Language

Language Version

Other information

corymhall commented May 12, 2022

biffgaut commented May 12, 2022

biffgaut commented May 12, 2022

johnnyshankman commented May 17, 2022 • edited Loading

github-actions bot commented Aug 2, 2022

⚠️COMMENT VISIBILITY WARNING⚠️

corymhall commented May 12, 2022 •

edited

Loading

johnnyshankman commented May 17, 2022 •

edited

Loading