@docusaurus/logger
Advanced tools
Changelog
3.4.0 (2024-05-31)
create-docusaurus, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils-validation, docusaurus-utils
docusaurus-theme-translations
docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus
docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils
docusaurus-theme-search-algolia
contextualSearch: false setting (@ncoughlin)docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-utils
docusaurus-theme-translations
docusaurus
docusaurus-theme-classic, docusaurus-theme-common
docusaurus-plugin-content-docs, docusaurus
docusaurus-utils, docusaurus
docusaurus-theme-classic, docusaurus-theme-translations
<details> (@tats-u){<...>...</...>} if don't use Markdown in migra… (@tats-u)Readme
@docusaurus/loggerAn encapsulated logger for semantically formatting console messages.
It exports a single object as default export: logger. logger has the following properties:
redyellowgreenbolddim(msg: unknown) => string. Note that their implementations are not guaranteed. You should only care about their semantics.
path: formats a file path.url: formats a URL.name: formats an identifier.code: formats a code snippet.subdue: subdues the text.num: formats a number.interpolate function. It is a template literal tag. The syntax can be found below.console.log family, but only accepts one parameter) or template literal tags.
info: prints information.warn: prints a warning that should be paid attention to.error: prints an error (not necessarily halting the program) that signals significant problems.success: prints a success message.report function. It takes a ReportingSeverity value (ignore, log, warn, throw) and reports a message according to the severity.error formatterBeware that an error message, even when it doesn't hang the program, is likely going to cause confusion. When users inspect logs and find an [ERROR], even when the build succeeds, they will assume something is going wrong. Use it sparingly.
Docusaurus only uses logger.error when printing messages immediately before throwing an error, or when user has set the reporting severity of onBrokenLink, etc. to "error".
In addition, warn and error will color the entire message for better attention. If you are printing large blocks of help text about an error, better use logger.info.
The template literal tag evaluates the template and expressions embedded. interpolate returns a new string, while other logging functions prints it. Below is a typical usage:
import logger from '@docusaurus/logger';
logger.info`Hello name=${name}! You have number=${money} dollars. Here are the ${
items.length > 1 ? 'items' : 'item'
} on the shelf: ${items}
To buy anything, enter code=${'buy x'} where code=${'x'} is the item's name; to quit, press code=${'Ctrl + C'}.`;
An embedded expression is optionally preceded by a flag in the form [a-z]+= (a few lowercase letters, followed by an equals sign, directly preceding the embedded expression). If the expression is not preceded by any flag, it's printed out as-is. Otherwise, it's formatted with one of the formatters:
path=: pathurl=: urlname=: namecode=: codesubdue=: subduenumber=: numIf the expression is an array, it's formatted by `\n- ${array.join('\n- ')}\n` (note it automatically gets a leading line end). Each member is formatted by itself and the bullet is not formatted. So you would see the above message printed as:
FAQs
An encapsulated logger for semantically formatting console messages.
The npm package @docusaurus/logger receives a total of 288,954 weekly downloads. As such, @docusaurus/logger popularity was classified as popular.
We found that @docusaurus/logger demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.