Skip to content

Commit

Permalink
Chore(deps): bump the update-npm-dependencies group with 3 updates (#355
Browse files Browse the repository at this point in the history 
)

* Chore(deps): bump the update-npm-dependencies group with 3 updates

Bumps the update-npm-dependencies group with 3 updates: [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node), [prettier](https://github.com/prettier/prettier) and [axios](https://github.com/axios/axios).


Updates `@types/node` from 22.9.3 to 22.10.1
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Updates `prettier` from 3.3.3 to 3.4.1
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](prettier/prettier@3.3.3...3.4.1)

Updates `axios` from 1.7.7 to 1.7.8
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md)
- [Commits](axios/axios@v1.7.7...v1.7.8)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: update-npm-dependencies
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: update-npm-dependencies
- dependency-name: axios
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: update-npm-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore: prettier fmt

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Julian König <[email protected]>
  • Loading branch information
@dependabot @jkoenig134
dependabot[bot] and jkoenig134 authored Dec 3, 2024
1 parent 94bccd4 commit 6718203
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 48 deletions.
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Readiness checklist

- [ ] I added/updated tests.
- [ ] I ensured that the PR title is good enough for the changelog.
- [ ] I labeled the PR.
- [ ] I self-reviewed the PR.
- [ ] I added/updated tests.
- [ ] I ensured that the PR title is good enough for the changelog.
- [ ] I labeled the PR.
- [ ] I self-reviewed the PR.

<!-- # Description -->
48 changes: 24 additions & 24 deletions README_dev.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,23 @@

This workspace provides two types of scripts:

- root level scripts (like lints):
- root level scripts (like lints):

These can be run by `npm run <scriptname>` from the root of the project.

- package level scripts (like tests):
- package level scripts (like tests):

These can be run by `npm run <scriptname>` from the package directory or by `npm run -w packages/<package> <scriptname>` from the root of the project.

Additionally, you can run a script in all workspaces by `npm run -ws --if-present <scriptname>`.

## Linting

- TypeScript:
- Each package provides its own TypeScript linting script. You can run it by `npm run lint:tsc` from the package directory or by `npm run -w packages/<package> lint:tsc` from the root of the project.
- The root project also provides a script that lints all packages. You can run it by `npm run lint:tsc` from the root of the project.
- Prettier: Run `npm run lint:prettier` from the root of the project.
- ESLint: Run `npm run lint:eslint` from the root of the project.
- TypeScript:
- Each package provides its own TypeScript linting script. You can run it by `npm run lint:tsc` from the package directory or by `npm run -w packages/<package> lint:tsc` from the root of the project.
- The root project also provides a script that lints all packages. You can run it by `npm run lint:tsc` from the root of the project.
- Prettier: Run `npm run lint:prettier` from the root of the project.
- ESLint: Run `npm run lint:eslint` from the root of the project.

## Check for outdated dependencies

Expand All @@ -36,9 +36,9 @@ To check for outdated dependencies, run `npm run outdated`. This will check the

Set the following environment variables:

- `NMSHD_TEST_BASEURL` (the Backbone baseUrl to test against)
- `NMSHD_TEST_CLIENTID` (the Backbone clientId for the configured baseUrl)
- `NMSHD_TEST_CLIENTSECRET` (the Backbone clientSecret for the configured baseUrl)
- `NMSHD_TEST_BASEURL` (the Backbone baseUrl to test against)
- `NMSHD_TEST_CLIENTID` (the Backbone clientId for the configured baseUrl)
- `NMSHD_TEST_CLIENTSECRET` (the Backbone clientSecret for the configured baseUrl)

> We recommend to persist these variables for example in your `.bashrc` / `.zshrc` or in the Windows environment variables.
Expand All @@ -52,17 +52,17 @@ npm run start:backbone

Set the following environment variables:

- `NMSHD_TEST_BASEURL` to `http://localhost:8090`
- `NMSHD_TEST_CLIENTID` to `test`
- `NMSHD_TEST_CLIENTSECRET` to `test`
- `NMSHD_TEST_BASEURL` to `http://localhost:8090`
- `NMSHD_TEST_CLIENTID` to `test`
- `NMSHD_TEST_CLIENTSECRET` to `test`

> We recommend to persist these variables for example in your `.bashrc` / `.zshrc` or in the Windows environment variables.
### Running the tests

- a specific database: `npm run test:local:[mongodb|lokijs|ferretdb]`
- a specific test suite: `npm run test:local:[mongodb|lokijs|ferretdb] -- testSuiteName`
- with code coverage: `npm run test:local:[mongodb|lokijs|ferretdb] -- --coverage`, a result summary is written to the console, a detailed report is accessible via the path `coverage/lcov-report/index.html`
- a specific database: `npm run test:local:[mongodb|lokijs|ferretdb]`
- a specific test suite: `npm run test:local:[mongodb|lokijs|ferretdb] -- testSuiteName`
- with code coverage: `npm run test:local:[mongodb|lokijs|ferretdb] -- --coverage`, a result summary is written to the console, a detailed report is accessible via the path `coverage/lcov-report/index.html`

### Teardown

Expand All @@ -74,15 +74,15 @@ After testing on MongoDB or FerretDB, you can run `npm run test:local:teardown`

Examples:

- Doesn't build at all
- Module not found
- Something is undefined which should not be undefined (e.g. "TypeError: Cannot read property 'from_base64' of undefined")
- Doesn't build at all
- Module not found
- Something is undefined which should not be undefined (e.g. "TypeError: Cannot read property 'from_base64' of undefined")

Solutions:

- Check if you have got absolute `"src/"` or `"/"` includes somewhere and change them to relative ones (`"../"`).
- Check if you have a cyclic reference somewhere (sometimes quite hard to find). In general, no class should include something from the root's `index.ts` export (looks like `import * from "../../"`).
- Check if you have `"/dist"` as suffix for includes (e.g. `"@nmshd/crypto/dist"`). This usually works fine within NodeJS, however Webpack (Browser Build) has some issues therein, resulting e.g. in the crypto lib being copied into the transport lib. It should be fixed, but you never know...
- Check if you have got absolute `"src/"` or `"/"` includes somewhere and change them to relative ones (`"../"`).
- Check if you have a cyclic reference somewhere (sometimes quite hard to find). In general, no class should include something from the root's `index.ts` export (looks like `import * from "../../"`).
- Check if you have `"/dist"` as suffix for includes (e.g. `"@nmshd/crypto/dist"`). This usually works fine within NodeJS, however Webpack (Browser Build) has some issues therein, resulting e.g. in the crypto lib being copied into the transport lib. It should be fixed, but you never know...

### Something about duplicating private properties

Expand All @@ -92,5 +92,5 @@ Do not use abstract classes.

Or deserialize-/fromUnknown doesn't find your class.

- Check if all (parent) classes up to Serializable(-Async) inclulde a `@schema` declaration with a type.
- You might have several different Serializable(-Async) instances up- and running. This usually happens if ts-serval/crypto/transport are not correctly imported.
- Check if all (parent) classes up to Serializable(-Async) inclulde a `@schema` declaration with a type.
- You might have several different Serializable(-Async) instances up- and running. This usually happens if ts-serval/crypto/transport are not correctly imported.
37 changes: 20 additions & 17 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@
"@js-soft/eslint-config-ts": "^1.6.13",
"@js-soft/license-check": "^1.0.9",
"@types/jest": "^29.5.14",
"@types/node": "^22.9.3",
"@types/node": "^22.10.1",
"enhanced-publish": "^1.1.3",
"eslint": "^8.57.1",
"jest": "^29.7.0",
"jest-expect-message": "^1.1.3",
"madge": "^8.0.0",
"npm-check-updates": "^17.1.11",
"prettier": "^3.3.3",
"prettier": "^3.4.1",
"ts-jest": "^29.2.5",
"ts-node": "^10.9.2",
"tsconfig-paths": "^4.2.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/transport/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
"@js-soft/ts-utils": "^2.3.3",
"@nmshd/core-types": "*",
"@nmshd/crypto": "2.1.0",
"axios": "^1.7.7",
"axios": "^1.7.8",
"fast-json-patch": "^3.1.1",
"form-data": "^4.0.1",
"https-proxy-agent": "^7.0.5",
Expand Down

0 comments on commit 6718203

Please sign in to comment.