Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,33 @@ All notable changes to this project will be documented in this file. See [standa

## [9.0.0](https://github.com/AnthonyLzq/simba.js/compare/v8.1.0...v9.0.0) (2026-02-22)

### ⚠ BREAKING CHANGES

* replaced ESLint with Biome for linting and formatting in generated projects
* pinned Prisma to v6 (MongoDB is not supported in Prisma v7)
* Node.js >= 20 is now required

### Features

* replaced ESLint with Biome for generated projects ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* updated type-graphql from 2.0.0-beta.1 to 2.0.0-rc.3, added graphql-scalars peer dependency ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* updated generated GitHub Actions templates to v4 (checkout, setup-node, pnpm/action-setup), Node.js 20.x, pnpm 9.x ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* updated root CI workflow to use Biome instead of ESLint ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* updated all generated project dependencies to latest versions ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* pinned Prisma to v6 for MongoDB compatibility ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* updated Biome schema version to 2.4.4 ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* updated root dependencies: @biomejs/biome ^2.4.4, jest 30.2.0, @types/jest 30.0.0, dotenv 17.3.1, mongodb 7.1.0, pg 8.18.0, underscore 1.13.8 ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* created .github/copilot-instructions.md ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* removed deprecated MongoDB driver options (useNewUrlParser, useUnifiedTopology) ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))


### Bug Fixes

* fixed ghat.js manager.split() bug causing incorrect package manager detection ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* fixed generated GitHub Actions ternary logic for install commands ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* fixed Express template unused `req` parameter (TS6133 strict mode error) ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))
* fixed root CI using `npm i --frozen-lockfile` instead of `npm ci` ([1516469](https://github.com/AnthonyLzq/simba.js/commit/15164690be4bf07f3a88959138e93838cfff458f))

## [8.1.0](https://github.com/AnthonyLzq/simba.js/compare/v8.0.0...v8.1.0) (2024-08-12)


Expand Down
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[![NPM version](https://img.shields.io/npm/v/@anthonylzq/simba.js.svg?style=flat)](https://www.npmjs.com/package/@anthonylzq/simba.js)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AnthonyLzq/simba.js/blob/master/LICENSE)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![Biome](https://img.shields.io/badge/code_style-biome-blue.svg)](https://biomejs.dev)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
[![Publish](https://github.com/AnthonyLzq/TypeScriptProjectGenerator/actions/workflows/publish.yml/badge.svg)](https://github.com/AnthonyLzq/TypeScriptProjectGenerator/actions/workflows/publish.yml)

Expand Down Expand Up @@ -164,6 +164,7 @@ Also, if you are interested in the folder structure of each case, please take a

### Some considerations

- **Prisma v6**: Generated projects use Prisma v6 (pinned). Prisma v7 is **not** used because it does not support MongoDB. When Prisma v7 adds MongoDB support, Simba.js will be updated accordingly.
- You are able to run a server that has one main route, `home` (`/`), `user` (`api/user` or `api/user/:id`) and `docs` (`api/docs`), in case you are not using GraphQL.
- In case you are using GraphQL, there are 3 mutations (`store`, `update`, and `deleteById`) and 1 query available (`getById`), you can find them in the playground under the route `/api`.
- To connect your server with your database, you need to provide your database url in the `.env`, except if you choose `sqlite`. By default, Simba will try to connect to a local database. The content of the `.env` file is:
Expand Down Expand Up @@ -248,28 +249,17 @@ Here is the list of the packages that are being installed, as `dependencies`:

As `devDependencies`:

- [`@biomejs/biome`](https://www.npmjs.com/package/@biomejs/biome)
- [`@jest/types`](https://www.npmjs.com/package/@jest/types)
- [`@types/debug`](https://www.npmjs.com/package/@types/debug)
- [`@types/http-errors`](https://www.npmjs.com/package/@types/http-errors)
- [`@types/jest`](https://www.npmjs.com/package/@types/jest)
- [`@types/node`](https://www.npmjs.com/package/@types/node)
- [`@typescript-eslint/eslint-plugin`](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
- [`@typescript-eslint/parser`](https://www.npmjs.com/package/@typescript-eslint/parser)
- [`axios`](https://www.npmjs.com/package/axios)
- [`dotenv`](https://www.npmjs.com/package/dotenv)
- [`eslint`](https://www.npmjs.com/package/eslint)
- [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier)
- [`eslint-config-standard`](https://www.npmjs.com/package/eslint-config-standard)
- [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import)
- [`eslint-plugin-jest`](https://www.npmjs.com/package/eslint-plugin-jest)
- [`eslint-plugin-n`](https://www.npmjs.com/package/eslint-plugin-n) (in case you are using yarn as package manager)
- [`eslint-plugin-node`](https://www.npmjs.com/package/eslint-plugin-node)
- [`eslint-plugin-prettier`](https://www.npmjs.com/package/eslint-plugin-prettier)
- [`eslint-plugin-promise`](https://www.npmjs.com/package/eslint-plugin-promise)
- [`jest`](https://www.npmjs.com/package/jest)
- [`jest-unit`](https://www.npmjs.com/package/jest-unit)
- [`nodemon`](https://www.npmjs.com/package/nodemon)
- [`prettier`](https://www.npmjs.com/package/prettier)
- [`prisma`](https://www.npmjs.com/package/prisma)
- [`standard-version`](https://www.npmjs.com/package/standard-version)
- [`ts-loader`](https://www.npmjs.com/package/ts-loader)
Expand All @@ -284,13 +274,15 @@ As `dependencies`:
- [`@apollo/server`](https://www.npmjs.com/package/@apollo/server)
- [`class-validator`](https://www.npmjs.com/package/class-validator)
- [`graphql`](https://www.npmjs.com/package/graphql)
- [`graphql-scalars`](https://www.npmjs.com/package/graphql-scalars)
- [`reflect-metadata`](https://www.npmjs.com/package/reflect-metadata)
- [`type-graphql`](https://www.npmjs.com/package/type-graphql/v/2.0.0-beta.2)
- [`type-graphql`](https://www.npmjs.com/package/type-graphql/v/2.0.0-rc.3)

### Express case

As `dependencies`:

- [`@as-integrations/express5`](https://www.npmjs.com/package/@as-integrations/express5) (only when using GraphQL)
- [`cors`](https://www.npmjs.com/package/cors)
- [`express`](https://www.npmjs.com/package/express)
- [`swagger-ui-express`](https://www.npmjs.com/package/swagger-ui-express)
Expand Down