Skip to content

Suppress errors in .ts files using '// @ts-ignore' comments#18457

Merged
ahejlsberg merged 1 commit intomasterfrom
tsIgnoreInTSFiles
Sep 19, 2017
Merged

Suppress errors in .ts files using '// @ts-ignore' comments#18457
ahejlsberg merged 1 commit intomasterfrom
tsIgnoreInTSFiles

Conversation

@ahejlsberg
Copy link
Member

@ahejlsberg ahejlsberg commented Sep 13, 2017 •
edited
Loading

We currently support suppressing errors in .js files using // @ts-ignore comments placed above the offending lines. With this PR we extend this support to .ts files as well. For example:

if (false) {
    // @ts-ignore: Unreachable code error
    console.log("hello");
}

A // @ts-ignore comment suppresses all errors that originate on the following line. It is recommended practice to have the remainder of the comment following @ts-ignore explain which error is being suppressed.

Fixes #9448.

@ahejlsberg ahejlsberg requested a review from mhegazy September 13, 2017 23:13
@DanielRosenwasser DanielRosenwasser mentioned this pull request Sep 15, 2017
Closed
@ahejlsberg ahejlsberg merged commit 8f4a2c1 into master Sep 19, 2017
@ahejlsberg ahejlsberg deleted the tsIgnoreInTSFiles branch September 19, 2017 23:59
@jhalborg
Copy link

jhalborg commented Oct 4, 2017

Hey :)

I can't seem to get this to work. I'm using TS 2.5.3 and VSCode 1.16.1, and I'm trying to ignore the warning I get in the following code.

import * as devConfig from './../../config.dev.json';
import * as prodConfig from './../../config.prod.json';

interface IConfig {
  instagram: {
    clientId: string;
    scopes: object;
  };
  urls: {
    authRedirectURL: string;
    baseAPIURL: string;
    termsURL: string;
  };
  googlePlacesAPIKey: string;
}

const getConfig = (): IConfig => {
  // @ts-ignore: Type 'typeof '*.json'' is not assignable to type 'IConfig'
  return __DEV__ ? devConfig : prodConfig;
};

export { getConfig, IConfig };

Did I miss something?

@ghost
Copy link

ghost commented Oct 4, 2017

@jhalborg This feature isn't in typescript@2.5, you'll have to install typescript@next.

@lmcarreiro
Copy link

lmcarreiro commented Oct 24, 2017

couldn't it be done with the comment in the same line?

let v1: string = 1; // @ts-ignore
let v2: string = 2; // @ts-ignore
let v3: string = 3; // @ts-ignore
let v4: string = 4; // @ts-ignore
let v5: string = 5; // @ts-ignore
let v6: string = 6; // @ts-ignore

instead of:

// @ts-ignore
let v1: string = 1;
// @ts-ignore
let v2: string = 2;
// @ts-ignore
let v3: string = 3;
// @ts-ignore
let v4: string = 4;
// @ts-ignore
let v5: string = 5;
// @ts-ignore
let v6: string = 6;

@lmcarreiro lmcarreiro mentioned this pull request Nov 17, 2017
Open
@Busyrev Busyrev mentioned this pull request Jan 16, 2018
Closed
@basarat
Copy link
Contributor

basarat commented Feb 25, 2018

couldn't it be done with the comment in the same line?

Suppresses error on the next line. Would be confusing if it did too much e.g.

error; // @ts-ignore < Would eat both errors? 
error;

Simple does one well defined thing is better 🌹

@microsoft microsoft locked and limited conversation to collaborators Jul 3, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@RyanCavanaugh RyanCavanaugh RyanCavanaugh approved these changes

@mhegazy mhegazy Awaiting requested review from mhegazy

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@ahejlsberg @jhalborg @lmcarreiro @basarat @RyanCavanaugh @msftclas