Skip to content

Commit

Permalink
fix: fix CLI examples and references in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Closes #16 and #17
  • Loading branch information
mig8447 committed Oct 31, 2023
1 parent 928f336 commit a44ff7d
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ npm run test
Once you have built the library, you can run the example CLI by executing:

```bash
npm run example-cli
npm run example-cli -- ./test/department_employees.quicksql
```

## Pull request process
Expand Down
6 changes: 3 additions & 3 deletions examples/cli.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
#!/usr/bin/env node

/**
* Reads QuickSQL input from a file in the filesystem and outputs the translated
* Reads Quick SQL input from a file in the filesystem and outputs the generated
* DDL to console
*
* Execution:
*
* ```sh
* ./translate.js <FILE_PATH>
* ./cli.js <FILE_PATH>
* ```
*/

Expand All @@ -18,7 +18,7 @@ import quicksql from '../dist/quick-sql.js';
function print_usage() {
console.log(
/* eslint-disable indent */
`QuickSQL ${ quicksql.version } Translation Example
`Quick SQL ${ quicksql.version } DDL Generation Example
Usage: ./cli.js <FILE_PATH>
Example: ./cli.js ../test/project_management.quicksql
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"test": "./test/regression_test.js",
"lint:markdown": "markdownlint-cli2 *.md, doc/**/*.md",
"lint": "run-p lint:*",
"example-cli": "./examples/cli.js ./test/project_management.quicksql",
"example-cli": "./examples/cli.js",
"postversion": "run-s build"
},
"repository": {
Expand Down

0 comments on commit a44ff7d

Please sign in to comment.