Skip to content

Commit a44ff7d

Browse files
committed
fix: fix CLI examples and references in CONTRIBUTING.md
Closes #16 and #17
1 parent 928f336 commit a44ff7d

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ npm run test
6363
Once you have built the library, you can run the example CLI by executing:
6464

6565
```bash
66-
npm run example-cli
66+
npm run example-cli -- ./test/department_employees.quicksql
6767
```
6868

6969
## Pull request process

examples/cli.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
#!/usr/bin/env node
22

33
/**
4-
* Reads QuickSQL input from a file in the filesystem and outputs the translated
4+
* Reads Quick SQL input from a file in the filesystem and outputs the generated
55
* DDL to console
66
*
77
* Execution:
88
*
99
* ```sh
10-
* ./translate.js <FILE_PATH>
10+
* ./cli.js <FILE_PATH>
1111
* ```
1212
*/
1313

@@ -18,7 +18,7 @@ import quicksql from '../dist/quick-sql.js';
1818
function print_usage() {
1919
console.log(
2020
/* eslint-disable indent */
21-
`QuickSQL ${ quicksql.version } Translation Example
21+
`Quick SQL ${ quicksql.version } DDL Generation Example
2222
2323
Usage: ./cli.js <FILE_PATH>
2424
Example: ./cli.js ../test/project_management.quicksql

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"test": "./test/regression_test.js",
3333
"lint:markdown": "markdownlint-cli2 *.md, doc/**/*.md",
3434
"lint": "run-p lint:*",
35-
"example-cli": "./examples/cli.js ./test/project_management.quicksql",
35+
"example-cli": "./examples/cli.js",
3636
"postversion": "run-s build"
3737
},
3838
"repository": {

0 commit comments

Comments
 (0)