@lbu/cli

@lbu/cli

Collection of Lightbase backend utilities

---

Features

• Minimal project boilerplate
• Script runner, can watch & reload almost anything (via nodemon)
• Flexible code generators supporting routers, validators, api clients, mocks, CRUD queries and more in the future.
• Opinionated structured logging
• Common Koa middleware wrapped in a single function
• Various utilities like loading .env files, executing other processes and a basic string templating system

Requirements

• Node.js >= 14
• Yarn 1.x.x

Why

Here at lightbase we had a constantly growing boilerplate for new projects. To facilitate our needs more and to stop copying and pasting things around this project was born. This project is for now tailored at monolithic projects.

Features breakdown

@lbu/cli:

• Run user scripts (in watch mode)
• Run the linter or tests
• A LBU based boilerplate

@lbu/lint-config:

• All necessary ESLint and Prettier dependencies
• Default configuration for ESLint and Prettier

@lbu/insight:

• A structured logger
  • Writing newline delimited JSON in production
  • Pretty printing for development
• Various utilities to get insight in the running process
• Parser to process production logs in an external process

@lbu/stdlib:

• Various lodash inspired utilities (isNil, isPlainObject, ...)
• Wrappers for child_process execution and spawning
• Basic templating system
• A mainFn wrapper that reads .env and calls the provided function if the file is the process entrypoint
• Replacements for CommonJS __dirname and __filename

@lbu/server:

• Wrapper around Koa instance creation
• 404 en error handling
• Handle CORS
• Send file helper
• Re-exports koa-session and koa-compose

@lbu/store:

• Wrapper around the Minio S3 client
• Wrapper around Postgres connection
• Utilities for providing temporary databases in a test environment
• Postgres migrations
• Postgres and S3 combined for file storage
• Caching files from S3 in memory or on local disk
• Postgres powered JobQueue implementation
  • Supports priority, scheduling, multiple async workers
• koa-session compatible SessionStore backed by Postgres

@lbu/code-gen:

• Code generators for the following:
  • router, with wildcard and path parameter support
  • validators, with pre- and postValidate hooks
  • queries, CRUD postgres queries
  • Axios based api client
  • Typescript or JSDoc types
  • Generated mocks
• An extendable set of types:
  • boolean, number, string;
  • object, array, any;
  • date, uuid;
  • generic, anyOf, reference;
• Remote structure loader
• OpenAPI to LBU converter
• Generate stubs (types and structure only) so packages can also use LBU
  • router structure
  • api client structure (Typescript supported)
  • and of course the normal types generator

Docs

See /docs for all available APIs and various guides.

Development

See CONTRIBUTING.md.

Changelog

v0.0.249

Breaking changes

• feat(code-gen): combine files & body handling when body is multipart 1af5f7
  • The open api importer is not compatible anymore with 'legacy' code-gen, please migrate to experimental code-gen.
  • Rewrite of FormData handling in the 'experimental' api clients, check the new generate output and retest your usages of features using multipart bodies / files.
  • In the near future, we will fully combine files & body handling for the backends as well.
• feat(cli,code-gen): remove compas visualise 4c6784
  • Use the 'includeEntityDiagram' option of the database generator instead.

Features

• feat(store): automatically create migration table if not exists 9496b1
• feat(code-gen): include docs & infer object type in openapi importer a67b38
• feat(cli): add code-mod to convert api clients to experimental code-gen 0a3ba6

Bug fixes

• fix(code-gen/experimental): use anyOf#discriminant in JS validators 3fa324
• fix(code-gen): correct url trimming for openapi imports f64593
• fix(code-gen/experimental): don't generate react-query wrapper if query, body or files are not objects fb2b2d

Other

• chore(code-gen/experimental): remove old README.md c96bc4
• chore(code-gen/experimental): update test helpers 1bffb3
• chore(examples): align example APP_NAME values f78959
• chore(code-gen/experimental): add e2e crud tests 64d07c
• chore(generate): parallelize example generation f01e64
• chore(code-gen/experimental): add crud nested tests 61f419

Dependency updates

• build(deps): bump eslint-plugin-jsdoc from 43.0.7 to 43.1.1 (#2531)
  • Release notes
• build(deps): bump file-type from 18.2.1 to 18.3.0 (#2535)
  • Release notes
• build(deps): bump sharp from 0.32.0 to 0.32.1 (#2541)
  • Release notes
• build(deps): bump @aws-sdk/client-s3 from 3.317.0 to 3.321.1 (#2538)
  • Release notes
• build(deps): bump @aws-sdk/lib-storage from 3.317.0 to 3.321.1 (#2539)
  • Release notes

Previous releases

See the history for earlier changelogs (< v0.0.249).