Skip to content

Commit

Permalink
fix(compiler)(**BREAKING**): allow using files provided by `tsconfi…
Browse files Browse the repository at this point in the history
…g` (#1562)

BREAKING CHANGE:

Any custom typing files or files which are needed to be compiled and intended to use with `jest` need to be defined in `files` option of `tsconfig`.

For example
```
// tsconfig.json
{
   // ...other configs
   "files": [
       "my-custom-typings.d.ts".
       "my-global-module.ts"
   ]
}
```
  • Loading branch information
ahnpnl committed May 1, 2020
1 parent e93b4ca commit 23d818c
Show file tree
Hide file tree
Showing 14 changed files with 3,780 additions and 20 deletions.
115 changes: 115 additions & 0 deletions e2e/__external-repos__/custom-typings/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2

.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.pnp.*
9 changes: 9 additions & 0 deletions e2e/__external-repos__/custom-typings/__tests__/index.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import $ from "jquery"

function foo() {
$.ajax<number>("/foo")
}

test("foo", () => {
expect(2).toBe(2)
})
4 changes: 4 additions & 0 deletions e2e/__external-repos__/custom-typings/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
preset: 'ts-jest',
testEnvironment: 'node',
}
7 changes: 7 additions & 0 deletions e2e/__external-repos__/custom-typings/jquery.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
declare global {
interface JQueryStatic {
ajax<T>(url: string, settings?: JQuery.AjaxSettings): JQuery.jqXHR<T>
}
}

export {}
16 changes: 16 additions & 0 deletions e2e/__external-repos__/custom-typings/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"name": "custom-typings",
"private": true,
"scripts": {
"test": "jest"
},
"dependencies": {
"jquery": "^3.5.0"
},
"devDependencies": {
"@types/jest": "^25.2.1",
"@types/jquery": "^3.3.35",
"jest": "^25.4.0",
"typescript": "^3.8.3"
}
}
10 changes: 10 additions & 0 deletions e2e/__external-repos__/custom-typings/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"esModuleInterop": true
},
"files": [
"jquery.d.ts"
]
}
Loading

0 comments on commit 23d818c

Please sign in to comment.