7 |
9 | )
10 | }
11 |
12 | // @filename: index.ts
13 | import { Hello } from "./Component"
14 | console.log(Hello)
15 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/multiFileErrors.ts:
--------------------------------------------------------------------------------
1 | // @filename: sum.ts
2 | export function sum(a: number, b: number): number {
3 | return a + b
4 | }
5 |
6 | // @filename: ok.ts
7 | import { sum } from "./sum"
8 | sum(1, 2)
9 |
10 | // @filename: error.ts
11 | // @errors: 2345
12 | import { sum } from "./sum"
13 | sum(4, "woops")
14 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/query.ts:
--------------------------------------------------------------------------------
1 | let foo = "hello there!";
2 | // ^?
3 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/showEmit.ts:
--------------------------------------------------------------------------------
1 | // @showEmit
2 | // @target: ES5
3 | // @downleveliteration
4 |
5 | // --importHelpers on: Spread helper will be imported from 'tslib'
6 |
7 | export function fn(arr: number[]) {
8 | const arr2 = [1, ...arr]
9 | }
10 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/tests/arbitraryCommands.ts:
--------------------------------------------------------------------------------
1 | // The testing infra has set up `annotate` to be a customTag
2 |
3 | // @annotate - left - You can use JSDoc comments to provide type information to your editor
4 | function compact(arr: string[]) {
5 | if (arr.length > 10) return arr.length
6 | // @annotate - right - You can use JSDoc comments to provide type information to your editor
7 | return arr
8 | }
9 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/tests/crossExports.ts:
--------------------------------------------------------------------------------
1 | // @filename: utilFunctions.js
2 | const getStringLength = str => str.length
3 | module.exports = {
4 | getStringLength,
5 | }
6 |
7 | // @filename: index.ts
8 | import utils from './utilFunctions'
9 | const count = utils.getStringLength('Check JS')
10 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/tests/cut_files.ts:
--------------------------------------------------------------------------------
1 | // Hello should not appear in the staticQuickInfos
2 | const hello = 'world'
3 | // ---cut---
4 | const bye = 'globe'
5 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/tests/emittedOutFile.ts:
--------------------------------------------------------------------------------
1 | // @filename: projectRoot/index.ts
2 | export * from "./nested/base"
3 |
4 | // @filename: projectRoot/nested/base.ts
5 | export const a = "123"
6 |
7 | // @module: amd
8 | // @outfile: index.js
9 | // @declaration: true
10 | // @showEmit
11 | // @showEmittedFile: index.d.ts
12 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/tests/handlesJSON.ts:
--------------------------------------------------------------------------------
1 | // @errors: 2367
2 | // @resolveJsonModule
3 | // @module: commonjs
4 | // @moduleResolution: node
5 | // @filename: settings.json
6 | {
7 | "repo": "TypeScript",
8 | "dry": false,
9 | "debug": false
10 | }
11 | // @filename: index.ts
12 | import settings from "./settings.json";
13 |
14 | settings.debug === true;
15 | settings.dry === 2;
16 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/tests/hidden_emit.ts:
--------------------------------------------------------------------------------
1 | // @showEmit
2 | // @removeComments: true
3 | /** The translation of 'Hello world' into Portuguese */
4 | export declare const helloWorldPTBR = 'Olá Mundo'
5 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/tests/inlineHighlights.ts:
--------------------------------------------------------------------------------
1 | type Result = "pass" | "fail"
2 | // ^^^^^^
3 |
4 | const hello = "OK"
5 | // ^^ Sure
6 |
--------------------------------------------------------------------------------
/packages/ts-twoslasher/test/fixtures/tests/jsx.ts:
--------------------------------------------------------------------------------
1 | // @filename: index.tsx
2 | // This doesn't work!
3 | declare module JSX {
4 | interface Element {}
5 | interface IntrinsicElements {
6 | [s: string]: any
7 | }
8 | }
9 | // @showEmit
10 | // @noErrors
11 | // @jsx: preserve
12 | export const helloWorld = () => Hello World
8 |Hello world
13 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/tests/lib.ts: -------------------------------------------------------------------------------- 1 | // @lib: es2015 2 | const map = new MapHello World
9 | } 10 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/tests/queriesWithSpaceBefore.ts: -------------------------------------------------------------------------------- 1 | const a: string = "242342" 2 | const b = "hello" 3 | if (a === b) { 4 | // ^? 5 | } 6 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/tests/queryHandlesNoToken.ts: -------------------------------------------------------------------------------- 1 | type Either2dOr3d = [number, number, number?] 2 | 3 | function setCoordinate(coord: Either2dOr3d) { 4 | const [x, y, z] = coord 5 | // ^? 6 | 7 | console.log(`Provided coordinates had ${coord.length} dimensions`) 8 | // ^? 9 | } 10 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/tests/removePrettierIgnore.ts: -------------------------------------------------------------------------------- 1 | const myThing = {} 2 | 3 | // prettier-ignore 4 | const anotherThing = {} 5 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/tests/showEmit.ts: -------------------------------------------------------------------------------- 1 | // @experimentalDecorators 2 | // @showEmit 3 | // @showEmittedFile: component.js 4 | 5 | // @filename: service.ts 6 | export class Service {} 7 | 8 | // @filename: component.ts 9 | import type { Service } from "./service" 10 | 11 | declare var decorator: any 12 | 13 | @decorator 14 | class MyComponent { 15 | constructor(public Service: Service) {} 16 | 17 | @decorator 18 | method(x: this) {} 19 | } 20 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/tests/showJS.ts: -------------------------------------------------------------------------------- 1 | // @showEmit 2 | // @removeComments: true 3 | /** The translation of 'Hello world' into Portuguese */ 4 | export const helloWorldPTBR = 'Olá Mundo' 5 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/tests/tsx.ts: -------------------------------------------------------------------------------- 1 | // @filename: index.tsx 2 | // This doesn't work! 3 | declare module JSX { 4 | interface Element {} 5 | interface IntrinsicElements { 6 | [s: string]: any 7 | } 8 | } 9 | // @showEmit 10 | // @noErrors 11 | // @jsx: preserve 12 | export const helloWorld = () =>Hello world
13 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/tests/twoliner.ts: -------------------------------------------------------------------------------- 1 | // @filename: getStringLength.ts 2 | export const getStringLength = (str: string) => str.length 3 | // @filename: index.ts 4 | import { getStringLength } from './getStringLength' 5 | const b = getStringLength('string') 6 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/throws/multifile_errors.ts: -------------------------------------------------------------------------------- 1 | // @filename: file-one.ts 2 | consol...log 3 | 4 | // @filename: other export.ts 5 | consol...err 6 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/throws/unexpected_errors.ts: -------------------------------------------------------------------------------- 1 | // @target: ES2015 2 | 3 | // Because this example doesn't have an errors 4 | // reference it will throw 5 | 6 | const myVariable = "" 7 | myVariable = 1 8 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/throws/unknown_compiler_error.ts: -------------------------------------------------------------------------------- 1 | // @targets: ES2015 2 | 3 | // Because this example refers to something 4 | // which is neither in the settings, nor 5 | // a compiler flag. The render process will 6 | // throw an error 7 | 8 | export const variable = "NOT OK" 9 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/throws/unknown_compiler_value.ts: -------------------------------------------------------------------------------- 1 | // @target: TS2015 2 | 3 | // Because this example refers to TS2015 4 | // not ES2015 the function with throw 5 | 6 | export const variable = "NOT OK" 7 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/fixtures/throws/unknown_extension.herjk: -------------------------------------------------------------------------------- 1 | // Should throw 2 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/highlights.test.ts: -------------------------------------------------------------------------------- 1 | import { twoslasher } from "../src/index" 2 | 3 | it("supports highlighting something", () => { 4 | const file = ` 5 | const a = "123" 6 | // ^^^^^^^^^ 7 | const b = "345" 8 | ` 9 | const result = twoslasher(file, "ts") 10 | expect(result.highlights.length).toEqual(1) 11 | }) 12 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/modules.test.ts: -------------------------------------------------------------------------------- 1 | import { twoslasher } from "../src/index" 2 | import { createDefaultMapFromNodeModules } from "@typescript/vfs" 3 | 4 | const dt = ` 5 | declare namespace G { 6 | function hasMagic(pattern: string, options?: IOptions): boolean; 7 | } 8 | export = G; 9 | ` 10 | 11 | it("works with a dependency in @types for the project", () => { 12 | const fsMap = createDefaultMapFromNodeModules({}) 13 | fsMap.set("/node_modules/@types/glob/index.d.ts", dt) 14 | 15 | const file = ` 16 | import glob from "glob" 17 | glob.hasMagic("OK") 18 | // ^? 19 | ` 20 | const result = twoslasher(file, "ts", { fsMap }) 21 | expect(result.errors).toEqual([]) 22 | expect(result.queries[0].text!.includes("hasMagic")).toBeTruthy() 23 | }) 24 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/declarations.json: -------------------------------------------------------------------------------- 1 | { 2 | "code": "/**\n * Gets the length of a string\n * @param value a string\n */\nexport declare function getStringLength(value: string): number;\n", 3 | "extension": "ts", 4 | "highlights": [], 5 | "queries": [], 6 | "staticQuickInfos": [], 7 | "errors": [], 8 | "playgroundURL": "https://www.typescriptlang.org/play/#code/PTAEAEBMFMGMBsCGAnRAXAlgewHYC5Q1kBXaAKBAgGcALLAdwFEBbDNCscWhlttaSADEM8aAQw4YADwB0kGWipkKAKhVlQK0AHFoiwjWihROAOZoaoLADNQiUFSITTGreAAOKRM1AA3RPCkdg5OZq7AZNBS7ljIaKDWxDiwmLigpnoAyqGmADLQZhYAFP6BYiHIzgCUoADeGqDIesTIOH4BpDIm5jRkAL5kQA", 9 | "tags": [] 10 | } 11 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/multifile_errors.json: -------------------------------------------------------------------------------- 1 | 2 | ## Errors were thrown in the sample, but not included in an errors tag 3 | 4 | These errors were not marked as being expected: 2552 2304 1434 1128. 5 | Expected: // @errors: 2552 2304 1434 1128 6 | 7 | Compiler Errors: 8 | 9 | file-one.ts 10 | [2552] 0 - Cannot find name 'consol'. Did you mean 'console'? 11 | [2304] 9 - Cannot find name 'log'. 12 | [1434] 0 - Unexpected keyword or identifier. 13 | [1128] 6 - Declaration or statement expected. 14 | 15 | other export.ts 16 | [2552] 0 - Cannot find name 'consol'. Did you mean 'console'? 17 | [2304] 9 - Cannot find name 'err'. 18 | [1434] 0 - Unexpected keyword or identifier. 19 | [1128] 6 - Declaration or statement expected. -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/query.json: -------------------------------------------------------------------------------- 1 | { 2 | "code": "let foo = \"hello there!\";\n", 3 | "extension": "ts", 4 | "highlights": [], 5 | "queries": [ 6 | { 7 | "docs": "", 8 | "kind": "query", 9 | "start": 4, 10 | "length": 15, 11 | "text": "let foo: string", 12 | "offset": 4, 13 | "line": 1 14 | } 15 | ], 16 | "staticQuickInfos": [ 17 | { 18 | "text": "let foo: string", 19 | "docs": "", 20 | "start": 4, 21 | "length": 3, 22 | "line": 0, 23 | "character": 4, 24 | "targetString": "foo" 25 | } 26 | ], 27 | "errors": [], 28 | "playgroundURL": "https://www.typescriptlang.org/play/#code/DYUwLgBAZg9jEF4ICIAWJjHmdAnEAhMgNwBQA9ORBAHoD8pQA", 29 | "tags": [] 30 | } 31 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/tests/cut_files.json: -------------------------------------------------------------------------------- 1 | { 2 | "code": "const bye = 'globe'\n", 3 | "extension": "ts", 4 | "highlights": [], 5 | "queries": [], 6 | "staticQuickInfos": [ 7 | { 8 | "text": "const bye: \"globe\"", 9 | "docs": "", 10 | "start": 6, 11 | "length": 3, 12 | "line": 0, 13 | "character": 6, 14 | "targetString": "bye" 15 | } 16 | ], 17 | "errors": [], 18 | "playgroundURL": "https://www.typescriptlang.org/play/#code/PTAEAkFMBtoe1AZwBZwK7QCagHZwC6gCGADiZEQE6gCWOo+ykS+R+NAxgIpqcDWASRwAzOIgBQHODkSEmsBAF5QAcgDucSlhXiQoALSGOafIf2Tps0ACMAns2UqA5vGuQdQA", 19 | "tags": [] 20 | } 21 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/tests/emittedOutFile.json: -------------------------------------------------------------------------------- 1 | { 2 | "code": "declare module \"nested/base\" {\n export const a = \"123\";\n}\ndeclare module \"index\" {\n export * from \"nested/base\";\n}\n", 3 | "extension": "ts", 4 | "highlights": [], 5 | "queries": [], 6 | "staticQuickInfos": [], 7 | "errors": [], 8 | "playgroundURL": "https://www.typescriptlang.org/play/#code/PTAEAEDMEsBsFMB2BDAtvAXKADgJwPYBW8AxgC4BK++Zw0iAJvAB4B0ZAzgFAvb65lQAKlCQCqUACJWwRPA5l4DYACNkHeJK5cQEGAhToseIqUrVachUtXr47br36CS+RAtDJQAXikBGACYAZi0dMHBUfAYAVwQsNAYwiHxosn1MUHomNkJuXXAmElhkXGQyaDcsMlxo+CTwDgALfAB3AFFUaDJ6ptaOrsUGADE4DKyWVgYHLiA", 9 | "tags": [] 10 | } 11 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/tests/hidden_emit.json: -------------------------------------------------------------------------------- 1 | { 2 | "code": "export {};\n", 3 | "extension": "js", 4 | "highlights": [], 5 | "queries": [], 6 | "staticQuickInfos": [], 7 | "errors": [], 8 | "playgroundURL": "https://www.typescriptlang.org/play/#code/PTAEAEGcAsHsHcCiBbAlgFwFAggJwKbKwBu+AwrMsvgHbqQBco6uArvtgFSegAq0+ZrgCGNSABth6VLBqhYAM1AByABL5x42KHixc4gCbLQqOtoAKe9KwDm7SIM7BM+AB4AHK6AP4AxpIJQX1lIdFABTVgAdT1Dc14AIQAlUABeFQB5cQBD0ABZVhoDWGVMIA", 9 | "tags": [] 10 | } 11 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/tests/jsx.json: -------------------------------------------------------------------------------- 1 | { 2 | "code": "export const helloWorld = () =>Hello world
;\n", 3 | "extension": "jsx", 4 | "highlights": [], 5 | "queries": [], 6 | "staticQuickInfos": [], 7 | "errors": [], 8 | "playgroundURL": "https://www.typescriptlang.org/play/#code/PTAEAEDMEsBsFMB2BDAtvAXKaiAm8APAOgBcBnAgKBFABUALaM0XAe3jMQHITQB3VgCcA1gEJK+AMaxkg+KFStcAVwSgAUgGUAGqADelUNkQl4gyMknyAognQn9AX0PHT5y-ICSJwTjLRJW3h7cn0XIwBtMiwyEl9EAHMAXSxkRABPF2dnGnAyelY+a1RoEmowcERWa0FBITJyiAArCiwABzkyMwA3eEpCNqFeSVZEWNB6eFhYVgB1IVhcUABeUAAKAEoVgD5QAB56AEZtgAkpmf4F3D3gI+3KIA", 9 | "tags": [] 10 | } 11 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/tests/removePrettierIgnore.json: -------------------------------------------------------------------------------- 1 | { 2 | "code": "const myThing = {}\n\nconst anotherThing = {}\n", 3 | "extension": "ts", 4 | "highlights": [], 5 | "queries": [], 6 | "staticQuickInfos": [ 7 | { 8 | "text": "const myThing: {}", 9 | "docs": "", 10 | "start": 6, 11 | "length": 7, 12 | "line": 0, 13 | "character": 6, 14 | "targetString": "myThing" 15 | }, 16 | { 17 | "text": "const anotherThing: {}", 18 | "docs": "", 19 | "start": 26, 20 | "length": 12, 21 | "line": 2, 22 | "character": 6, 23 | "targetString": "anotherThing" 24 | } 25 | ], 26 | "errors": [], 27 | "playgroundURL": "https://www.typescriptlang.org/play/#code/MYewdgzgLgBAtgTwCoAsCWYDmMC8MDeAvgFDED0ZMADgE4CmUUadNAtGpmCPcaJLAEMuUFC1QZseIsSA", 28 | "tags": [] 29 | } 30 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/tests/showJS.json: -------------------------------------------------------------------------------- 1 | { 2 | "code": "export const helloWorldPTBR = 'Olá Mundo';\n", 3 | "extension": "js", 4 | "highlights": [], 5 | "queries": [], 6 | "staticQuickInfos": [], 7 | "errors": [], 8 | "playgroundURL": "https://www.typescriptlang.org/play/#code/PTAEAEGcAsHsHcCiBbAlgFwFAggJwKbKwBu+AwrMsvgHbqQBco6uArvtgFSegAq0+ZrgCGNSABth6VLBqhYAM1AByABL5x42KHixc4gCbLQqOtoAKe9KwDm7SIM7BM+AB4AHK6ADGsyOlABTVgAdT1Dc14AIQAlUABeFQB5cQBD0ABZVhoDWGVMIA", 9 | "tags": [] 10 | } 11 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/tests/tsx.json: -------------------------------------------------------------------------------- 1 | { 2 | "code": "export const helloWorld = () =>Hello world
;\n", 3 | "extension": "jsx", 4 | "highlights": [], 5 | "queries": [], 6 | "staticQuickInfos": [], 7 | "errors": [], 8 | "playgroundURL": "https://www.typescriptlang.org/play/#code/PTAEAEDMEsBsFMB2BDAtvAXKaiAm8APAOgBcBnAgKBFABUALaM0XAe3jMQHITQB3VgCcA1gEJK+AMaxkg+KFStcAVwSgAUgGUAGqADelUNkQl4gyMknyAognQn9AX0PHT5y-ICSJwTjLRJW3h7cn0XIwBtMiwyEl9EAHMAXSxkRABPF2dnGnAyelY+a1RoEmowcERWa0FBITJyiAArCiwABzkyMwA3eEpCNqFeSVZEWNB6eFhYVgB1IVhcUABeUAAKAEoVgD5QAB56AEZtgAkpmf4F3D3gI+3KIA", 9 | "tags": [] 10 | } 11 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/unexpected_errors.json: -------------------------------------------------------------------------------- 1 | 2 | ## Errors were thrown in the sample, but not included in an errors tag 3 | 4 | These errors were not marked as being expected: 2588. 5 | Expected: // @errors: 2588 6 | 7 | Compiler Errors: 8 | 9 | index.ts 10 | [2588] 98 - Cannot assign to 'myVariable' because it is a constant. -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/unknown_compiler_error.json: -------------------------------------------------------------------------------- 1 | 2 | ## Invalid inline compiler flag 3 | 4 | There isn't a TypeScript compiler flag called 'targets'. 5 | 6 | This is likely a typo, you can check all the compiler flags in the TSConfig reference, or check the additional Twoslash flags in the npm page for @typescript/twoslash. -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/unknown_compiler_value.json: -------------------------------------------------------------------------------- 1 | 2 | ## Invalid inline compiler value 3 | 4 | Got TS2015 for target but it is not a supported value by the TS compiler. 5 | 6 | Allowed values: es3,es5,es6,es2015,es2016,es2017,es2018,es2019,es2020,es2021,es2022,es2023,es2024,esnext -------------------------------------------------------------------------------- /packages/ts-twoslasher/test/results/unknown_extension.json: -------------------------------------------------------------------------------- 1 | 2 | ## Unknown TypeScript extension given to Twoslash 3 | 4 | Received herjk but Twoslash only accepts: js,javascript,ts,typescript,tsx,jsx,json,jsn 5 | -------------------------------------------------------------------------------- /packages/ts-twoslasher/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "include": ["src", "types", "test"], 3 | "exclude": ["test/fixtures"], 4 | "compilerOptions": { 5 | "target": "es5", 6 | "module": "esnext", 7 | "lib": ["dom", "esnext"], 8 | "importHelpers": true, 9 | "declaration": true, 10 | "sourceMap": true, 11 | "rootDir": "./src", 12 | "strict": true, 13 | "noImplicitAny": true, 14 | "strictNullChecks": true, 15 | "strictFunctionTypes": true, 16 | "strictPropertyInitialization": true, 17 | "noImplicitThis": true, 18 | "alwaysStrict": true, 19 | "noUnusedLocals": true, 20 | "noUnusedParameters": true, 21 | "noImplicitReturns": true, 22 | "noFallthroughCasesInSwitch": true, 23 | "moduleResolution": "node", 24 | "baseUrl": "./src", 25 | "paths": { 26 | "*": ["src/*", "node_modules/*"] 27 | }, 28 | "jsx": "react", 29 | "esModuleInterop": true 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Handled by @oss-docs/sync 3 | copy/* 4 | !copy/en 5 | **/*.js -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Additional_Checks_6176.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Linter Checks" 3 | --- 4 | 5 | A collection of extra checks, which somewhat cross the boundaries of compiler vs linter. You may prefer to use a tool like eslint over these options if you are looking for more in-depth rules. 6 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Advanced_Options_6178.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Advanced" 3 | --- 4 | 5 | Flags which help with debugging 6 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Backwards_Compatibility_6253.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Backwards Compatibility" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Basic_Options_6172.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Project Options" 3 | --- 4 | 5 | These settings are used to define the runtime expectations of your project, how and where you want the JavaScript to be emitted and the level of integration you want with existing JavaScript code. 6 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Command_line_Options_6171.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Command Line" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Compiler_Diagnostics_6251.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Compiler Diagnostics" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Completeness_6257.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Completeness" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Editor_Support_6249.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Editor Support" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Emit_6246.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Emit" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Experimental_Options_6177.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Experimental" 3 | --- 4 | 5 | TypeScript strives to only include features which are confirmed to be added into the JavaScript language. 6 | 7 | There have been cases where a feature is compelling enough to be an exception to that rule, and these live as experimental compiler flags. 8 | It is possible that a version of these features may be different when/if they are added to the JavaScript language, and thus are considered risky. 9 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Interop_Constraints_6252.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Interop Constraints" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/JavaScript_Support_6247.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "JavaScript Support" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Language_and_Environment_6254.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Language and Environment" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Module_Resolution_Options_6174.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Module Resolution" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Modules_6244.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Modules" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Output_Formatting_6256.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Output Formatting" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Project_Files_0.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "File Inclusion" 3 | --- 4 | 5 | These settings help you ensure that TypeScript picks up the right files. 6 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Projects_6255.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Projects" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Source_Map_Options_6175.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Source Maps" 3 | --- 4 | 5 | In order to provide rich debugging tools and crash reports which make sense to developers, TypeScript supports 6 | emitting additional files which conform to the JavaScript Source Map standards. 7 | 8 | These are emitted as `.map` files which live alongside the file they represent. 9 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Strict_Type_Checking_Options_6173.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Strict Checks" 3 | --- 4 | 5 | We recommend using the [compiler option `strict`](#strict) to opt-in to every possible improvement as they are built. 6 | 7 | TypeScript supports a wide spectrum of JavaScript patterns and defaults to allowing for quite a lot of flexibility in accommodating these styles. 8 | Often the safety and potential scalability of a codebase can be at odds with some of these techniques. 9 | 10 | Because of the variety of supported JavaScript, upgrading to a new version of TypeScript can uncover two types of errors: 11 | 12 | - Errors which already exist in your codebase, which TypeScript has uncovered because the language has refined its understanding of JavaScript. 13 | - A new suite of errors which tackle a new problem domain. 14 | 15 | TypeScript will usually add a compiler flag for the latter set of errors, and by default these are not enabled. 16 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Type_Checking_6248.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Type Checking" 3 | --- 4 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/categories/Watch_and_Build_Modes_6250.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Watch Options" 3 | --- 4 | 5 | TypeScript 3.8 shipped a new strategy for watching directories, which is crucial for efficiently picking up changes to `node_modules`. 6 | 7 | On operating systems like Linux, TypeScript installs directory watchers (as opposed to file watchers) on `node_modules` and many of its subdirectories to detect changes in dependencies. 8 | This is because the number of available file watchers is often eclipsed by the number of files in `node_modules`, whereas there are way fewer directories to track. 9 | 10 | Because every project might work better under different strategies, and this new approach might not work well for your workflows, TypeScript 3.8 introduces a new `watchOptions` field which allows users to tell the compiler/language service which watching strategies should be used to keep track of files and directories. 11 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/cli/help.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Help" 3 | oneline: "Gives local information for help on the CLI." 4 | --- 5 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/allowImportingTsExtensions.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Allow Importing TS Extensions" 3 | oneline: "Allow imports to include TypeScript file extensions." 4 | --- 5 | 6 | `--allowImportingTsExtensions` allows TypeScript files to import each other with a TypeScript-specific extension like `.ts`, `.mts`, or `.tsx`. 7 | 8 | This flag is only allowed when `--noEmit` or `--emitDeclarationOnly` is enabled, since these import paths would not be resolvable at runtime in JavaScript output files. 9 | The expectation here is that your resolver (e.g. your bundler, a runtime, or some other tool) is going to make these imports between `.ts` files work. 10 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/allowUmdGlobalAccess.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Allow Umd Global Access" 3 | oneline: "Allow accessing UMD globals from modules." 4 | --- 5 | 6 | When set to true, `allowUmdGlobalAccess` lets you access UMD exports as globals from inside module files. A module file is a file that has imports and/or exports. Without this flag, using an export from a UMD module requires an import declaration. 7 | 8 | An example use case for this flag would be a web project where you know the particular library (like jQuery or Lodash) will always be available at runtime, but you can’t access it with an import. 9 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/allowUnusedLabels.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Allow Unused Labels" 3 | oneline: "Disable error reporting for unused labels." 4 | --- 5 | 6 | When: 7 | 8 | - `undefined` (default) provide suggestions as warnings to editors 9 | - `true` unused labels are ignored 10 | - `false` raises compiler errors about unused labels 11 | 12 | Labels are very rare in JavaScript and typically indicate an attempt to write an object literal: 13 | 14 | ```ts twoslash 15 | // @errors: 7028 16 | // @allowUnusedLabels: false 17 | function verifyAge(age: number) { 18 | // Forgot 'return' statement 19 | if (age > 18) { 20 | verified: true; 21 | } 22 | } 23 | ``` 24 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/alwaysStrict.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Always Strict" 3 | oneline: "Ensure 'use strict' is always emitted." 4 | --- 5 | 6 | Ensures that your files are parsed in the ECMAScript strict mode, and emit "use strict" for each source file. 7 | 8 | [ECMAScript strict](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Strict_mode) mode was introduced in ES5 and provides behavior tweaks to the runtime of the JavaScript engine to improve performance, and makes a set of errors throw instead of silently ignoring them. 9 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/assumeChangesOnlyAffectDirectDependencies.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Assume Changes Only Affect Direct Dependencies" 3 | oneline: "Have recompiles in projects that use [`incremental`](#incremental) and `watch` mode assume that changes within a file will only affect files directly depending on it." 4 | --- 5 | 6 | When this option is enabled, TypeScript will avoid rechecking/rebuilding all truly possibly-affected files, and only recheck/rebuild files that have changed as well as files that directly import them. 7 | 8 | This can be considered a 'fast & loose' implementation of the watching algorithm, which can drastically reduce incremental rebuild times at the expense of having to run the full build occasionally to get all compiler error messages. 9 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/baseUrl.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Base URL" 3 | oneline: "Specify the base directory to resolve bare specifier module names." 4 | --- 5 | 6 | Sets a base directory from which to resolve bare specifier module names. For example, in the directory structure: 7 | 8 | ``` 9 | project 10 | ├── ex.ts 11 | ├── hello 12 | │ └── world.ts 13 | └── tsconfig.json 14 | ``` 15 | 16 | With `"baseUrl": "./"`, TypeScript will look for files starting at the same folder as the `tsconfig.json`: 17 | 18 | ```ts 19 | import { helloWorld } from "hello/world"; 20 | 21 | console.log(helloWorld); 22 | ``` 23 | 24 | This resolution has higher priority than lookups from `node_modules`. 25 | 26 | This feature was designed for use in conjunction with AMD module loaders in the browser, and is not recommended in any other context. As of TypeScript 4.1, `baseUrl` is no longer required to be set when using [`paths`](#paths). -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/charset.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Charset" 3 | oneline: "No longer supported. In early versions, manually set the text encoding for reading files." 4 | --- 5 | 6 | In prior versions of TypeScript, this controlled what encoding was used when reading text files from disk. 7 | Today, TypeScript assumes UTF-8 encoding, but will correctly detect UTF-16 (BE and LE) or UTF-8 BOMs. 8 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/clean.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Clean" 3 | oneline: "Delete the outputs of all projects." 4 | --- 5 | 6 | Delete the outputs of all projects 7 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/composite.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Composite" 3 | oneline: "Enable constraints that allow a TypeScript project to be used with project references." 4 | --- 5 | 6 | The `composite` option enforces certain constraints which make it possible for build tools (including TypeScript 7 | itself, under `--build` mode) to quickly determine if a project has been built yet. 8 | 9 | When this setting is on: 10 | 11 | - The [`rootDir`](#rootDir) setting, if not explicitly set, defaults to the directory containing the `tsconfig.json` file. 12 | 13 | - All implementation files must be matched by an [`include`](#include) pattern or listed in the [`files`](#files) array. If this constraint is violated, `tsc` will inform you which files weren't specified. 14 | 15 | - [`declaration`](#declaration) defaults to `true` 16 | 17 | You can find documentation on TypeScript projects in [the handbook](https://www.typescriptlang.org/docs/handbook/project-references.html). 18 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/declarationDir.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Declaration Dir" 3 | oneline: "Specify the output directory for generated declaration files." 4 | --- 5 | 6 | Offers a way to configure the root directory for where declaration files are emitted. 7 | 8 | ``` 9 | example 10 | ├── index.ts 11 | ├── package.json 12 | └── tsconfig.json 13 | ``` 14 | 15 | with this `tsconfig.json`: 16 | 17 | ```json tsconfig 18 | { 19 | "compilerOptions": { 20 | "declaration": true, 21 | "declarationDir": "./types" 22 | } 23 | } 24 | ``` 25 | 26 | Would place the d.ts for the `index.ts` in a `types` folder: 27 | 28 | ``` 29 | example 30 | ├── index.js 31 | ├── index.ts 32 | ├── package.json 33 | ├── tsconfig.json 34 | └── types 35 | └── index.d.ts 36 | ``` 37 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/declarationMap.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Declaration Map" 3 | oneline: "Create sourcemaps for d.ts files." 4 | --- 5 | 6 | Generates a source map for `.d.ts` files which map back to the original `.ts` source file. 7 | This will allow editors such as VS Code to go to the original `.ts` file when using features like _Go to Definition_. 8 | 9 | You should strongly consider turning this on if you're using project references. 10 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/diagnostics.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Diagnostics" 3 | oneline: "Output compiler performance information after building." 4 | --- 5 | 6 | Used to output diagnostic information for debugging. This command is a subset of [`extendedDiagnostics`](#extendedDiagnostics) which are more user-facing results, and easier to interpret. 7 | 8 | If you have been asked by a TypeScript compiler engineer to give the results using this flag in a compile, in which there is no harm in using [`extendedDiagnostics`](#extendedDiagnostics) instead. 9 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/disableFilenameBasedTypeAcquisition.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Disable Filename Based Type Acquisition" 3 | oneline: "Disables inference for type acquisition by looking at filenames in a project." 4 | --- 5 | 6 | TypeScript's type acquisition can infer what types should be added based on filenames in a project. This means that having a file like `jquery.js` in your project would automatically download the types for JQuery from DefinitelyTyped. 7 | 8 | You can disable this via `disableFilenameBasedTypeAcquisition`. 9 | 10 | ```json 11 | { 12 | "typeAcquisition": { 13 | "disableFilenameBasedTypeAcquisition": true 14 | } 15 | } 16 | ``` 17 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/disableReferencedProjectLoad.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Disable Referenced Project Load" 3 | oneline: "Reduce the number of projects loaded automatically by TypeScript." 4 | --- 5 | 6 | In multi-project TypeScript programs, TypeScript will load all of the available projects into memory in order to provide accurate results for editor responses which require a full knowledge graph like 'Find All References'. 7 | 8 | If your project is large, you can use the flag `disableReferencedProjectLoad` to disable the automatic loading of all projects. Instead, projects are loaded dynamically as you open files through your editor. 9 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/disableSizeLimit.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Disable Size Limit" 3 | oneline: "Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server." 4 | --- 5 | 6 | To avoid a possible memory bloat issues when working with very large JavaScript projects, there is an upper limit to the amount of memory TypeScript will allocate. Turning this flag on will remove the limit. 7 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/disableSolutionSearching.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Disable Solution Searching" 3 | oneline: "Opt a project out of multi-project reference checking when editing." 4 | --- 5 | 6 | When working with [composite TypeScript projects](/docs/handbook/project-references.html), this option provides a way to declare that you do not want a project to be included when using features like _find all references_ or _jump to definition_ in an editor. 7 | 8 | This flag is something you can use to increase responsiveness in large composite projects. 9 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/disableSourceOfProjectReferenceRedirect.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Disable Source Project Reference Redirect" 3 | oneline: "Disable preferring source files instead of declaration files when referencing composite projects." 4 | --- 5 | 6 | When working with [composite TypeScript projects](/docs/handbook/project-references.html), this option provides a way to go [back to the pre-3.7](/docs/handbook/release-notes/typescript-3-7.html#build-free-editing-with-project-references) behavior where d.ts files were used to as the boundaries between modules. 7 | In 3.7 the source of truth is now your TypeScript files. 8 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/emitBOM.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Emit BOM" 3 | oneline: "Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files." 4 | --- 5 | 6 | Controls whether TypeScript will emit a [byte order mark (BOM)](https://wikipedia.org/wiki/Byte_order_mark) when writing output files. 7 | Some runtime environments require a BOM to correctly interpret a JavaScript files; others require that it is not present. 8 | The default value of `false` is generally best unless you have a reason to change it. 9 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/emitDeclarationOnly.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Emit Declaration Only" 3 | oneline: "Only output d.ts files and not JavaScript files." 4 | --- 5 | 6 | _Only_ emit `.d.ts` files; do not emit `.js` files. 7 | 8 | This setting is useful in two cases: 9 | 10 | - You are using a transpiler other than TypeScript to generate your JavaScript. 11 | - You are using TypeScript to only generate `d.ts` files for your consumers. 12 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/enable.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Enable" 3 | oneline: "Disable the type acquisition for JavaScript projects." 4 | --- 5 | 6 | Disables automatic type acquisition in JavaScript projects: 7 | 8 | ```json 9 | { 10 | "typeAcquisition": { 11 | "enable": false 12 | } 13 | } 14 | ``` 15 | -------------------------------------------------------------------------------- /packages/tsconfig-reference/copy/en/options/exclude.md: -------------------------------------------------------------------------------- 1 | --- 2 | display: "Exclude" 3 | oneline: "Filters results from the [`include`](#include) option." 4 | --- 5 | 6 | Specifies an array of filenames or patterns that should be skipped when resolving [`include`](#include). 7 | 8 | **Important**: `exclude` _only_ changes which files are included as a result of the [`include`](#include) setting. 9 | A file specified by `exclude` can still become part of your codebase due to an `import` statement in your code, a `types` inclusion, a `///
14 | {props.buttons.map(b =>
15 |
18 | )
19 |
--------------------------------------------------------------------------------
/packages/typescriptlang-org/src/components/display/GreyButton.tsx:
--------------------------------------------------------------------------------
1 | import * as React from "react"
2 | import { withPrefix } from "gatsby"
3 |
4 | export type Props = {
5 | href: string
6 | blurb: string
7 | title: string
8 | headline?: true
9 | badge?: string
10 | first?: boolean
11 | last?: boolean
12 | customClass?: string
13 | }
14 |
15 | /** A pretty grey button */
16 | export const GreyButton = (props: Props) => {
17 | const href = props.href.startsWith("http")
18 | ? props.href
19 | : withPrefix(props.href)
20 | const classes = ["clicky-grey-button"]
21 |
22 | if (props.headline) classes.push("headline")
23 | if (props.first) classes.push("first")
24 | if (props.last) classes.push("last")
25 | if (props.customClass) classes.push(props.customClass)
26 |
27 | return (
28 |
29 | {props.blurb}
30 |{props.title}
31 |
32 | )
33 | }
34 |
--------------------------------------------------------------------------------
/packages/typescriptlang-org/src/components/index/twoslash/Index2Del1TS.ts:
--------------------------------------------------------------------------------
1 | // twoslash: { themes: ["../../../packages/typescriptlang-org/lib/themes/typescript-beta-light"] }
2 | // @noErrors
3 | type Result = "pass" | "fail"
4 |
5 | function verify(result: Result) {
6 | if (result === "pass") {
7 | console.log("Passed")
8 | } else {
9 | console.log("Failed")
10 | }
11 | }
12 |
--------------------------------------------------------------------------------
/packages/typescriptlang-org/src/components/index/twoslash/Index2Del2RM.ts:
--------------------------------------------------------------------------------
1 | // twoslash: { themes: ["../../../packages/typescriptlang-org/lib/themes/typescript-beta-light"] }
2 | // codefence: {1,3}
3 | type Result = "pass" | "fail"
4 |
5 | function verify(result: Result) {
6 | // ^^^^^^^^
7 | if (result === "pass") {
8 | console.log("Passed")
9 | } else {
10 | console.log("Failed")
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/packages/typescriptlang-org/src/components/index/twoslash/Index2Del3JS.js:
--------------------------------------------------------------------------------
1 | // twoslash: { themes: ["../../../packages/typescriptlang-org/lib/themes/typescript-beta-light"], noStaticSemanticInfo: true }
2 |
3 |
4 |
5 | function verify(result) {
6 | if (result === "pass") {
7 | console.log("Passed")
8 | } else {
9 | console.log("Failed")
10 | }
11 | }
12 |
--------------------------------------------------------------------------------
/packages/typescriptlang-org/src/components/index/twoslash/IndexAdoptGrad1.ts:
--------------------------------------------------------------------------------
1 | interface Account {
2 | id: number
3 | displayName: string
4 | version: 1
5 | }
6 |
7 | function welcome(user: Account) {
8 | console.log(user.id)
9 | }
--------------------------------------------------------------------------------
/packages/typescriptlang-org/src/components/index/twoslash/IndexAdoptGrad2.ts:
--------------------------------------------------------------------------------
1 | type Result = "pass" | "fail"
2 |
3 | function verify(result: Result) {
4 | if (result === "pass") {
5 | console.log("Passed")
6 | } else {
7 | console.log("Failed")
8 | }
9 | }
--------------------------------------------------------------------------------
/packages/typescriptlang-org/src/components/index/twoslash/IndexGetStarted1.js:
--------------------------------------------------------------------------------
1 | // @annotate: left { "arrowRot": "40deg 5px -2px", "textDegree": "3deg", "top": "0.8rem" } - No editor warnings in JavaScript filesThis code crashes at runtime! 2 | function compact(arr) { 3 | if (orr.length > 10) 4 | return arr.trim(0, 10) 5 | return arr 6 | } -------------------------------------------------------------------------------- /packages/typescriptlang-org/src/components/index/twoslash/IndexGetStarted2.js: -------------------------------------------------------------------------------- 1 | // @errors: 2304 2 | // @noImplicitAny: false 3 | // @ts-check 4 | // @annotate: left { "arrowRot": "44deg 7px -11px", "textDegree": "-3deg", "top": "1.3rem" } - Adding this to a JS file shows errors in your editor 5 | 6 | function compact(arr) { 7 | // @annotate: right { "arrowRot": "-60deg 1px 2px", "textDegree": "3deg", "top": "5.7rem" } - Discovered a type - the param is arr, not orr! 8 | if (orr.length > 10) 9 | return arr.trim(0, 10) 10 | return arr 11 | } -------------------------------------------------------------------------------- /packages/typescriptlang-org/src/components/index/twoslash/IndexGetStarted3.js: -------------------------------------------------------------------------------- 1 | // @ts-check 2 | // @errors: 2339 3 | 4 | /** @param {any[]} arr */ 5 | // @annotate: left { "arrowRot": "44deg 4px -12px", "textDegree": "1deg" } - Using JSDoc to give type information 6 | function compact(arr) { 7 | if (arr.length > 10) 8 | return arr.trim(0, 10) 9 | // @annotate: right { "arrowRot": "-64deg 1px 2px", "textDegree": "3deg" } - Now TS has found a bad call. Arrays have slice, not trim. 10 | return arr 11 | } -------------------------------------------------------------------------------- /packages/typescriptlang-org/src/components/index/twoslash/IndexGetStarted4.ts: -------------------------------------------------------------------------------- 1 | // @annotate: left { "arrowRot": "40deg -5px -5px", "textDegree": "-4deg", "top": "0.9rem" } - TypeScript adds natural syntax for providing types 2 | function compact(arr: string[]) { 3 | if (arr.length > 10) 4 | return arr.slice(0, 10) 5 | return arr 6 | } -------------------------------------------------------------------------------- /packages/typescriptlang-org/src/components/index/twoslash/JSDoc.js: -------------------------------------------------------------------------------- 1 | // twoslash: { themes: ["min-dark", "../../../packages/typescriptlang-org/src/components/index/twoslash/homepage"] } 2 | // @errors: 2339 3 | // @ts-check 4 | 5 | /** @param {any[]} arr */ 6 | function compact(arr) { 7 | if (arr.length > 10) return arr.trim(0, 10) 8 | return arr 9 | } 10 | -------------------------------------------------------------------------------- /packages/typescriptlang-org/src/components/index/twoslash/TS.ts: -------------------------------------------------------------------------------- 1 | // twoslash: { themes: ["min-dark", "../../../packages/typescriptlang-org/src/components/index/twoslash/homepage"] } 2 | function compact(arr: string[]) { 3 | if (arr.length > 10) return arr.slice(0, 10) 4 | return arr 5 | } 6 | -------------------------------------------------------------------------------- /packages/typescriptlang-org/src/components/index/twoslash/cfa.ts: -------------------------------------------------------------------------------- 1 | // twoslash: { themes: ["min-dark", "../../../packages/typescriptlang-org/lib/themes/typescript-beta-dark"] } 2 | const users = [{ name: "Ahmed" }, { name: "Gemma" }, { name: "Jon" }] 3 | 4 | const jon = users.find(u => u.name === "jon") 5 | 6 | if (jon) { 7 | console.log(jon) 8 | } else { 9 | throw new Error('Could not find user "Jon"') 10 | } 11 | -------------------------------------------------------------------------------- /packages/typescriptlang-org/src/components/index/twoslash/interface.ts: -------------------------------------------------------------------------------- 1 | // twoslash: { themes: ["min-dark", "../../../packages/typescriptlang-org/src/components/index/twoslash/homepage"] } 2 | declare function getUser(id: number): User 3 | declare function saveUser(id: number, user: User): User 4 | // ---cut--- 5 | interface User { 6 | id: number 7 | firstName: string 8 | lastName: string 9 | role: string 10 | } 11 | 12 | function updateUser(id: number, update: Partial
12 |
14 | This page is intentionally left blank
13 |This is a blank file which is overwritten during a deploy
3 | 4 | --------------------------------------------------------------------------------