Compare commits

..

No commits in common. "master" and "v1.0.20" have entirely different histories.

16 changed files with 1711 additions and 4652 deletions

4
.gitignore vendored
View File

@ -15,6 +15,8 @@ node_modules/
# builds # builds
dist/ dist/
dist_*/ dist_web/
dist_serve/
dist_ts_web/
# custom # custom

View File

@ -4,7 +4,7 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache: cache:
paths: paths:
- .npmci_cache/ - .npmci_cache/
key: '$CI_BUILD_STAGE' key: "$CI_BUILD_STAGE"
stages: stages:
- security - security
@ -12,71 +12,64 @@ stages:
- release - release
- metadata - metadata
before_script:
- npm install -g @shipzone/npmci
# ==================== # ====================
# security stage # security stage
# ==================== # ====================
auditProductionDependencies: mirror:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci git mirror
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags: tags:
- docker - docker
allow_failure: true - notpriv
auditDevDependencies: snyk:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci command npm install -g snyk
- npmci command npm install --ignore-scripts - npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org - npmci command snyk test
- npmci command npm audit --audit-level=high --only=dev
tags: tags:
- docker - docker
allow_failure: true - notpriv
# ==================== # ====================
# test stage # test stage
# ==================== # ====================
testStable: testLTS:
stage: test stage: test
script: script:
- npmci npm prepare - npmci npm prepare
- npmci node install stable - npmci node install lts
- npmci npm install - npmci npm install
- npmci npm test - npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- notpriv
testBuild: testBuild:
stage: test stage: test
script: script:
- npmci npm prepare - npmci npm prepare
- npmci node install stable - npmci node install lts
- npmci npm install - npmci npm install
- npmci command npm run build - npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- notpriv
release: release:
stage: release stage: release
script: script:
- npmci node install stable - npmci node install lts
- npmci npm publish - npmci npm publish
only: only:
- tags - tags
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
@ -86,14 +79,11 @@ release:
codequality: codequality:
stage: metadata stage: metadata
allow_failure: true allow_failure: true
only:
- tags
script: script:
- npmci command npm install -g typescript - npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install - npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags: tags:
- lossless
- docker - docker
- priv - priv
@ -104,19 +94,18 @@ trigger:
only: only:
- tags - tags
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
pages: pages:
image: hosttoday/ht-docker-node:npmci
stage: metadata stage: metadata
script: script:
- npmci node install stable - npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command npm run buildDocs - npmci command tsdoc
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
only: only:

4
.snyk Normal file
View File

@ -0,0 +1,4 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.12.0
ignore: {}
patch: {}

11
.vscode/launch.json vendored
View File

@ -1,11 +0,0 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"type": "node-terminal"
}
]
}

26
.vscode/settings.json vendored
View File

@ -1,26 +0,0 @@
{
"json.schemas": [
{
"fileMatch": ["/npmextra.json"],
"schema": {
"type": "object",
"properties": {
"npmci": {
"type": "object",
"description": "settings for npmci"
},
"gitzone": {
"type": "object",
"description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
}
}
}
}
]
}

View File

@ -4,25 +4,13 @@
"npmAccessLevel": "public" "npmAccessLevel": "public"
}, },
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "code.foss.global", "githost": "gitlab.com",
"gitscope": "push.rocks", "gitscope": "pushrocks",
"gitrepo": "smartcsv", "gitrepo": "smartcsv",
"description": "A module for handling CSV data compliant with Gitzone standard.", "shortDescription": "handle csv data | gitzone standard compliant",
"npmPackagename": "@push.rocks/smartcsv", "npmPackagename": "@pushrocks/smartcsv",
"license": "MIT", "license": "MIT"
"keywords": [ }
"CSV",
"data parsing",
"data conversion",
"TypeScript",
"CSV manipulation",
"CSV to JSON"
]
}
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
} }
} }

1589
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,56 +1,37 @@
{ {
"name": "@push.rocks/smartcsv", "name": "@pushrocks/smartcsv",
"version": "2.0.2", "version": "1.0.20",
"private": false, "private": false,
"description": "A module for handling CSV data compliant with Gitzone standard.", "description": "handle csv data | gitzone standard compliant",
"main": "dist_ts/index.js", "main": "dist/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist/index.d.ts",
"type": "module",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/)",
"build": "(tsbuild --allowimplicitany)", "build": "(tsbuild)",
"buildDocs": "tsdoc" "format": "(gitzone format)"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.65", "@gitzone/tsbuild": "^2.1.17",
"@gitzone/tsrun": "^1.2.37", "@gitzone/tsrun": "^1.2.8",
"@gitzone/tstest": "^1.0.73", "@gitzone/tstest": "^1.0.28",
"@pushrocks/smartfile": "^10.0.4", "@pushrocks/smartfile": "^7.0.6",
"@pushrocks/tapbundle": "^5.0.4", "@pushrocks/tapbundle": "^3.2.0",
"@types/node": "^18.6.4" "@types/node": "^12.12.17"
}, },
"dependencies": { "dependencies": {
"@pushrocks/smartpromise": "^3.1.7", "@pushrocks/smartpromise": "^3.0.6",
"@pushrocks/smartstring": "^4.0.2" "@pushrocks/smartstring": "^3.0.17"
}, },
"files": [ "files": [
"ts/**/*", "ts/*",
"ts_web/**/*", "ts_web/*",
"dist/**/*", "dist/*",
"dist_*/**/*", "dist_web/*",
"dist_ts/**/*", "assets/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
], ]
"browserslist": [
"last 1 chrome versions"
],
"keywords": [
"CSV",
"data parsing",
"data conversion",
"TypeScript",
"CSV manipulation",
"CSV to JSON"
],
"homepage": "https://code.foss.global/push.rocks/smartcsv",
"repository": {
"type": "git",
"url": "https://code.foss.global/push.rocks/smartcsv.git"
}
} }

4341
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -1 +0,0 @@

128
readme.md
View File

@ -1,118 +1,26 @@
# @push.rocks/smartcsv # @pushrocks/smartcsv
handle csv data | gitzone standard compliant handle csv data | gitzone standard compliant
## Install ## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartcsv)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartcsv)
* [github.com (source mirror)](https://github.com/pushrocks/smartcsv)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartcsv/)
To install `@push.rocks/smartcsv`, use the following command with npm: ## Status for master
[![build status](https://gitlab.com/pushrocks/smartcsv/badges/master/build.svg)](https://gitlab.com/pushrocks/smartcsv/commits/master)
```sh [![coverage report](https://gitlab.com/pushrocks/smartcsv/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartcsv/commits/master)
npm install @push.rocks/smartcsv --save [![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartcsv.svg)](https://www.npmjs.com/package/@pushrocks/smartcsv)
``` [![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartcsv/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartcsv)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Or, if you prefer using Yarn: [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
```sh
yarn add @push.rocks/smartcsv
```
## Usage ## Usage
`@push.rocks/smartcsv` is a powerful library designed for handling CSV data efficiently and in a developer-friendly manner. This document will guide you through various use cases and demonstrate the flexibility and capabilities of `@push.rocks/smartcsv`. For further information read the linked docs at the top of this readme.
### Importing the Module > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
First, import `Csv` from the `@push.rocks/smartcsv` package into your TypeScript file: [![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
```typescript
import { Csv } from '@push.rocks/smartcsv';
```
### Creating a CSV Instance from a String
You can create a `Csv` instance directly from a string. This is particularly useful when you have CSV data as a string from a file or an API response:
```typescript
const csvString = `Name, Age, Occupation\nJohn Doe, 28, Software Developer\nJane Smith, 32, Data Scientist`;
const csvOptions = {
headers: true, // indicates the first row contains headers
unquote: true, // unquote values if necessary
trimSpace: true, // trim spaces around values
removeBomMarkers: true // remove BOM markers if present
};
const csvInstance = await Csv.createCsvFromString(csvString, csvOptions);
```
### Exporting CSV Data as JSON
Once you have a `Csv` instance, you can convert the CSV data into JSON objects for easier manipulation and access:
```typescript
const jsonData = await csvInstance.exportAsObject();
console.log(jsonData);
```
This will output:
```json
[
{ "Name": "John Doe", "Age": "28", "Occupation": "Software Developer" },
{ "Name": "Jane Smith", "Age": "32", "Occupation": "Data Scientist" }
]
```
### Creating a CSV String from an Array of Objects
If you have an array of objects and wish to convert it into a CSV string, `@push.rocks/smartcsv` offers a straightforward approach:
```typescript
const arrayOfObjects = [
{ Name: "John Doe", Age: 28, Occupation: "Software Developer" },
{ Name: "Jane Smith", Age: 32, Occupation: "Data Scientist" }
];
const csvString = await Csv.createCsvStringFromArray(arrayOfObjects);
console.log(csvString);
```
This will generate a CSV string that represents the array of objects provided.
### Advanced Usage
#### Custom Separator Detection
By default, `@push.rocks/smartcsv` intelligently detects the separator used in the input CSV data (either a comma `,` or a semicolon `;`). You can rely on this automatic detection or specify preferred options for finer control over how your CSV data is handled.
#### Handling Quotes and BOM Markers
The library is capable of processing CSV files that include quoted fields, optionally removing quotes where necessary. Similarly, it can handle Byte Order Mark (BOM) markers at the start of UTF-8 encoded files, ensuring that the text is interpreted correctly.
#### Trimming Spaces
For data cleanliness, `@push.rocks/smartcsv` can trim leading and trailing spaces from values in the CSV, ensuring that the resulting data is neat and uniform.
### Conclusion
`@push.rocks/smartcsv` offers a comprehensive set of features for working with CSV data in TypeScript, providing flexibility, ease of use, and powerful data manipulation capabilities. Whether you're importing CSV data from a file, converting JSON to CSV, or manipulating CSV strings directly in your application, `@push.rocks/smartcsv` has you covered.
For detailed API documentation, please refer to the [official documentation](https://pushrocks.gitlab.io/smartcsv/).
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

View File

@ -1,12 +1,14 @@
// tslint:disable-next-line:no-implicit-dependencies
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import * as smartcsv from '../ts/index.js'; import * as smartcsv from '../ts/index';
// tslint:disable-next-line:no-implicit-dependencies
import * as smartfile from '@pushrocks/smartfile'; import * as smartfile from '@pushrocks/smartfile';
let fileString: string; let fileString: string;
let testCsv: smartcsv.Csv; let testCsv: smartcsv.Csv;
tap.test('should read a file', async (tools) => { tap.test('should read a file', async tools => {
fileString = smartfile.fs.toStringSync('./test/sample.csv'); fileString = smartfile.fs.toStringSync('./test/sample.csv');
}); });
@ -19,7 +21,7 @@ tap.test('should create a valid csv', async () => {
tap.test('should create a valid csv string', async () => { tap.test('should create a valid csv string', async () => {
const createdCsvString = await smartcsv.Csv.createCsvStringFromArray([ const createdCsvString = await smartcsv.Csv.createCsvStringFromArray([
{ wow: 'hi', wow2: 'there' }, { wow: 'hi', wow2: 'there' },
{ wow: 'really', wow3: 'yes' }, { wow: 'really', wow3: 'yes' }
]); ]);
console.log(createdCsvString); console.log(createdCsvString);
}); });

View File

@ -1,8 +0,0 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@pushrocks/smartcsv',
version: '2.0.2',
description: 'handle csv data | gitzone standard compliant'
}

View File

@ -1,10 +1,8 @@
import * as plugins from './smartcsv.plugins.js'; import * as plugins from './smartcsv.plugins';
export interface ICsvConstructorOptions { export interface ICsvConstructorOptions {
headers: boolean; headers: boolean;
unquote?: boolean; unquote?: boolean;
trimSpace?: boolean;
removeBomMarkers?: boolean;
} }
export class Csv { export class Csv {
@ -61,24 +59,16 @@ export class Csv {
public options: ICsvConstructorOptions = { public options: ICsvConstructorOptions = {
headers: true, headers: true,
unquote: true, unquote: true
trimSpace: true,
removeBomMarkers: true,
}; };
constructor(csvStringArg: string, optionsArg: ICsvConstructorOptions) { constructor(csvStringArg: string, optionsArg: ICsvConstructorOptions) {
this.options = { this.options = {
...this.options, ...this.options,
...optionsArg, ...optionsArg
}; };
let csvStringToParse = csvStringArg; let csvStringToParse = csvStringArg;
if (this.options.removeBomMarkers) {
csvStringToParse = csvStringToParse.replace(/^\uFEFF/, '');
}
// Quotes allow separators to be contained in quoted strings.
// To preserve them, when unquoting, we convert everything in between to base64 here
if (this.options.unquote) { if (this.options.unquote) {
csvStringToParse = csvStringToParse.replace( csvStringToParse = csvStringToParse.replace(
/"(.*?)"/gi, /"(.*?)"/gi,
@ -159,13 +149,6 @@ export class Csv {
} }
this.headers = unquotedHeaders; this.headers = unquotedHeaders;
} }
if (this.options.trimSpace) {
const trimmedHeaders = [];
for (const header of this.headers) {
trimmedHeaders.push(header.trim());
}
this.headers = trimmedHeaders;
}
} }
return this.headers; return this.headers;
} }
@ -182,9 +165,6 @@ export class Csv {
.replace(/['"]+/g, '') .replace(/['"]+/g, '')
.replace(/['"]+/g, ''); .replace(/['"]+/g, '');
} }
if (this.options.trimSpace) {
value = value.trim();
}
resultJson[this.headers[i]] = value; resultJson[this.headers[i]] = value;
} }
return resultJson; return resultJson;

View File

@ -1,14 +0,0 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}

17
tslint.json Normal file
View File

@ -0,0 +1,17 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}