gravity-ui / nodekit Goto Github PK

At current time env is accessible everywhere in project (but used only in main module).

Proposal:

• Disallow env in eslint rules.
• Add 'resolve-options' helper (allow env here).
• Add to options all missed entities. For example const appInstallation = process.env.APP_INSTALLATION; can not be configured without env.
• Reverse default behavior for disableDotEnv
• Make more options accessible from env

Proposal+:

Looks like options.config is a flat object.
Maybe it should be top level param

constructor(options: InitOptions = {}) {}

constructor(options: InitOptions & AppConfig = {}) {}

So most part of configuration will be accessible from env

# appTracingEnabled
APP_TRACING_ENABLED=false

But I understand problems with appSensitiveKeys in this keys.

Most interested api looks like:

import {NodeKit, configure} from 'nodekit';

const nodekit = new NodeKit(configure({
  env: true,
  file: require.resolve('./config')
}));

Settings:

    telemetryChHost?: string;
    telemetryChPort?: string;
    telemetryChAuth?: string;
    telemetryChDatabase?: string;
    telemetryChTables?: {[name: string]: {[name: string]: 'number' | 'string' | 'timestamp'}};
    telemetryChBatchSize?: number;
    telemetryChBacklogSize?: number;
    telemetryChMirrorToLogs?: boolean;

Usage:

ctx.stats({...data});
ctx.stats(tableName, {...data});

• sensitive keys redacter
• is-true-env

Dynamic configs currently lack documentation, we should explain how to set up them and how they can be useful.

• logging
• tracing
• key-value storage
• call - success and failure states, sync and async

• Check CODEOWNERS
• Add pre-commit commit message checks
• Protect main branch and setup PR settings
• Configure GitHub actions for package releases
• Add existing changes to CHANGELOG
• Release 1.0.0