Skip to content

Commit 1a9f328

Browse files
committed
Update docs and yaml fiels
1 parent 407aeb6 commit 1a9f328

File tree

7 files changed

+20
-20
lines changed

7 files changed

+20
-20
lines changed

.github/workflows/benchmark.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,15 @@ jobs:
4848

4949
- name: Run benchmark on current branch
5050
run: |
51-
( for i in {1..${{ steps.settings.outputs.benchmark_repetitions }}}; do go test ./... -run=XXX -bench=. -benchmem -shuffle=on; done | sed 's/pkg:.*/pkg: github.com\/onflow\/cadence\/runtime/' ) | tee new.txt
51+
( for i in {1..${{ steps.settings.outputs.benchmark_repetitions }}}; do go test ./... -run=XXX -bench=. -benchmem -shuffle=on; done | sed 's/pkg:.*/pkg: github.com\/onflow\/cadence\/' ) | tee new.txt
5252
# the package replace line above is to make the results table more readable, since it is not fragmented by package
5353

5454
- name: Checkout base branch
5555
run: git checkout ${{ github.event.pull_request.base.sha }}
5656

5757
- name: Run benchmark on base branch
5858
run: |
59-
( for i in {1..${{ steps.settings.outputs.benchmark_repetitions }}}; do go test ./... -run=XXX -bench=. -benchmem -shuffle=on; done | sed 's/pkg:.*/pkg: github.com\/onflow\/cadence\/runtime/' ) | tee old.txt
59+
( for i in {1..${{ steps.settings.outputs.benchmark_repetitions }}}; do go test ./... -run=XXX -bench=. -benchmem -shuffle=on; done | sed 's/pkg:.*/pkg: github.com\/onflow\/cadence\/' ) | tee old.txt
6060
6161
# see https://trstringer.com/github-actions-multiline-strings/ to see why this part is complex
6262
- name: Use benchstat for comparison

.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ jobs:
4949
run: make ci
5050

5151
- name: Cadence Testing Framework
52-
run: cd runtime/stdlib/contracts && flow test --cover --covercode="contracts" crypto_test.cdc
52+
run: cd stdlib/contracts && flow test --cover --covercode="contracts" crypto_test.cdc
5353

5454
- name: Upload coverage report
5555
uses: codecov/codecov-action@v2

.gitignore

+4-4
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ suppressions
3434

3535
coverage.txt
3636
coverage.txt-e
37-
runtime/cmd/check/check
38-
runtime/cmd/main/main
39-
runtime/cmd/parse/parse
40-
runtime/cmd/parse/parse.wasm
37+
cmd/check/check
38+
cmd/main/main
39+
cmd/parse/parse
40+
cmd/parse/parse.wasm
4141
tools/golangci-lint/golangci-lint
4242
tools/maprange/maprange
4343
tools/unkeyed/unkeyed

docs/FAQ.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ There are several options to run the analyzer pass with the linter tool:
4343

4444
## Analyzing Cadence values / state snapshots
4545

46-
To analyze Cadence values (`interpreter.Value`), you can use the function [`interpreter.InspectValue`](https://github.com/onflow/cadence/blob/master/runtime/interpreter/inspect.go#L31).
46+
To analyze Cadence values (`interpreter.Value`), you can use the function [`interpreter.InspectValue`](https://github.com/onflow/cadence/blob/master/interpreter/inspect.go#L31).
4747

4848
To find static types in Cadence values (e.g. in type values, containers, capabilities), you can see which values contain static types in the [Cadence 1.0 static type migration code](https://github.com/onflow/cadence/blob/master/migrations/statictypes/statictype_migration.go#L67).
4949

docs/development.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
## Tools
44

5-
The [`runtime/cmd` directory](https://github.com/onflow/cadence/tree/master/runtime/cmd)
5+
The [`cmd` directory](https://github.com/onflow/cadence/tree/master/cmd)
66
contains command-line tools that are useful when working on the implementation for Cadence, or with Cadence code:
77

8-
- The [`parse`](https://github.com/onflow/cadence/tree/master/runtime/cmd/parse) tool
8+
- The [`parse`](https://github.com/onflow/cadence/tree/master/cmd/parse) tool
99
can be used to parse (syntactically analyze) Cadence code.
1010
By default, it reports syntactical errors in the given Cadence program, if any, in a human-readable format.
1111
By providing the `-json` it returns the AST of the program in JSON format if the given program is syntactically valid,
1212
or syntactical errors in JSON format (including position information).
1313

1414
```
15-
$ echo "X" | go run ./runtime/cmd/parse
15+
$ echo "X" | go run ./cmd/parse
1616
error: unexpected token: identifier
1717
--> :1:0
1818
|
@@ -21,7 +21,7 @@ contains command-line tools that are useful when working on the implementation f
2121
```
2222

2323
```
24-
$ echo "let x = 1" | go run ./runtime/cmd/parse -json
24+
$ echo "let x = 1" | go run ./cmd/parse -json
2525
[
2626
{
2727
"program": {
@@ -42,28 +42,28 @@ contains command-line tools that are useful when working on the implementation f
4242
[...]
4343
```
4444

45-
- The [`check`](https://github.com/onflow/cadence/tree/master/runtime/cmd/check) tool
45+
- The [`check`](https://github.com/onflow/cadence/tree/master/cmd/check) tool
4646
can be used to check (semantically analyze) Cadence code.
4747
By default, it reports semantic errors in the given Cadence program, if any, in a human-readable format.
4848
By providing the `-json` it returns the AST in JSON format, or semantic errors in JSON format (including position information).
4949

5050
```
51-
$ echo "let x = 1" | go run ./runtime/cmd/check 1 ↵
51+
$ echo "let x = 1" | go run ./cmd/check 1 ↵
5252
error: error: missing access modifier for constant
5353
--> :1:0
5454
|
5555
1 | let x = 1
5656
| ^
5757
```
5858

59-
- The [`main`](https://github.com/onflow/cadence/tree/master/runtime/cmd/check) tools
59+
- The [`main`](https://github.com/onflow/cadence/tree/master/cmd/check) tools
6060
can be used to execute Cadence programs.
6161
If a no argument is provided, the REPL (Read-Eval-Print-Loop) is started.
6262
If an argument is provided, the Cadence program at the given path is executed.
6363
The program must have a function named `main` which has no parameters and no return type.
6464

6565
```
66-
$ go run ./runtime/cmd/main 130 ↵
66+
$ go run ./cmd/main 130 ↵
6767
Welcome to Cadence v0.12.3!
6868
Type '.help' for assistance.
6969
@@ -74,7 +74,7 @@ contains command-line tools that are useful when working on the implementation f
7474

7575
```
7676
$ echo 'pub fun main () { log("Hello, world!") }' > hello.cdc
77-
$ go run ./runtime/cmd/main hello.cdc
77+
$ go run ./cmd/main hello.cdc
7878
"Hello, world!"
7979
```
8080

@@ -83,7 +83,7 @@ contains command-line tools that are useful when working on the implementation f
8383
Run the checker tests with the `cadence.checkConcurrently` flag, e.g.
8484

8585
```shell
86-
go test -race -v ./runtime/tests/checker -cadence.checkConcurrently=10
86+
go test -race -v ./tests/checker -cadence.checkConcurrently=10
8787
```
8888

8989
This runs each check of a checker test 10 times, concurrently,

npm-packages/cadence-parser/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
}
1919
},
2020
"scripts": {
21-
"build": "npm run build:types && npm run build:esm && npm run build:cjs && GOARCH=wasm GOOS=js go build -o ./dist/cadence-parser.wasm ../../runtime/cmd/parse",
21+
"build": "npm run build:types && npm run build:esm && npm run build:cjs && GOARCH=wasm GOOS=js go build -o ./dist/cadence-parser.wasm ../../cmd/parse",
2222
"build:types": "tsc --emitDeclarationOnly --module system --outDir dist/types",
2323
"build:esm": "esbuild src/index.ts --bundle --sourcemap --format=esm --outfile=dist/esm/index.mjs",
2424
"build:cjs": "tsc --module commonjs --target es6 --outDir dist/cjs --declaration false",

tools/compare-parsing/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
package main
2020

2121
// Parses all programs in a CSV file with header location,code
22-
// using am old and new runtime/cmd/parse program.
22+
// using am old and new `cmd/parse` program.
2323
//
2424
// It reports already broken programs, programs that are broken with the new parser,
2525
// and when parses of the old and new parser differ

0 commit comments

Comments
 (0)