web-csv-toolbox 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +84 -14
  2. package/package.json +5 -3
package/README.md CHANGED
@@ -1,6 +1,5 @@
1
1
  <div align="center">
2
2
 
3
- [![Node.js CI](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/node.js.yaml/badge.svg)](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/node.js.yaml)
4
3
  [![npm version](https://badge.fury.io/js/web-csv-toolbox.svg)](https://badge.fury.io/js/web-csv-toolbox)
5
4
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
5
  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
@@ -38,9 +37,8 @@ A CSV Toolbox utilizing Web Standard APIs.
38
37
  - Using only Web Standards APIs.
39
38
  - 💪 **Property-based testing.**
40
39
  - Using [fast-check](https://fast-check.dev/) and [vitest](https://vitest.dev).
41
- - ✅ **_To Be Tested_** **Cross-platform.**
40
+ - ✅ **Cross-platform.**
42
41
  - Works on browsers, Node.js, and Deno.
43
- - Only web standard APIs are used, so it should work with these runtimes.
44
42
 
45
43
  ## Key Features 📗
46
44
 
@@ -58,6 +56,10 @@ A CSV Toolbox utilizing Web Standard APIs.
58
56
 
59
57
  ## Installation 📥
60
58
 
59
+ ### With Package manager 📦
60
+
61
+ This package can then be installed using a package manager.
62
+
61
63
  ```sh
62
64
  # Install with npm
63
65
  $ npm install web-csv-toolbox
@@ -67,6 +69,50 @@ $ yarn add web-csv-toolbox
67
69
  $ pnpm add web-csv-toolbox
68
70
  ```
69
71
 
72
+ ### From CDN (unpkg.com) 🌐
73
+
74
+ #### UMD Style 🔄
75
+
76
+ ```html
77
+ <script src="https://unpkg.com/web-csv-toolbox"></script>
78
+ <script>
79
+ const csv = `name,age
80
+ Alice,42
81
+ Bob,69`;
82
+
83
+ (async function () {
84
+ for await (const record of CSV.parse(csv)) {
85
+ console.log(record);
86
+ }
87
+ })();
88
+ </script>
89
+ ```
90
+
91
+
92
+ #### ESModule Style 📦
93
+
94
+ ```html
95
+ <script type="module">
96
+ import { parse } from 'https://unpkg.com/web-csv-toolbox/lib/index.js';
97
+
98
+ const csv = `name,age
99
+ Alice,42
100
+ Bob,69`;
101
+
102
+ for await (const record of parse(csv)) {
103
+ console.log(record);
104
+ }
105
+ </script>
106
+ ```
107
+
108
+ #### Deno 🦕
109
+
110
+ You can install and use the package by specifying the following:
111
+
112
+ ```js
113
+ import { parse } from "npm:web-csv-toolbox";
114
+ ```
115
+
70
116
  ## Usage 📘
71
117
 
72
118
  ### Parsing CSV files from strings
@@ -158,6 +204,30 @@ for await (const record of parse(csv, { headers: ['name', 'age'] })) {
158
204
  // { name: 'Bob', age: '69' }
159
205
  ```
160
206
 
207
+ ## Supported Runtimes 💻
208
+
209
+ ### Works on Node.js [![Node.js CI](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/node.js.yaml/badge.svg)](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/node.js.yaml)
210
+
211
+ | Versions | Status |
212
+ | -------- | ------ |
213
+ | 20.x | ✅ |
214
+ | 18.x | ✅ |
215
+
216
+
217
+ ### Works on Browser [![Browsers CI](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/browsers.yaml/badge.svg)](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/browsers.yaml)
218
+
219
+ | OS | Chrome | FireFox | Default |
220
+ | ------- | ------ | ------- | ------------- |
221
+ | Windows | ✅ | ✅ | ✅ (Edge) |
222
+ | macos | ✅ | ✅ | ⬜ (Safari *) |
223
+ | Linux | ✅ | ✅ | - |
224
+
225
+ > **\* To Be Tested**: [I couldn't launch Safari in headless mode](https://github.com/vitest-dev/vitest/blob/main/packages/browser/src/node/providers/webdriver.ts#L39-L41) on GitHub Actions, so I couldn't verify it, but it probably works.
226
+
227
+ ### Others
228
+
229
+ - Verify that JavaScript is executable on the Deno. [![Deno CI](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/deno.yaml/badge.svg)](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/deno.yaml)
230
+
161
231
  ## APIs 🧑‍💻
162
232
 
163
233
  ### High-level APIs 🚀
@@ -204,20 +274,20 @@ ideal for developers looking for in-depth control and flexibility.
204
274
 
205
275
  ### Common Options ⚙️
206
276
 
207
- | Option | Description | Default | Notes |
208
- | -------------- | ------------------------------------- | ----------- | ----- |
209
- | `delimiter` | Character to separate fields | `,` | |
210
- | `quotation` | Character used for quoting fields | `"` | |
211
- | `headers` | Custom headers for the parsed records | First row | If not provided, the first row is used as headers |
277
+ | Option | Description | Default | Notes |
278
+ | ----------- | ------------------------------------- | --------- | ------------------------------------------------- |
279
+ | `delimiter` | Character to separate fields | `,` | |
280
+ | `quotation` | Character used for quoting fields | `"` | |
281
+ | `headers` | Custom headers for the parsed records | First row | If not provided, the first row is used as headers |
212
282
 
213
283
  ### Advanced Options (Binary-Specific) 🧬
214
284
 
215
- | Option | Description | Default | Notes |
216
- | --------------- | ------------------------------------------------- | --------- | ---------------------- |
217
- | `charset` | Character encoding for binary CSV inputs | `utf-8` | See [Encoding API Compatibility](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API/Encodings) for the encoding formats that can be specified. |
218
- | `decompression` | Decompression algorithm for compressed CSV inputs | | See [DecompressionStream Compatibility](https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream#browser_compatibilit). |
219
- | `ignoreBOM` | Whether to ignore Byte Order Mark (BOM) | `false` | See [TextDecoderOptions.ignoreBOM](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoderStream/ignoreBOM) for more information about the BOM. |
220
- | `fatal` | Throw an error on invalid characters | `false` | See [TextDecoderOptions.fatal](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoderStream/fatal) for more information. |
285
+ | Option | Description | Default | Notes |
286
+ | --------------- | ------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
287
+ | `charset` | Character encoding for binary CSV inputs | `utf-8` | See [Encoding API Compatibility](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API/Encodings) for the encoding formats that can be specified. |
288
+ | `decompression` | Decompression algorithm for compressed CSV inputs | | See [DecompressionStream Compatibility](https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream#browser_compatibilit). |
289
+ | `ignoreBOM` | Whether to ignore Byte Order Mark (BOM) | `false` | See [TextDecoderOptions.ignoreBOM](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoderStream/ignoreBOM) for more information about the BOM. |
290
+ | `fatal` | Throw an error on invalid characters | `false` | See [TextDecoderOptions.fatal](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoderStream/fatal) for more information. |
221
291
 
222
292
  ## How to Contribute 💪
223
293
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "web-csv-toolbox",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "A CSV Toolbox utilizing Web Standard APIs.",
5
5
  "type": "module",
6
6
  "main": "lib/index.js",
@@ -24,6 +24,7 @@
24
24
  "scripts": {
25
25
  "doc": "typedoc",
26
26
  "test": "vitest",
27
+ "test:browser": "vitest --browser",
27
28
  "format": "biome format . --write",
28
29
  "lint": "biome lint .",
29
30
  "check": "biome check src --apply",
@@ -53,9 +54,9 @@
53
54
  "@changesets/cli": "^2.27.1",
54
55
  "@fast-check/vitest": "^0.0.9",
55
56
  "@rollup/plugin-terser": "^0.4.4",
57
+ "@vitest/browser": "^1.1.0",
56
58
  "changesets-github-release": "^0.1.0",
57
59
  "husky": "^8.0.0",
58
- "jsdom": "^23.0.1",
59
60
  "lint-staged": "^15.2.0",
60
61
  "rollup": "^4.9.1",
61
62
  "rollup-plugin-delete": "^2.0.0",
@@ -64,6 +65,7 @@
64
65
  "typedoc": "^0.25.4",
65
66
  "typedoc-plugin-mdn-links": "^3.1.9",
66
67
  "typescript": "^5.3.2",
67
- "vitest": "^1.1.0"
68
+ "vitest": "^1.1.0",
69
+ "webdriverio": "^8.27.0"
68
70
  }
69
71
  }