foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-25 15:29:32 -05:00
Code Issues Packages 1 Wiki Activity

docs: remove mentions of cli/js (#11006)

Browse source
This commit is contained in:
grian 2021-06-16 19:25:55 +03:00 committed by GitHub
parent a8007059b7
commit 718cb6dad7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
docs/contributing/style_guide.md
View file

@ -49,8 +49,7 @@ Follow Rust conventions and be consistent with existing code.
## TypeScript ## TypeScript
The TypeScript portions of the codebase include `cli/js` for the built-ins and The TypeScript portion of the code base is the standard library `std`.
the standard library `std`.
### Use TypeScript instead of JavaScript. ### Use TypeScript instead of JavaScript.
@ -198,9 +197,9 @@ export type { Person } from "./my_file.ts";
### Minimize dependencies; do not make circular imports. ### Minimize dependencies; do not make circular imports.
Although `cli/js` and `std` have no external dependencies, we must still be Although `std` has no external dependencies, we must still be careful to keep
careful to keep internal dependencies simple and manageable. In particular, be internal dependencies simple and manageable. In particular, be careful not to
careful not to introduce circular imports. introduce circular imports.
### If a filename starts with an underscore: `_foo.ts`, do not link to it. ### If a filename starts with an underscore: `_foo.ts`, do not link to it.
@ -263,21 +262,20 @@ And not:
*/ */
``` ```
Code examples should not utilise the triple-back tick (\`\`\`) notation or tags. Code examples should utilize markdown format, like so:
They should just be marked by indentation, which requires a break before the
block and 6 additional spaces for each line of the example. This is 4 more than
the first column of the comment. For example:
```ts ````ts
/** A straight forward comment and an example: /** A straight forward comment and an example:
* * ```ts
* import { foo } from "deno"; * import { foo } from "deno";
* foo("bar"); * foo("bar");
* ```
*/ */
``` ````
Code examples should not contain additional comments. It is already inside a Code examples should not contain additional comments and must not be indented.
comment. If it needs further comments it is not a good example. It is already inside a comment. If it needs further comments it is not a good
example.
### Resolve linting problems using directives ### Resolve linting problems using directives
@ -296,9 +294,8 @@ problems, but it should be used scarcely.
### 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
`foo_test.ts`. A test for a `cli/js` module should go in `cli/js/tests` due to `foo_test.ts`. A test for a `std` module should go in `std/tests` due to their
their different contexts, otherwise it should just be a sibling to the tested different contexts, otherwise it should just be a sibling to the tested module.
module.
### Unit Tests should be explicit. ### Unit Tests should be explicit.