ibm-products icon indicating copy to clipboard operation
ibm-products copied to clipboard

Create a tool that produces a report on what components a codebase is using

Open dcwarwick opened this issue 3 years ago • 2 comments

The goal is to be able to produce a report on what components are being used by a product or project, suitable for presenting at DUX review or similar. The components listed in the report should be the components from carbon-components-react and @carbon/ibm-products and other similar packages (CDAI? security? cloud pal? etc) that are being imported by one or more source files in or below the directory in which the tool is being run.

A key piece of this tool will be the code that scans source files and compiles the list of components from various packages being imported. There may be useful dependencies we can build this with, or we may need to scan and match the source files ourselves using some heuristics. One CLI invocation of the tool will then be to use this code to scan for components and then format the result into a neat report of some kind.

This can be built first as a proof of concept, for testing on a few codebases to check if it is going to be useful.

Possible abilities to add/todo:

  • [ ] Strip out pkg or restrict based on a list of components
  • [ ] Target Carbon, Security, CloudPAL
  • [ ] Note if linter is used
  • [ ] Versions of packages
  • [ ] Provide context of component usage, omponents up to pages etc.

dcwarwick avatar Mar 01 '22 16:03 dcwarwick

A straw man has been published, test and announce.

lee-chase avatar Mar 23 '22 13:03 lee-chase

Meetings arranged for April 8th with @joshblack @rodet

Placing on hold until then.

lee-chase avatar Mar 30 '22 09:03 lee-chase