An open API service indexing awesome lists of open source software.

https://github.com/g43riko/gtools


https://github.com/g43riko/gtools

deno javascript typescript

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/G43riko/GTools/blob/master/LICENSE)
[![Actions status](https://github.com/G43riko/GTools/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/G43riko/GTools/actions)
![REPO SIZE](https://img.shields.io/github/repo-size/G43riko/GTools.svg?style=flat-square)
![CODE SIZE](https://img.shields.io/github/languages/code-size/G43riko/GTools.svg?style=flat-square)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/G43riko/GTools)](https://github.com/G43riko/GTools/pulse)
[![GitHub last commit](https://img.shields.io/github/last-commit/G43riko/GTools)](https://github.com/G43riko/GTools/commits/main)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=G43riko_GTools&metric=coverage)](https://sonarcloud.io/summary/new_code?id=G43riko_GTools)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=G43riko_GTools&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=G43riko_GTools)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=G43riko_GTools&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=G43riko_GTools)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=G43riko_GTools&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=G43riko_GTools)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=G43riko_GTools&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=G43riko_GTools)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=G43riko_GTools&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=G43riko_GTools)

# GTools

[![NPM](https://nodei.co/npm/gtools.png)](https://www.npmjs.com/package/gtools)

[Documentation](https://g43riko.github.io/GTools/)

## Scan docker

```bash
docker run \
--rm \
-e SONAR_SCANNER_OPTS="-Dsonar.projectKey=G43riko_GTools" \
-e SONAR_SCANNER_OPTS="-Dsonar.organization=g43riko" \
-e SONAR_SCANNER_OPTS="-Dsonar.javascript.lcov.reportPaths=coverage/lcov.info" \
-e SONAR_TOKEN=35e611231b768d371f22e880a31bbada5f9359d3 \
-v ".:/usr/src" \
sonarsource/sonar-scanner-cli
```

## Contents

- [GTools](#gtools)
- [Scan docker](#scan-docker)
- [Contents](#contents)
- [Installation](#installation)
- [NodeJS](#nodejs)
- [Browser](#browser)
- [List of methods](#list-of-methods)
- [Structure of src directory](#structure-of-src-directory)
- [Release steps](#release-steps)

## Installation

### NodeJS

run `npm install gtools`

```javascript
import { ArrayUtils } from "gtools";

const min = ArrayUtils.min([1, 2, 3]);
```

### Browser

```html


Test




const min = G.array.min([1, 2, 3]);

```

## List of methods

**TODO** ##Implements https://github.com/G43riko/JavaUtils/blob/master/GLib2/src/main/java/org/utils/QuadIterator.java
https://github.com/G43riko/JavaUtils/tree/master/GLib2/src/main/java/org/utils/noises
https://github.com/G43riko/JavaUtils/blob/master/GLib2/src/test/java/org/glib2/math/Bresenhams3D.java
https://github.com/G43riko/JavaUtils/blob/master/GLib2/src/main/java/org/utils/GeometryUtils.java

## Structure of src directory

- [index](src/index.html)
- [MockData](src/MockData.ts)
- _[components](src/components)_
- [FileManager](src/components/file-manager.ts)
- [paginator](src/components/paginator.ts)
- _[dom](src/dom)_
- [CanvasManager](src/dom/canvas-manager.ts)
- [CanvasUtils](src/dom/canvas-utils.ts)
- [Checkers](src/dom/deprecated/Checkers.ts)
- [ElementBuilder](src/dom/element-builder.ts)
- [DomGet](src/dom/dom-get.ts)
- _[enums](src/enums)_
- [encodings](src/enums/enodings.enum.ts)
- [file-types](src/enums/file-types.enum.ts)
- [http-status-codes](src/enums/http-status-codes.enum.ts)
- [keys](src/enums/keys.enum.ts)
- _[errors](src/errors)_
- [GLogger](src/components/logger/g-logger.ts)
- [NotBrowserException](src/errors/not-browser.exception.ts)
- [NullPointerException](src/errors/null-pointer.exception.ts)
- [WrongParameterException](src/errors/wrong-parameter.exception.ts)
- [WrongTypeException](src/errors/wrong-type.exception.ts)
- _[math](src/math)_
- [Vector2f](src/math/vector2f.ts)
- _[models](src/models)_
- [gender](src/models/gender.ts)
- _[utils](src/utils)_
- [ArrayUtils](src/utils/deprecated/ArrayUtils.ts)
- [DomUtils](src/utils/DomUtils.ts)
- [FileUtils](src/utils/FileUtils.ts)
- [MathUtils](src/utils/deprecated/MathUtils.ts)
- [MiscUtils](src/utils/deprecated/MiscUtils.ts)
- [ObjectUtils](src/utils/deprecated/ObjectUtils.ts)
- [ProcessUtils](src/utils/deprecated/ProcessUtils.ts)
- [Runtime](src/utils/Runtime.ts)
- [StringCheckers](src/utils/deprecated/StringCheckers.ts)
- [StringUtils](src/utils/deprecated/StringUtils.ts)
- [TimeUtils](src/utils/time-utils.ts)

## Release steps

1. change version in `package.json`
2. run all tests with `npm test`
3. run `npm run release`
4. run `npm publish`
5. commit and push data to [github](https://github.com/G43riko/GTools)
6. wait for the build to complete on [travis](https://travis-ci.org/G43riko/GTools) and check for success
7. create new release on [github](https://github.com/G43riko/GTools/releases)