mirror of
https://github.com/denoland/deno.git
synced 2025-03-03 17:34:47 -05:00
docs: fix deno.land/manual example and clarify linting of code (#7842)
Fixes #7841
This commit is contained in:
parent
21965e8a96
commit
82a17dad11
2 changed files with 24 additions and 1 deletions
|
@ -257,6 +257,29 @@ the first column of the comment. For example:
|
||||||
Code examples should not contain additional comments. It is already inside a
|
Code examples should not contain additional comments. It is already inside a
|
||||||
comment. If it needs further comments it is not a good example.
|
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.
|
### Each module should come with a test module.
|
||||||
|
|
||||||
Every module with public functionality `foo.ts` should come with a test module
|
Every module with public functionality `foo.ts` should come with a test module
|
||||||
|
|
|
@ -68,7 +68,7 @@ command.
|
||||||
/**
|
/**
|
||||||
* write.ts
|
* write.ts
|
||||||
*/
|
*/
|
||||||
const write = await Deno.writeTextFile("./hello.txt", "Hello World!");
|
const write = Deno.writeTextFile("./hello.txt", "Hello World!");
|
||||||
|
|
||||||
write.then(() => console.log("File written to ./hello.txt"));
|
write.then(() => console.log("File written to ./hello.txt"));
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue