@vscode-logging/types

@vscode-logging/types

Types used by @vscode-logging/logger extracted to a separate package to enable in-direct dependents to type check against the correct interfaces.

For example imagine a VSCode extension called Foo which uses an npm package called Bar as a dependency and Bar APIs can accept an optional logger implementation:

// Code in `Bar` npm package
// -------------------------------------------------------

// By defining the `IChildLogger` interface` in `@vscode-logging/types`
// `Bar` only depends (dev dependency) on the interface **not** the implementation.
import { IChildLogger } from "@vscode-logging/types";

export function add(lhs: number, rhs: number, logger: IChildLogger): number {
  logger.info("Entering <add> function with params:", { lhs: lhs, rhs: rhs });
  return lhs + rhs;
}

Installation

With npm:

• npm install @vscode-logging/types --save-dev

With Yarn:

• yarn add @vscode-logging/types --dev

Usage

As shown above, simply import the IChildLogger interface and use it to define the type of your injected logger implementation.

Support

Please open issues on github.

Contributing

See CONTRIBUTING.md.

License

Copyright (c) 2021 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.

Changelog

2.0.0 (2024-01-05)

Bug Fixes

• add .npmignore files to remove unneeded contents in published pkgs (998b1f8)
• convert timestamp format according to ISO-8601 (b4ab3e4)
• source Location Tracking not affecting ChildLoggers (72b151a), closes #15
• typo in the logging.level configuration description (#181) (c05b17d)
• update yarn.lock (#144) (33ec5ac)
• upgrade lodash version due to CVE-2021-23337 (c514c16)
• logger: vscode-logging/types package should be a dependency (e2ea6c7)

Features

• wrapper: remove dep to @types/vscode (#167) (b362e5c)
• logger wrapper package (#163) (fc6abc5)
• support console as log target (#109) (ea16211)
• logger: a memory leak when creating 9 or more ChildLogger's (#76) (482c708)
• aPI Fixes (dummy change to force minor version) (0fb0fb6)
• initial Commit (ee780af)

Reverts

• Revert "chore: include release number in release commit" (d9d9c68)

• Make OutputChannel optional. (#55) (b7fa564), closes #55 #55

BREAKING CHANGES

• wrapper: getConfigurations and onDidChangeConfiguration properties were removed from the configureLogger public API
• OutputChannel will not be created inside the logger as today. Alternatively, it will be added as an optional parameter. The VS Code Extension will be able to create the OutputChannel and send it to the logger as a parameter.