From 82a17dad11f415a3ef31484f3511abc1de5a61ee Mon Sep 17 00:00:00 2001 From: Steven Guerrero Date: Tue, 6 Oct 2020 19:31:36 -0500 Subject: docs: fix deno.land/manual example and clarify linting of code (#7842) Fixes #7841 --- docs/contributing/style_guide.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'docs/contributing') diff --git a/docs/contributing/style_guide.md b/docs/contributing/style_guide.md index 4d93818f0..261a03cc9 100644 --- a/docs/contributing/style_guide.md +++ b/docs/contributing/style_guide.md @@ -257,6 +257,29 @@ the first column of the comment. For example: Code examples should not contain additional comments. It is already inside a comment. If it needs further comments it is not a good example. +### Resolve linting problems using ESLint directives + +Currently, the building process uses ESLint to validate linting problems in the +code. Don't use `deno_lint` directives while working with internal Deno code and +the std library. + +What would be: + +```typescript +// deno-lint-ignore no-explicit-any +let x: any; +``` + +Should rather be: + +```typescript +// eslint-disable-next-line @typescript-eslint/no-explicit-any +let x: any; +``` + +This ensures the continuous integration process doesn't fail due to linting +problems. + ### Each module should come with a test module. Every module with public functionality `foo.ts` should come with a test module -- cgit v1.2.3