Skip to content

Commit

Permalink
Merge branch 'master' into next
Browse files Browse the repository at this point in the history
  • Loading branch information
@ghiscoding
ghiscoding committed May 9, 2024
2 parents 600fae7 + 3e87e9b commit 6290af0
Show file tree
Hide file tree
Showing 5 changed files with 154 additions and 216 deletions.
18 changes: 9 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https:///pr.new/ghiscoding/slickgrid-universal)

### Description
This is a monorepo project (using [pnpm workspaces](https://pnpm.io/workspaces)) which is regrouping a few packages under a single repository. It originally required SlickGrid as a dependency but that is no longer the case and is now a standalone library. The main goal of this project is to create a common repo that includes all Editors, Filters, Extensions and Services that could be used by any Framework (it is framework agnostic). The original SlickGrid is like an IKEA product that requires assembling everything yourself, the goal of the project here is to offer an all assembled product including a set of built-in Editors, Filters, Formatters and some optional packages like OData, GraphQL, ... and SlickGrid simply did not offer that by default. See below for more project details.
This is a monorepo project (using [pnpm workspaces](https://pnpm.io/workspaces)) which is regrouping a few packages under a single repository. It was originally requiring SlickGrid as an external dependency, but that is no longer the case and is now a standalone library. The main goal of this project is to create a common repo that includes all Editors, Filters, Extensions and Services that could be used by any Framework (it is framework agnostic). The original SlickGrid is like an IKEA product that requires assembling everything yourself, however the goal of our project here is to offer an all assembled product including a set of built-in Editors, Filters, Formatters and also extra packages that are optionals like OData, GraphQL, Export to Excel ... which SlickGrid simply does not offer by default. See below for more project details.

### Why create this monorepo?
Below is a list of reasons why this project was created and why it is a monorepo project:
Expand Down Expand Up @@ -55,7 +55,7 @@ The GitHub [live demo](https://ghiscoding.github.io/slickgrid-universal) shows 2
The Slickgrid-Universal [live demo](https://ghiscoding.github.io/slickgrid-universal) is a Vanilla Implementation (which is not associated to any framework) built with [ViteJS](https://vitejs.dev/) (originally [WebPack](https://webpack.js.org/)) and is also used to run the E2E tests with [Cypress](https://www.cypress.io/) for testing all UI functionalities. The [Vanilla-force-bundle](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/vanilla-force-bundle), which extends the [vanilla-bundle](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/vanilla-bundle) package is also what we use in our SalesForce implementation (with Lightning Web Component), which was the original reason to create this monorepo library and avoid code duplication.

### Fully Tested with [Jest](https://jestjs.io/) (Unit Tests) - [Cypress](https://www.cypress.io/) (E2E Tests)
Slickgrid-Universal has close to **100%** Unit Test Coverage, almost 5,000 Jest unit tests and also +550 Cypress E2E tests to cover all [Examples](https://ghiscoding.github.io/slickgrid-universal/) and most UI functionalities (each framework implementation also have an additional 600 tests), the goal is to test everything and offer peace of mind that all the code and PR changes are fully tested and that we have tests to cover them.
Slickgrid-Universal has close to **100%** Unit Test Coverage, almost 5,000 Jest unit tests and also +550 Cypress E2E tests to cover all [Examples](https://ghiscoding.github.io/slickgrid-universal/) and most UI functionalities (each framework implementation also have an additional 600 tests), the goal is to test everything and offer peace of mind that all the code and PR changes are fully tested and that we have tests to cover everything.

### Available Public Packages

Expand All @@ -80,17 +80,17 @@ Slickgrid-Universal has close to **100%** Unit Test Coverage, almost 5,000 Jest
| [@slickgrid-universal/vanilla-force-bundle](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/vanilla-force-bundle) | [![npm](https://img.shields.io/npm/v/@slickgrid-universal/vanilla-force-bundle.svg)](https://www.npmjs.com/package/@slickgrid-universal/vanilla-force-bundle) | [![npm bundle size](https://img.shields.io/bundlephobia/minzip/@slickgrid-universal/vanilla-force-bundle?color=success&label=gzip)](https://bundlephobia.com/result?p=@slickgrid-universal/vanilla-force-bundle) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/vanilla-force-bundle/CHANGELOG.md)

## Installation
**NOTE:** the installation instructions below are **only** required if you want to contribute to this project, if on the other hand you just want to download a quick Slickgrid-Universal demo, then I would suggest to take a look at [Slickgrid-Universal Vite Demo](https://github.com/ghiscoding/slickgrid-universal-vite-demo) or [Slickgrid-Universal WebPack Demo](https://github.com/ghiscoding/slickgrid-universal-webpack-demo).
**NOTE:** the installation instructions below are **only** required if you want to contribute to this project, however if you just want to download a quick Slickgrid-Universal demo, then I would suggest to take a look at either [Slickgrid-Universal Vite Demo](https://github.com/ghiscoding/slickgrid-universal-vite-demo) or [Slickgrid-Universal WebPack Demo](https://github.com/ghiscoding/slickgrid-universal-webpack-demo).

To get started and do development with this monorepo, you will need to clone the repo and follow the steps shown below. You must be at the root of the project to run the following commands. This project also requires `pnpm`.
To get started and do development with this monorepo, you will need to clone the repo and follow the steps shown below. You must be at the root of the project in order to run the following commands. This project also requires `pnpm`.

1. pnpm installation

This project uses [pnpm workspaces](https://pnpm.io/workspaces), you can install pnpm by picking 1 of these 2 choices:

a. following their [installation](https://pnpm.io/installation)

b. or install pnpm via Node corepack
b. or install pnpm via Node [corepack](https://nodejs.org/api/corepack.html)
```sh
corepack enable

Expand All @@ -111,17 +111,17 @@ pnpm run dev

3. Build (bundle)

You also need to run a full build if you want to run the Jest unit tests
You also need to run a full build in order to run the Jest unit tests

```bash
pnpm run bundle
```

### Tests
You must go through Installation Steps 1-2 (or 1,3) prior to running the Jest unit tests OR steps 1-2 when running Cypress E2E tests.
You must go through Installation Steps 1-3 prior to running the Jest unit tests OR steps 1-2 when running Cypress E2E tests.

#### Jest Unit Tests
To run all unit tests (with Jest), you can run one of the following commands (make sure that steps 1,3 were executed prior to running this command)
To run all unit tests (with Jest), you can run one of the following commands (make sure that steps 1-3 were executed prior to running this command)
```bash
pnpm run test

Expand All @@ -130,7 +130,7 @@ pnpm run test:watch
```

#### Cypress E2E Tests
To run all E2E tests (with Cypress), you can run one of the following commands (make sure that steps 1,2 were executed prior to running this command)
To run all E2E tests (with Cypress), you can run one of the following commands (make sure that steps 1-2 were executed prior to running this command)
```bash
# will open the Cypress GUI
pnpm run cypress
Expand Down
4 changes: 2 additions & 2 deletions examples/vite-demo-vanilla-bundle/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@
},
"devDependencies": {
"@types/fnando__sparkline": "^0.3.7",
"@types/node": "^20.12.8",
"@types/node": "^20.12.11",
"@types/whatwg-fetch": "^0.0.33",
"sass": "^1.76.0",
"sass": "^1.77.0",
"typescript": "^5.4.5",
"vite": "^5.2.11"
}
Expand Down
12 changes: 6 additions & 6 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,17 @@
"@lerna-lite/run": "^3.3.3",
"@lerna-lite/watch": "^3.3.3",
"@types/jest": "^29.5.12",
"@types/node": "^20.12.8",
"@types/node": "^20.12.11",
"conventional-changelog-conventionalcommits": "^7.0.2",
"cross-env": "^7.0.3",
"cypress": "^13.8.1",
"cypress": "^13.9.0",
"cypress-real-events": "^1.12.0",
"dotenv": "^16.4.5",
"eslint": "^9.1.1",
"eslint-plugin-cypress": "^3.1.0",
"eslint": "^9.2.0",
"eslint-plugin-cypress": "^3.2.0",
"eslint-plugin-import": "^2.29.1",
"eslint-plugin-jest": "^28.4.0",
"eslint-plugin-n": "^17.4.0",
"eslint-plugin-jest": "^28.5.0",
"eslint-plugin-n": "^17.5.1",
"husky": "^9.0.11",
"jest": "^29.7.0",
"jest-cli": "^29.7.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/common/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
"npm-run-all2": "^6.1.2",
"postcss": "^8.4.38",
"postcss-cli": "^11.0.0",
"sass": "^1.76.0"
"sass": "^1.77.0"
},
"engines": {
"node": "^18.0.0 || >=20.0.0"
Expand Down
Loading

0 comments on commit 6290af0

Please sign in to comment.