Giter VIP home page Giter VIP logo

Comments (5)

stevespringett avatar stevespringett commented on June 24, 2024 2

This has been incorporated into v2.0.0 and will be available soon.

from cyclonedx-node-module.

PenelopeFudd avatar PenelopeFudd commented on June 24, 2024

Yes, a million times yes! I'm not a node programmer, so I just downloaded one of our repositories, ran 'cyclonedx-bom -o bom.xml' on it, and was dumbfounded because the bom.xml file was empty. I tried everything I could think of to get it to work, and eventually Googled my way to salvation by finding this issue (and fix). Up until 3am working on this, feeling a bit loopy right now.

from cyclonedx-node-module.

stevespringett avatar stevespringett commented on June 24, 2024

The lock file doesn't provide enough information so it cannot be used by itself. node_modules needs to be there.

I'm in the process of completely refactoring the node module. I'll add a check that outputs some help in the event a BOM with zero components is produced. Look for these changes in v2.0.0 of the module.

from cyclonedx-node-module.

alfonsoar avatar alfonsoar commented on June 24, 2024

@stevespringett curious what information you get from node_modules that you cant see in package-lock.json ?

requiring node_modules adds extra steps (and time) when doing this on the CI.

from cyclonedx-node-module.

stevespringett avatar stevespringett commented on June 24, 2024

The following data can easily be incorporated into a BOM using node_modules, but not with a package-lock.json:

  • Component description
  • Component type (framework, library, etc)
  • Authors
  • License
  • License file
  • Website URL
  • Issue tracker URL
  • VCS URL

SPDX license ID and optional license file are obviously valuable for legal and compliance use cases. The URLs are valuable not only for documentation purposes, but for advanced forms of analysis as well (e.g. project health). In addition, future versions of the node plugin will include every file-level component and their corresponding hash values, etc, that provided integrity above and beyond what package-lock.json is capable of achieving.

from cyclonedx-node-module.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.