Skip to content

Commit

Permalink
update README to include info on running eslint; purposely adding syn…
Browse files Browse the repository at this point in the history
…tax error
  • Loading branch information
pleary committed Sep 29, 2023
1 parent f2f98ad commit 43289f4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ Filter by pattern: `NODE_ENV=test ./node_modules/mocha/bin/_mocha --recursive --

You can also add `.only` to a `describe` or `it` call to only run that test when you run `npm test`, e.g. `it.only( "should only run this test" )`.

# ESLint

Please run ESLint to check for syntax formatting errors. To run ESLint, run: `npm run eslint`. Please address any syntax errors before submitting pull requests. ESLint will also run automatically via Github Actions on submitted pull requests along with tests.

All test failures and syntax errors must be resolved before pull requests before will be merged.


# Updating Documentation

Edit `lib/views/swagger_v*.yml.ejs`
3 changes: 3 additions & 0 deletions test/models/db_model.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ describe( "DBModel", ( ) => {
it( "fetches belongs to associations with ids", async ( ) => {
const o = { user_id: 123 };
await DBModel.fetchBelongsTo( [o], User );



expect( o.user ).to.be.undefined;
expect( o.user.id ).to.eq( 123 );
expect( o.user_id ).to.eq( 123 );
Expand Down

0 comments on commit 43289f4

Please sign in to comment.