npmpackage.info

Gathering detailed insights and metrics for broccoli-debug

broccoli-debug

Debugging tools for Broccoli

0.6.5

MIT

JavaScript

50,487,213 2.1

Installations

npm install broccoli-debug

Pull Requests

Open

16

Total

34

Closed

6

Merged

12

Issues

Open

1

Total

3

Closed

2

Releases

Unable to fetch releases

Developer

broccolijs

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

10.9.0

NPM Version

6.2.0 Statistics

9 Stars

65 Commits

4 Forks

7 Watching

18 Branches

6 Contributors

Updated on 07 May 2022

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

50,487,213

Last day

-31.4%

19,972

Compared to previous day

Last week

-13%

122,094

Compared to previous week

Last month

15.7%

582,028

Compared to previous month

Last year

18.9%

8,276,493

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

broccoli-plugin fs-tree-diff heimdalljs heimdalljs-logger symlink-or-copy tree-sync

Dev Dependencies

broccoli-source broccoli-test-helper co qunit-eslint qunitjs

Versions

broccoli-debug

Utility for build pipeline authors to allow trivial debugging of the Broccoli pipelines they author.

Heavily inspired by @stefanpenner's broccoli-stew's debug's helper, but improved in a few ways:

Supports leaving debug trees in the build with minimal cost when not being used.
Supports binary files (e.g. does not write .png's as utf8 text).
Adds debug style debug matching.

Usage

Pipeline Authors

To allow consumers to debug the internals of various stages in your build pipeline, you create a new instance of BroccoliDebug and return it instead.

Something like this:

1var BroccoliDebug = require('broccoli-debug');
2
3let tree = new BroccoliDebug(input, `ember-engines:${this.name}:addon-input`);

Obviously, this would get quite verbose to do many times, so we have created a shortcut to easily create a number of debug trees with a shared prefix:

1let debugTree = BroccoliDebug.buildDebugCallback(`ember-engines:${this.name}`);
2
3let tree1 = debugTree(input1, 'addon-input');
4// tree1.debugLabel => 'ember-engines:<some-name>:addon-input'
5
6let tree2 = debugTree(input2, 'addon-output');
7// tree2.debugLabel => 'ember-engines:<some-name>:addon-output

Consumers

Folks wanting to inspect the state of the build pipeline at that stage, would do the following:

1BROCCOLI_DEBUG=ember-engines:* ember b

Now you can take a look at the state of that input tree by:

1ls DEBUG/ember-engines/*

API

1interface BroccoliDebugOptions {
2  /**
3    The label to use for the debug folder. By default, will be placed in `DEBUG/*`.
4  */
5  label: string
6
7  /**
8    The base directory to place the input node contents when debugging is enabled.
9
10    Chooses the default in this order:
11
12    * `process.env.BROCCOLI_DEBUG_PATH`
13    * `path.join(process.cwd(), 'DEBUG')`
14  */
15  baseDir: string
16
17  /**
18    Should the tree be "always on" for debugging? This is akin to `debugger`, its very
19    useful while actively working on a build pipeline, but is likely something you would
20    remove before publishing.
21  */
22  force?: boolean
23}
24
25class BroccoliDebug {
26  /**
27    Builds a callback function for easily generating `BroccoliDebug` instances
28    with a shared prefix.
29  */
30  static buildDebugCallback(prefix: string): (node: any, labelOrOptions: string | BroccoliDebugOptions) => BroccoliNode
31  constructor(node: BroccoliNode, labelOrOptions: string | BroccoliDebugOptions);
32  debugLabel: string;
33}

Development

Installation

git clone git@github.com:broccolijs/broccoli-debug.git
cd broccoli-debug
yarn

Testing

yarn test

No vulnerabilities found.

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

3

Code-Review

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

0

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

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

61 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-v2p6-4mp7-3r9v

Score

2.1

/10

Last Scanned on 2024-11-25

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