fix(core): don't expose src folder on npm & update few npm package (#168

) * fix(core): don't expose src folder on npm & update few npm package * refactor: readme typos
ghiscoding · Nov 25, 2020 · 3c05938 · 3c05938
1 parent bf72139
commit 3c05938
Show file tree

Hide file tree

Showing 10 changed files with 100 additions and 91 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ which is why they are better handled with a monorepo structure.
 
 ### Demo page
 The GitHub [demo page](https://ghiscoding.github.io/slickgrid-universal) uses 2 different themes (Material Design / Salesforce) but you could also use Bootstrap theme which is demoed in other frameworks.
-- [Webpack-Demo-Vanilla-Bundle](https://ghiscoding.github.io/slickgrid-universal) with Material Design theme & Salesforce theme
+- [Webpack-Demo-Vanilla-Bundle](https://ghiscoding.github.io/slickgrid-universal) with Material Design theme & Salesforce themes
 - [Angular-Slickgrid](https://ghiscoding.github.io/Angular-Slickgrid/)
 - [Aurelia-Slickgrid](https://ghiscoding.github.io/aurelia-slickgrid/)
 
@@ -29,17 +29,17 @@ You might be wondering why was this monorepo created? Here are a few of the reas
 (these libs have over 80% of code in common and that is not very DRY).
 2. decouple some Services that should not be required at all time (OData, GraphQL, Export to File, Export to Excel, ...)
 3. framework agnostic, it could be implemented in many more frameworks in the future (interested in adding other frameworks? please contact me...)
-   - you can use it in plain TypeScript or JavaScript (ES6), the later is what we use in Salesforce
+   - you can use it in plain TypeScript or even JavaScript (ES6), the later is what we use in Salesforce
 
 ### Frameworks using this monorepo
 This is a Work in Progress, the goal is to eventually to rewrite [Angular-Slickgrid](https://github.com/ghiscoding/Angular-Slickgrid)
 and [Aurelia-Slickgrid](https://github.com/ghiscoding/aurelia-slickgrid) to use this monorepo which will simplify debugging/fixing common code.
 
-Note however that this project also has a Vanilla Implementation (not associated to any framework)
-and it is also used to test with the UI portion. The Vanilla bundle is also used in our SalesForce (with Lightning Web Component) hence the creation of this monorepo.
+Note however that this project also has a Vanilla Implementation (not associated to any framework) with [WebPack](https://webpack.js.org/)
+and it is also used to test with [Cypress](https://www.cypress.io/) the UI portion. The Vanilla bundle is also used in our SalesForce (with Lightning Web Component) hence the creation of this monorepo.
 
 ### Fully Tested with [Jest](https://jestjs.io/) (Unit Tests) - [Cypress](https://www.cypress.io/) (E2E Tests)
-Slickgrid-Universal has **100%** Unit Test Coverage, we are talking about +10,000 lines of code (+2,800 unit tests) that are now fully tested with [Jest](https://jestjs.io/). There are also +200 Cypress E2E tests to cover all [Examples](https://ghiscoding.github.io/slickgrid-universal/) and most UI functionalities.
+Slickgrid-Universal has **100%** Unit Test Coverage, we are talking about +12,000 lines of code (+2,800 unit tests) that are now fully tested with [Jest](https://jestjs.io/). There are also +200 Cypress E2E tests to cover all [Examples](https://ghiscoding.github.io/slickgrid-universal/) and most UI functionalities.
 
 ### Available Public Packages
 
@@ -62,8 +62,7 @@ Slickgrid-Universal has **100%** Unit Test Coverage, we are talking about +10,00
 ## Installation
 To get going with this monorepo, you will need to clone the repo and then follow the steps below
 
-1. Install npm packages with Yarn
-This lib uses Yarn Workspaces and so you need to use Yarn to install all packages
+1. Install npm packages with Yarn since this lib uses Yarn Workspaces and so you need to use Yarn to install all packages
 ```bash
 yarn install
 ```
@@ -77,7 +76,7 @@ yarn run bootstrap
 
 3. Build
 
-To get started you must run (also once) an initial TS build so that all necessary `dist` are created for all the packages to work together.
+To get started you must run (also once) an initial TS build so that all necessary `dist` are created for all the Lerna packages to work together.
 ```bash
 yarn run build
 
@@ -96,7 +95,7 @@ yarn run dev:watch
 ```
 
 ### Tests
-To run all packages Jest unit tests, you can run this command
+To run all unit tests (with Jest), you can run this command
 ```bash
 yarn run test
 

diff --git a/examples/webpack-demo-vanilla-bundle/package.json b/examples/webpack-demo-vanilla-bundle/package.json
@@ -14,8 +14,8 @@
   "author": "Ghislain B.",
   "license": "MIT",
   "engines": {
-    "node": ">=12.13.1",
-    "npm": ">=6.12.1"
+    "node": ">=14.0.0",
+    "npm": ">=6.14.0"
   },
   "main": "src/slickgrid-universal/index",
   "browserslist": [

diff --git a/package.json b/package.json
@@ -47,11 +47,11 @@
   },
   "devDependencies": {
     "@types/jest": "^26.0.15",
-    "@types/node": "^14.14.9",
-    "@typescript-eslint/eslint-plugin": "^4.8.1",
-    "@typescript-eslint/parser": "^4.8.1",
+    "@types/node": "^14.14.10",
+    "@typescript-eslint/eslint-plugin": "^4.8.2",
+    "@typescript-eslint/parser": "^4.8.2",
     "cypress": "^6.0.0",
-    "eslint": "^7.13.0",
+    "eslint": "^7.14.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-prefer-arrow": "^1.2.2",
     "http-server": "^0.12.3",
@@ -70,7 +70,7 @@
     "typescript": "^4.1.2"
   },
   "engines": {
-    "node": ">=12.13.1",
-    "npm": ">=6.12.1"
+    "node": ">=14.0.0",
+    "npm": ">=6.14.0"
   }
 }
diff --git a/packages/common/package.json b/packages/common/package.json
@@ -13,7 +13,6 @@
     "access": "public"
   },
   "files": [
-    "src",
     "dist"
   ],
   "scripts": {
@@ -84,12 +83,12 @@
     "node-sass": "5.0.0",
     "nodemon": "^2.0.6",
     "npm-run-all": "^4.1.5",
-    "postcss": "^8.1.8",
+    "postcss": "^8.1.10",
     "postcss-cli": "^8.3.0",
     "rimraf": "^3.0.2"
   },
   "engines": {
-    "node": ">=12.13.1",
-    "npm": ">=6.12.1"
+    "node": ">=14.0.0",
+    "npm": ">=6.14.0"
   }
 }
diff --git a/packages/excel-export/package.json b/packages/excel-export/package.json
@@ -10,7 +10,6 @@
     "access": "public"
   },
   "files": [
-    "src",
     "dist"
   ],
   "scripts": {
@@ -28,8 +27,8 @@
   "author": "Ghislain B.",
   "license": "MIT",
   "engines": {
-    "node": ">=12.13.1",
-    "npm": ">=6.12.1"
+    "node": ">=14.0.0",
+    "npm": ">=6.14.0"
   },
   "browserslist": [
     "last 2 version",

diff --git a/packages/file-export/package.json b/packages/file-export/package.json
@@ -10,7 +10,6 @@
     "access": "public"
   },
   "files": [
-    "src",
     "dist"
   ],
   "scripts": {
@@ -28,8 +27,8 @@
   "author": "Ghislain B.",
   "license": "MIT",
   "engines": {
-    "node": ">=12.13.1",
-    "npm": ">=6.12.1"
+    "node": ">=14.0.0",
+    "npm": ">=6.14.0"
   },
   "browserslist": [
     "last 2 version",

diff --git a/packages/graphql/package.json b/packages/graphql/package.json
@@ -10,7 +10,6 @@
     "access": "public"
   },
   "files": [
-    "src",
     "dist"
   ],
   "scripts": {
@@ -28,8 +27,8 @@
   "author": "Ghislain B.",
   "license": "MIT",
   "engines": {
-    "node": ">=12.13.1",
-    "npm": ">=6.12.1"
+    "node": ">=14.0.0",
+    "npm": ">=6.14.0"
   },
   "browserslist": [
     "last 2 version",

diff --git a/packages/odata/package.json b/packages/odata/package.json
@@ -10,7 +10,6 @@
     "access": "public"
   },
   "files": [
-    "src",
     "dist"
   ],
   "scripts": {
@@ -28,8 +27,8 @@
   "author": "Ghislain B.",
   "license": "MIT",
   "engines": {
-    "node": ">=12.13.1",
-    "npm": ">=6.12.1"
+    "node": ">=14.0.0",
+    "npm": ">=6.14.0"
   },
   "browserslist": [
     "last 2 version",

diff --git a/packages/vanilla-bundle/package.json b/packages/vanilla-bundle/package.json
@@ -34,8 +34,8 @@
   "author": "Ghislain B.",
   "license": "MIT",
   "engines": {
-    "node": ">=12.13.1",
-    "npm": ">=6.12.1"
+    "node": ">=14.0.0",
+    "npm": ">=6.14.0"
   },
   "browserslist": [
     "last 2 version",