rocket-toolkit 👩‍🔧

A collection of plugins and other GraphQL utilities.

Packages

• apollo-logger
• correlation
• graceful-shutdown
• key-per-file-configuration
• knex-filters
• message-bus
• metrics
• multitenancy-core
• opentelemetry-instrumentation-ws
• opentracing
• pino-apollo
• pino-correlation
• pino-mssqlserver
• pino-multitenancy
• pino-opentelemetry
• pino-opentracing

Contributing guide

When using Visual Studio Code please follow these steps: Editor Setup for VSCode (allows VSCode to read .zip yarn cache files and supports features like go-to-definition).

When using Visual Studio Code please use the extension Licenser for applying the license header in files.

- Build

yarn install
yarn build

- Test

yarn test

- Testing local packages

To test your package locally without publishing to a npm repository, you can create a link in your testing project. For example:

npm link <YOUR_PATH>\rocket-toolkit\packages\key-per-file-configuration

If the package reference does not already exist in your testing project, you can add it without specifying the version:

{
  "dependencies": {
    ...
    "@totalsoft/key-per-file-configuration": "",
  }
}

For additional options see the official documentation

- Pull Request

Every change/feature/fix must result in a Pull Request. Before creating the PR make sure that all the tests are passing.

- Add new changeset

Every Pull request MUST be associated to a changeset. To add a new changeset use the following command:

yarn changeset add

This command will ask you a series of questions, first about what packages you want to release, then what semver bump type for each package, then it will ask for a summary of the entire changeset. At the final step it will show the changeset it will generate, and confirm that you want to add it.

Once confirmed, the changeset will write a Markdown file that contains the summary and YAML front matter which stores the packages that will be released and the semver bump types for them.

Read more about changesets here.

License

rocket-toolkit is licensed under the MIT license. @TotalSoft