Overriding default rules

[ubbe-xyz]

Summary

Hi 👋🏻 ,

I'm using dstlint to help type an existing library, next-auth, that runs on top of NextJS:

nextauthjs/next-auth#220

The library depends on a few types from NextJS...

import type { NextApiRequest, NextApiResponse } from 'next';
// ...
function NextAuth(req: NextApiRequest, res: NextApiResponse, options?: InitOptions): Promise<void>;

When running dtslint, it tries to parse the types from NextJS and throws an error given there's a // ts-ignore comment somewhere on them:

$ npx dtslint types
Error: At /Users/lluis.agusti/Code/next-auth/node_modules/next/types/index.d.ts:{"line":14,"character":6}: 'ts-ignore' is forbidden.
    at /Users/lluis.agusti/Code/next-auth/node_modules/dtslint/bin/index.js:198:19
    at Generator.next (<anonymous>)
    at fulfilled (/Users/lluis.agusti/Code/next-auth/node_modules/dtslint/bin/index.js:6:58) 

Following the docs, I tried to override that linting rule by writing my own tslint.json but it didn't make the error go away ( maybe it only applies to our declaration files? )

Any chance we could get some help on this?

[orta]

We shouldn't raise errors like this for .d.ts files inside node_modules IMO

[Haroenv]

Where would the code be for that?

dtslint/src/lint.ts

Lines 51 to 55 in 285e5a9

	if (!isExternalDependency(file, dirPath, lintProgram) &&
	(inTypesVersionDirectory || !isTypesVersionPath(fileName, dirPath))) {
	linter.lint(fileName, text, config);
	}
	}

but then add it behind a feature flag to not lint "dependencies" at all? Or am I misunderstanding the code?

[orta]

It looks like there's some intentional code under that to run linters against external code - @sandersn any idea what the goal for that is?

[afontcu]

Hi! Stumbled upon this issue because I'm facing the same problem – a broken CI pipeline due to a dependency using ts-ignore. Has anyone found a valid workaround? 😃 Adding a local tslint.json and disabling the check did not work.

[JounQin]

related #89 (comment)