max-private-npm-package

Ein kleines Node.js Utility-Package für Discord-Projekte:

• übersetzt häufige Discord API Error-Codes in lesbare Meldungen
• bietet einen farbigen Logger für strukturierte Konsolenausgaben
• enthält optional ein Terminal-Interface für laufende Prozesse
• enthält professionelle Runtime-Checks wie bei einem Build-Tool
• funktioniert mit CommonJS, ESM, TypeScript und Subpath-Imports

Installation

npm install max-private-npm-package

CommonJS

const { logger, discordError, runtimeChecks, terminal, startAll } = require('max-private-npm-package');

runtimeChecks.runRuntimeChecks();
discordError.init();
logger.success('Bot ist bereit.', 'BOT');

ESM

import tools, { logger, discordError, runtimeChecks, terminal, startAll } from 'max-private-npm-package';

runtimeChecks.runRuntimeChecks();
discordError.init();
logger.info('Discord Error Translator aktiv.', 'INIT');

TypeScript

import { logger, discordError } from 'max-private-npm-package';

discordError.logFriendlyError(50013, {
  message: 'Missing Permissions'
});

logger.warn('Prüfe Bot-Rechte.', 'DISCORD');

Subpath-Imports

const logger = require('max-private-npm-package/logger');

import logger from 'max-private-npm-package/logger';
import discordError from 'max-private-npm-package/discord-errors';
import runtimeChecks from 'max-private-npm-package/runtime-checks';
import terminal from 'max-private-npm-package/terminal';

API

logger

• logger.info(message, context?)
• logger.success(message, context?)
• logger.warn(message, context?)
• logger.error(message, context?)
• logger.divider()
• logger.getTimestamp()

discordError

• discordError.init()
• discordError.logFriendlyError(code, originalError?)
• discordError.errorMap

terminal

• terminal.initTerminal()

runtimeChecks

• runtimeChecks.runRuntimeChecks(options?)
• runtimeChecks.formatRuntimeReport(report)
• runtimeChecks.printRuntimeReport(report, output?)
• runtimeChecks.RuntimeCheckError

const { runtimeChecks } = require('max-private-npm-package');

const report = runtimeChecks.runRuntimeChecks({
  strict: false
});

if (!report.ok) {
  process.exit(1);
}

startAll()

Führt zuerst Runtime-Checks aus und startet danach Error-Translator, Terminal und Logger gemeinsam.

const { startAll } = require('max-private-npm-package');

startAll();

Unterstützte Import-Arten

| Art | Status | | --- | --- | | require(...) | unterstützt | | import ... from | unterstützt | | TypeScript Types | unterstützt | | Default Import | unterstützt | | Named Import | unterstützt | | Subpath Import | unterstützt | | Runtime Checks | unterstützt |

Entwicklung

npm test
npm run runtime:check
npm run pack:dry-run