tsconfig.app.json 'includes' does not respect glob patterns for cypress

Open
#24,855 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
angular, cypress, typescript, webpack

Research direction

Reproduce the failure with npx cypress open in the linked repository, then inspect tsconfig.app.json, cypress.config.ts, and the Angular build path reported by @ngtools/webpack. Verify how the Cypress component file is selected for TypeScript compilation. Done means the component test opens without the missing-from-compilation error when the Cypress files are specified through include.

Written by the indexing model from the issue text.

Description

area: @ngtools/webpack needs: investigation
Which @angular/* package(s) are the source of the bug?

Don't known / other

Is this a regression?

Yes

Description

I've included a link to repo that provides the basic setup. To test the issue, you just need to run npx cypress open with the setup I've created, then click on 'component tests'. Now click on 'app.ts'. The error is provided below - essentially it's asking me to include the app.ts file in either the 'files' or 'include' property of the tsconfig.

This is what works when added to tsconfig.app.json:

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "outDir": "./out-tsc/app",
    "types": []
  },
  "files": [
    "src/main.ts",
    "cypress/component/app.ts"
  ],
  "include": [
    "src/**/*.d.ts",
  ]
}

This is what fails when added to tsconfig.app.json:

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "outDir": "./out-tsc/app",
    "types": []
  },
  "files": [
    "src/main.ts",
  ],
  "include": [
    "src/**/*.d.ts",
    "cypress/**/*.ts",
  ]
}

I checked multiple sources, and cannot see any error in the cypress glob pattern added to include.

Note, this also fails:

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "outDir": "./out-tsc/app",
    "types": []
  },
  "files": [
    "src/main.ts",
  ],
  "include": [
    "src/**/*.d.ts",
    "cypress/component/app.ts"
  ]
}

It appears to be a bug - I can't define it in any other terms at this point, as it's a basic example, applied to a boilerplate Angular application, with virtually no additions/tweaks outside of the this app.ts test.

Please provide a link to a minimal reproduction of the bug

https://github.com/CMadden8/cypress-angular-test

Please provide the exception or error you saw
Module build failed (from ./node_modules/@ngtools/webpack/src/ivy/index.js):

Error: C:\[omitted path]\cypress\component\app.ts is missing from the TypeScript compilation. Please make sure it is in your tsconfig via the 'files' or 'include' property.
Please provide the environment you discovered this bug in (run ng version)
Angular CLI: 15.2.2
Node: 16.14.2
Package Manager: npm 8.5.0
OS: win32 x64

Angular: 15.2.2
... animations, cli, common, compiler, compiler-cli, core, forms
... platform-browser, platform-browser-dynamic, router

Package                         Version
---------------------------------------------------------
@angular-devkit/architect       0.1502.2
@angular-devkit/build-angular   15.2.2
@angular-devkit/core            15.2.2
@angular-devkit/schematics      15.2.2
@schematics/angular             15.2.2
rxjs                            7.8.0
typescript                      4.9.5
Anything else?

@badeball/cypress-cucumber-preprocessor and ts-loader were installed alongside cypress, and configured for component testing within cypress.config.ts

Dominant language
TypeScript
Stars
27k
Forks
11.8k
Avg merge
16h 35m
Merged PRs (30d)
176

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from angular/angular-cli

All issues in angular/angular-cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.