open-index/open-npm huggingface dataset:
npm package: @jakesch/utility
Description: Utility Package für Projekte von Jakob Eschler Design.
Author: Jakob Eschler
Latest version: 0.0.11

# JED-Utility Package

## Installation

### Development

    npm run build
    npm link

Im Projekt, wo das Package verwendet werden soll

    npm link @jed/utility

## JS

### Badges

Das `utility` package enthält Funktionen, um mit [shields.io](https://shields.io/) Badges zu arbeiten.

#### badgeBuild

Die Funktion `badgeBuild`erstellt ein `Object`, welches z.B. an die `Gitlab` API geschickt werden kann und einem Repository oder einer Gruppe hinzugefügt werden kann.

    import { badgeBuild } from "@jakesch/utility";

    const badge = badgeBuild = (
        name = The name for the badge,
        label = Override the default left-hand-side text
        message = The message for the badge
        linkUrl = Specify what clicking on the left/right of a badge should do
        labelColor = Background color of the left part
        color = Background color of the right part
        style = One of: flat (default), flat-square, plastic, for-the-badge, social
    );

    console.log(badge)

    {
        link_url: 'https://gitlab.com/jakob-eschler/data-scienc…izations/transactions',
        image_url: 'https://img.shields.io/badge/latest:%2520su…e&labelColor=lightgrey',
        name: 'latest%20pipeline'
    }

    badge.image_url:

<img src="https://img.shields.io/badge/latest:%2520success-23.7.2023%252010%2520Uhr-lightgreen?style=flat-square&labelColor=lightgrey%27">

## SCSS

Dieses Plugin enthält einige `SCCS` abstracts, die die Arbeit mit `SCCS` erleichtern sollen.

### Einbindung

Das Utility Partial (`scss/abstracts/utility.scss`) muss als erstes bzw. global eingebunden werden. Dies kann z.B. in der `vite.config.js` gemacht werden.

    export default defineConfig({
        css: {
            preprocessorOptions: {
                scss: {
                    additionalData: `
                        @import "jed-utility/src/assets/scss/utility.scss";
                    `
                }
            }
        }
    })

Die restlichen Abstracts (`scss/abstracts/abstracts.scss`) können dann im SCSS der Anwendung eingebunden werden:

    @import "jed-utility/src/assets/scss/abstracts.scss";

## WordPress

### Gutenberg Blocks

Um die Gutenberg Blocks zu nutzen muss die Block componente importiert werden.

    import Block from 'jed-utility'
    app.use(Block)