foster/deno
0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-03-03 09:31:22 -05:00
Code Issues Packages 1 Wiki Activity

docs: Update style guide (#8267)

Browse source
This commit is contained in:
Bartek Iwańczuk 2020-11-06 17:36:28 +01:00 • committed by GitHub
parent fd9b6e03af
commit 280ab920a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/contributing/style_guide.md
View file

@ -279,20 +279,11 @@ 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
### Resolve linting problems using 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:
Currently, the building process uses `dlint` to validate linting problems in the
code. If the task requires code that is non-conformant to linter use
`deno-lint-ignore <code>` directive to supress the warning.
```typescript
// deno-lint-ignore no-explicit-any
@ -300,7 +291,7 @@ let x: any;
```
This ensures the continuous integration process doesn't fail due to linting
problems.
problems, but it should be used scarcely.
### Each module should come with a test module.