license-reporter

Node.js CI

Installation

$ npm install license-reporter -g

Usage

> Example using https://github.com/chalk/chalk

$ git clone https://github.com/chalk/chalk.git
$ cd chalk ; npm install
$ license-reporter console 
========= APPROVED LICENSES        ==========
name: ansi-styles , version: 3.2.1 , licenses: MIT License
name: escape-string-regexp , version: 1.0.5 , licenses: MIT License
name: supports-color , version: 6.0.0 , licenses: MIT License
========= APPROVED LICENSES        ==========


    chalk
    2.4.1
    MIT
    
        
            ansi-styles
            3.2.1
            
                
                    MIT License
                    https://www.opensource.org/licenses/MIT
                
            
        
        
            escape-string-regexp
            1.0.5
            
                
                    MIT License
                    https://www.opensource.org/licenses/MIT
                
            
        
        
            supports-color
            6.0.0
            
                
                    MIT License
                    https://www.opensource.org/licenses/MIT

More commands

license-reporter --help
Usage: license-reporter  [options]

Commands:
  license-reporter console  Shows license information on standard output.
  license-reporter merge    Merge license XML files.
  license-reporter report   Creates a HTML report.
  license-reporter save     Saves license information to a file.

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
  --cwd      Change the current working directory

Save

~/Desktop$ mkdir foo
~/Desktop$ cd foo
~/Desktop/foo$ npm init -y
~/Desktop/foo$ npm install express -S

~/Desktop/foo$ license-reporter save --xml license1.xml
========= APPROVED LICENSES        ==========
name: express , version: 4.16.4 , licenses: MIT License
========= APPROVED LICENSES        ==========

~/Desktop/foo$ cat licenses/license1.xml 


    foo
    1.0.0
    ISC
    
        
            express
            4.16.4
            
                
                    MIT License
                    https://www.opensource.org/licenses/MIT

~/Desktop$ mkdir bar
~/Desktop$ cd bar
~/Desktop/bar$ npm init -y
~/Desktop/bar$ npm install request -S

~/Desktop/bar$ license-reporter save --xml license2.xml
========= APPROVED LICENSES        ==========
name: request , version: 2.88.0 , licenses: Apache License 2.0
========= APPROVED LICENSES        ==========

~/Desktop/bar$ cat licenses/license2.xml 


    bar
    1.0.0
    ISC
    
        
            request
            2.88.0
            
                
                    Apache License 2.0
                    https://www.apache.org/licenses/LICENSE-2.0

XML merging example

The intention for this functionality is to be able to create an xml file that contains all the licenses for a project that is made up of two or more projects.

So we are going to merge both license1.xml and license2.xml files created by the previous examples.

Inside the example foo root directory run:

~/Desktop/foo$ license-reporter merge --merge-project-name="UberProject" --merge-license-xmls="./licenses/license1.xml,../bar/licenses/license2.xml" --merge-output="merged.xml"


~/Desktop/foo$ cat licenses/merged.xml 


    
        
            foo
            1.0.0
            ISC
            
                
                    express
                    4.16.4
                    
                        
                            MIT License
                            https://www.opensource.org/licenses/MIT
                        
                    
                
            
        
    
    
        
            bar
            1.0.0
            ISC
            
                
                    request
                    2.88.0
                    
                        
                            Apache License 2.0
                            https://www.apache.org/licenses/LICENSE-2.0

Extra information can be found here

Contributing

Please read the contributing guide

Most popular functions for license-reporter

To help you get started, we’ve selected a few license-reporter examples, based on popular ways it is used in public projects.

license-reporter.licenses