Skip to content

Commit 867cc32

Browse files
author
Barrett Schonefeld
committed
fix: improving description of node formatting script and fixing a minor typo
1 parent 4938b18 commit 867cc32

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README-FIRST.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Those steps outline the files necessary to change for each service added. This r
1818
## Code Organization
1919
Code is organized into top-level directories, named after each service. Generated service files live under these directories and are named only by their version, like `v1.ts`. The repository is structured this way so that each service can be imported into a user’s code independently using the following structure: `require('package-name/service-name/version')`.
2020

21-
All generated service code relies on a package called [`ibm-cloud-sdk-core`](https://github.com/IBM/node-sdk-core)), which contains the generic, shared functionality used across any generated SDK. This package handles authentication and response handling, among other things. It is already installed in this repository, along with all other required dependencies.
21+
All generated service code relies on a package called [`ibm-cloud-sdk-core`](https://github.com/IBM/node-sdk-core), which contains the generic, shared functionality used across any generated SDK. This package handles authentication and response handling, among other things. It is already installed in this repository, along with all other required dependencies.
2222

2323
Service code that must be hand-written (like methods for WebSocket APIs) or shared code that is service specific (as in, doesn’t belong in the core) lives in the `lib/` directory.
2424

@@ -34,7 +34,7 @@ You can run the linter with the following commands. Replacing “check” with
3434
- `npm run eslint:check`
3535

3636
If you run into linter errors on the generated unit tests, you can run the node formatting script stored in the [generator repository](https://github.ibm.com/CloudEngineering/openapi-sdkgen) using:
37-
- /\<path to generator\>/openapi-sdkgen/scripts/node_format.sh /\<path to sdk project\>/test/unit/*.js
37+
- /\<path to generator\>/scripts/node_format.sh /\<path to sdk project\>/test/unit/*.js
3838

3939
## Testing
4040
SDK tests are organized into “unit” and “integration” tests, which live in `test/unit/` and `test/integration/`, respectively. Unit tests mock the request framework and test that request objects are constructed properly. Integration tests make requests to live service instances and test that the SDK works as intended from end to end.

0 commit comments

Comments
 (0)