npmpackage.info

proc-log

just emit 'log' events on the process object

5.0.0

ISC

JavaScript

667.00 B

945,271,350 6.8

Installations

npm install proc-log

Pull Requests

Open

1

Total

102

Closed

50

Merged

51

Issues

Open

0

Total

2

Closed

2

Releases

v5.0.0

Published on 05 Sept 2024

v4.2.0

Published on 16 Apr 2024

v4.1.0

Published on 15 Apr 2024

v4.0.0

Published on 12 Apr 2024

v3.0.0

Published on 14 Oct 2022

v2.0.1

Published on 28 Mar 2022

View all 7 releases

Developer

npm

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

^18.17.0 || >=20.5.0

Typescript Support

No

Node Version

22.8.0

NPM Version

10.8.3 Statistics

10 Stars

92 Commits

4 Forks

8 Watching

2 Branches

71 Contributors

Updated on 23 Nov 2024

Bundle Size

2.12 kB

Minified

667.00 B

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

945,271,350

Last day

2.5%

3,439,661

Compared to previous day

Last week

18,024,769

Compared to previous week

Last month

12.9%

72,133,371

Compared to previous month

Last year

165.4%

628,718,784

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@npmcli/eslint-config @npmcli/template-oss tap

Versions

proc-log

Emits events on the process object which a listener can consume and print to the terminal or log file.

This is used by various modules within the npm CLI stack in order to send log events that can be consumed by a listener on the process object.

Currently emits log, output, input, and time events.

API

1const { log, output, input, time } = require('proc-log')

output

output.standard(...args) calls process.emit('output', 'standard', ...args)

This is for general standard output. Consumers will typically show this on stdout (after optionally formatting or filtering it).
output.error(...args) calls process.emit('output', 'error', ...args)

This is for general error output. Consumers will typically show this on stderr (after optionally formatting or filtering it).
output.buffer(...args) calls process.emit('output', 'buffer', ...args)

This is for buffered output. Consumers will typically buffer this until they are ready to display.
output.flush(...args) calls process.emit('output', 'flush', ...args)

This is to indicate that the output buffer should be flushed.
output.LEVELS an array of strings of all output method names

log

log.error(...args) calls process.emit('log', 'error', ...args)

The highest log level. For printing extremely serious errors that indicate something went wrong.
log.warn(...args) calls process.emit('log', 'warn', ...args)

A fairly high log level. Things that the user needs to be aware of, but which won't necessarily cause improper functioning of the system.
log.notice(...args) calls process.emit('log', 'notice', ...args)

Notices which are important, but not necessarily dangerous or a cause for excess concern.
log.info(...args) calls process.emit('log', 'info', ...args)

Informative messages that may benefit the user, but aren't particularly important.
log.verbose(...args) calls process.emit('log', 'verbose', ...args)

Noisy output that is more detail that most users will care about.
log.silly(...args) calls process.emit('log', 'silly', ...args)

Extremely noisy excessive logging messages that are typically only useful for debugging.
log.http(...args) calls process.emit('log', 'http', ...args)

Information about HTTP requests made and/or completed.
log.timing(...args) calls process.emit('log', 'timing', ...args)

Timing information.
log.pause() calls process.emit('log', 'pause')

Used to tell the consumer to stop printing messages.
log.resume() calls process.emit('log', 'resume')

Used to tell the consumer that it is ok to print messages again.
log.LEVELS an array of strings of all log method names

input

input.start(fn?) calls process.emit('input', 'start')

Used to tell the consumer that the terminal is going to begin reading user input. Returns a function that will call input.end() for convenience.

This also takes an optional callback which will run input.end() on its completion. If the callback returns a Promise then input.end() will be run during finally().
input.end() calls process.emit('input', 'end')

Used to tell the consumer that the terminal has stopped reading user input.
input.read(...args): Promise calls process.emit('input', 'read', resolve, reject, ...args)

Used to tell the consumer that the terminal is reading user input and returns a Promise that the producer can await until the consumer has finished its async action.

This emits resolve and reject functions (in addition to all passed in arguments) which the consumer must use to resolve the returned Promise.

time

time.start(timerName, fn?) calls process.emit('time', 'start', 'timerName')

Used to start a timer with the specified name. Returns a function that will call time.end() for convenience.

This also takes an optional callback which will run time.end() on its completion. If the callback returns a Promise then time.end() will be run during finally().
time.end(timerName) calls process.emit('time', 'end', timeName)

Used to tell the consumer to stop a timer with the specified name.

Examples

log

Every log method calls process.emit('log', level, ...otherArgs) internally. So in order to consume those events you need to do process.on('log', fn).

Colorize based on level

Here's an example of how to consume proc-log log events and colorize them based on level:

1const chalk = require('chalk')
2
3process.on('log', (level, ...args) => {
4  if (level === 'error') {
5    console.log(chalk.red(level), ...args)
6  } else {
7    console.log(chalk.blue(level), ...args)
8  }
9})

Pause and resume

log.pause and log.resume are included so you have the ability to tell your consumer that you want to pause or resume your display of logs. In the npm CLI we use this to buffer all logs on init until we know the correct loglevel to display. But we also setup a second handler that writes everything to a file even if paused.

1let paused = true
2const buffer = []
3
4// this handler will buffer and replay logs only after `procLog.resume()` is called
5process.on('log', (level, ...args) => {
6  if (level === 'resume') {
7    buffer.forEach((item) => console.log(...item))
8    paused = false
9    return
10  } 
11
12  if (paused) {
13    buffer.push([level, ...args])
14  } else {
15    console.log(level, ...args)
16  }
17})
18
19// this handler will write everything to a file
20process.on('log', (...args) => {
21  fs.appendFileSync('debug.log', args.join(' '))
22})

input

`start` and `end`

producer.js

1const { output, input } = require('proc-log')
2const { readFromUserInput } = require('./my-read')
3
4// Using callback passed to `start`
5try {
6  const res = await input.start(
7    readFromUserInput({ prompt: 'OK?', default: 'y' })
8  )
9  output.standard(`User said ${res}`)
10} catch (err) {
11  output.error(`User cancelled: ${err}`)
12}
13
14// Manually calling `start` and `end`
15try {
16  input.start()
17  const res = await readFromUserInput({ prompt: 'OK?', default: 'y' })
18  output.standard(`User said ${res}`)
19} catch (err) {
20  output.error(`User cancelled: ${err}`)
21} finally {
22  input.end()
23}

consumer.js

1const { read } = require('read')
2
3process.on('input', (level) => {
4  if (level === 'start') {
5    // Hide UI to make room for user input being read
6  } else if (level === 'end') {
7    // Restore UI now that reading is ended
8  }
9})

Using `read` to call `read()`

producer.js

1const { output, input } = require('proc-log')
2
3try {
4  const res = await input.read({ prompt: 'OK?', default: 'y' })
5  output.standard(`User said ${res}`)
6} catch (err) {
7  output.error(`User cancelled: ${err}`)
8}

consumer.js

1const { read } = require('read')
2
3process.on('input', (level, ...args) => {
4  if (level === 'read') {
5    const [res, rej, opts] = args
6    read(opts).then(res).catch(rej)
7  }
8})

No vulnerabilities found.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

9

SAST

Determines if the project uses static code analysis.

6

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/audit.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/audit.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/audit.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/audit.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-release.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/ci-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-release.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/ci-release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-release.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/ci-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-release.yml:112: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/ci-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-release.yml:128: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/ci-release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-release.yml:144: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/ci-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/post-dependabot.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/post-dependabot.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/post-dependabot.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/post-dependabot.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/post-dependabot.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/post-dependabot.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pull-request.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/pull-request.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pull-request.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/pull-request.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-integration.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release-integration.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-integration.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release-integration.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:199: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:218: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:236: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:274: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:283: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:303: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:110: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:119: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:136: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:162: update your workflow using https://app.stepsecurity.io/secureworkflow/npm/proc-log/release.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/audit.yml:38
Warn: npmCommand not pinned by hash: .github/workflows/ci-release.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:42
Warn: npmCommand not pinned by hash: .github/workflows/post-dependabot.yml:39
Warn: npmCommand not pinned by hash: .github/workflows/pull-request.yml:42
Warn: npmCommand not pinned by hash: .github/workflows/release-integration.yml:52
Warn: npmCommand not pinned by hash: .github/workflows/release.yml:50
Warn: npmCommand not pinned by hash: .github/workflows/release.yml:130
Info: 0 out of 26 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 12 third-party GitHubAction dependencies pinned
Info: 0 out of 8 npmCommand dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.8

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to proc-log

@types/proc-log

3.0.4

TypeScript definitions for proc-log

spawnd

10.1.4

Spawn a dependent child process.

@devicefarmer/adbkit-logcat

2.1.3

A Node.js interface for working with Android's logcat output.

@stroncium/procfs

1.2.1

Zero dependency library for reading and parsing various files from `procfs` for Node.js, implemented in pure JS.

proc-log

Installations

Pull Requests

1

102

50

51

Issues

0

2

2

Releases

Developer

npm

Developer Guide

CommonJS

^18.17.0 || >=20.5.0

No

22.8.0

10.8.3

Statistics

Bundle Size

2.12 kB

667.00 B

Languages

Total Downloads

945,271,350

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

proc-log

API

output

log

input

time

Examples

log

Colorize based on level

Pause and resume

input

start and end

Using read to call read()

10

10

10

10

10

10

9

6

0

0

0

0

6.8

/10

Other packages similar to proc-log

`start` and `end`

Using `read` to call `read()`