@@ -29,9 +29,9 @@ The modernization steps:
29
29
- migrate to TypeScript (giving us Types ` d.ts ` )
30
30
- drop ` Q ` dependency (we simply use native ` Promise ` )
31
31
- drop ` Lodash ` dependency (we now use native JS code)
32
- - replace ` JSZip ` dependency with [ ` fflate ` ] ( https://github.com/101arrowz/fflate ) which has an ESM build offers better performance.
33
- - bump version to ` v3.0.0 ` with a ` major ` release (_ the original project version was in the ` 2.x ` range._ )
34
- - note: the changelog did not exists before ` v3.0.0 `
32
+ - replace ` JSZip ` dependency with [ ` fflate ` ] ( https://github.com/101arrowz/fflate ) which has an ESM build offers and better performance.
33
+ - bump version to ` v3.0.0 ` as a ` major ` release (_ the original project version was in the ` 2.x ` range._ )
34
+ - note that the changelog did not exists before ` v3.0.0 `
35
35
36
36
This modernization is providing a huge decrease in the final build size and is offering better performance 🚀
37
37
@@ -43,7 +43,7 @@ npm install excel-builder-vanilla
43
43
44
44
The project offers 3 different bundle types, choose the best for your use case
45
45
1 . ESM: to ` import from ` (prefered)
46
- 2 . CJS: CommonJS to support old Node ` require() ` ... might be removed in the future
46
+ 2 . CJS: CommonJS to support old Node ` require() ` - will possibly be removed in the future
47
47
3 . IIFE: standalone script with ` ExcelBuilder ` available on the ` window ` object
48
48
49
49
``` ts
@@ -55,6 +55,9 @@ const { createWorksheet } = require('excel-builder-vanilla');
55
55
56
56
// IIFE - CDN
57
57
< script src = " https://cdn.jsdelivr.net/npm/[email protected] /dist/excel-builder.iife.js" > </
script >
58
+ <script >
59
+ const worksheet = ExcelBuilder .createWorksheet ();
60
+ < / script >
58
61
```
59
62
60
63
## Changelog
@@ -67,7 +70,7 @@ const { createWorksheet } = require('excel-builder-vanilla');
67
70
68
71
### Used by
69
72
70
- This fork was created mostly to support Tree Shaking (ESM) and update all its dependencies. It is used by a few other Open Source libraries that I also maintain:
73
+ This fork was created mostly to support Tree Shaking (ESM), provide TS Types and update all its dependencies. It is used by a few other Open Source libraries that I also maintain:
71
74
72
75
- [ Angular-Slickgrid] ( https://github.com/ghiscoding/Angular-Slickgrid )
73
76
- [ Aurelia-Slickgrid] ( https://github.com/ghiscoding/aurelia-slickgrid )
@@ -88,7 +91,7 @@ If you wish to contribute to the project, please follow these steps:
88
91
89
92
1 . clone the lib:
90
93
- ` git clone https://github.com/ghiscoding/excel-builder-vanilla `
91
- 2 . install with ** pnpm** from the root:
94
+ 2 . install it with ** pnpm** from the project root:
92
95
- ` pnpm install ` OR ` npx pnpm install `
93
96
3 . run a full TypeScript build
94
97
- ` pnpm run build ` OR ` npx pnpm run build `
@@ -97,12 +100,21 @@ If you wish to contribute to the project, please follow these steps:
97
100
98
101
#### Pull Request Contribution
99
102
100
- Before submitting a PR (pull request), please make sure that you followed these steps for your PR to succeed :
103
+ Before submitting a PR (pull request), please make sure that you followed these steps for a better chance of a successfull PR :
101
104
102
- 1 . make sure that you already ran ` pnpm install `
105
+ 1 . make sure that you have already executed ` pnpm install `
103
106
2 . run the Biome lint npm script (or use step 4)
104
107
- ` pnpm run biome:lint:write `
105
108
3 . run the Biome code formatting npm script (or use step 4)
106
109
- ` pnpm run biome:format:write `
107
- 4 . run a full Build (this will also run Biome format, so you could skip step 2)
110
+ 4 . run a full Build (this will also run Biome lint/ format, so you could skip step 2)
108
111
- ` pnpm run build `
112
+
113
+ ## Sponsors
114
+
115
+ <div >
116
+ <img class =" circle avatar-user " src =" https://avatars.githubusercontent.com/u/48218815?s=52& ; v=4 " width =" 40 " height =" 40 " alt =" @kevinburkett " />
117
+ <a href =" /kevinburkett " class =" Link " >
118
+ <span class="wb-break-word ml-2">kevinburkett</span>
119
+ </a >
120
+ </div >
0 commit comments