Skip to content

Commit 9d6bba1

Browse files
committed
update basic commands
1 parent 6878870 commit 9d6bba1

File tree

1 file changed

+34
-23
lines changed

1 file changed

+34
-23
lines changed

src/compiler/basic-commands.md

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,42 @@
11
# Basic Commands
22
The basics of compiler commands.
33

4+
## help
5+
Shows help about of commands.
6+
```
7+
$ julec help
8+
$ julec help <command>
9+
```
10+
411
## build
5-
Compiles a program.
12+
The build command compiles the packages named by the import paths.
13+
14+
The compile path must be the main package directory of the program.
15+
When compiling packages, build ignores files that end in `_test.jule`.
16+
The main package must have the entry point `main` function.
617
```
7-
$ julec build <args>
18+
$ julec build [arguments] <path>
819
```
920

10-
## help
11-
Shows help about of commands.
21+
## test
22+
The test command compiles the packages named by the import paths for testing.
23+
24+
The compile path must be the package directory of the program to be tested.
25+
When compiling packages for testing, it will include files that end in `_test.jule`.
26+
The package may have not the entry point `main` function, it will not be used.
27+
Test compilations uses implicitly generated entry point for testing.
28+
29+
Read the [writing tests](/debugging/testing/writing-tests) section for more information.
1230
```
13-
$ julec help
31+
$ julec test [arguments] <path>
32+
```
33+
34+
## mod
35+
```
36+
$ julec mod <command>
1437
```
38+
Module commands.\
39+
Read the [modules](/packages/modules/) section for more information.
1540

1641
## version
1742
Shows version of the JuleC.
@@ -26,22 +51,8 @@ See the command's help table for more information:
2651
$ julec tool
2752
```
2853

29-
## julenv
30-
Show information about native jule environment.
31-
```
32-
$ julec julenv
33-
```
34-
35-
## test
36-
```
37-
$ julec test <compile-command>
38-
```
39-
Compiles for testing.\
40-
Read the [writing tests](/debugging/testing/writing-tests) section for more information.
41-
42-
## mod
54+
## env
55+
Show information about jule environment.
4356
```
44-
$ julec mod <command>
45-
```
46-
Module commands.\
47-
Read the [modules](/packages/modules/) section for more information.
57+
$ julec env
58+
```

0 commit comments

Comments
 (0)