search

thegreenwebfoundation / co2.js

An npm module for accessing the green web API, and estimating the carbon emissions from using digital services
Other
389 stars 49 forks source link

ignore data files and public folder #117

Closed fershad closed 1 year ago

fershad commented 1 year ago

Recent v0.11.x updates to the library are coming in a 17MB + in size when published to NPM. This has been raised in #108 and it was found data files were being included in the published package.

This PR fixes that & also removes the public directory from the package, since it is only for demonstration purposes.

fershad commented 1 year ago

Running npm pack generates the following output:

$ npm pack

npm notice 
npm notice 📦  @tgwf/co2@0.11.1
npm notice === Tarball Contents === 
npm notice 870B   .all-contributorsrc                               
npm notice 225B   .esbuild.browser.js                               
npm notice 908B   .esbuild.esm.js                                   
npm notice 344B   .esbuild.node.js                                  
npm notice 8B     .eslintignore                                     
npm notice 183B   .gitpod.yml                                       
npm notice 6.2kB  CHANGELOG.md                                      
npm notice 12.0kB LICENSE                                           
npm notice 562B   NOTICE                                            
npm notice 5.1kB  README.md                                         
npm notice 1.7kB  data/output/average-intensities-2021.js           
npm notice 20.8kB data/output/average-intensities-2021.json         
npm notice 3.4kB  data/output/marginal-intensities-2021.js          
npm notice 85.6kB data/output/marginal-intensities-2021.json        
npm notice 1.9kB  dist/cjs/1byte.js                                 
npm notice 3.0kB  dist/cjs/1byte.js.map                             
npm notice 1.3kB  dist/cjs/1byte.test.js                            
npm notice 923B   dist/cjs/1byte.test.js.map                        
npm notice 5.3kB  dist/cjs/co2.js                                   
npm notice 8.0kB  dist/cjs/co2.js.map                               
npm notice 12.1kB dist/cjs/co2.test.js                              
npm notice 18.3kB dist/cjs/co2.test.js.map                          
npm notice 1.0kB  dist/cjs/constants/file-size.js                   
npm notice 306B   dist/cjs/constants/file-size.js.map               
npm notice 1.3kB  dist/cjs/constants/index.js                       
npm notice 251B   dist/cjs/constants/index.js.map                   
npm notice 2.8kB  dist/cjs/data/average-intensities-2021.min.js     
npm notice 3.0kB  dist/cjs/data/average-intensities-2021.min.js.map 
npm notice 4.6kB  dist/cjs/data/marginal-intensities-2021.min.js    
npm notice 6.5kB  dist/cjs/data/marginal-intensities-2021.min.js.map
npm notice 1.0kB  dist/cjs/helpers/index.js                         
npm notice 305B   dist/cjs/helpers/index.js.map                     
npm notice 2.5kB  dist/cjs/hosting-api.js                           
npm notice 2.5kB  dist/cjs/hosting-api.js.map                       
npm notice 2.1kB  dist/cjs/hosting-api.test.js                      
npm notice 2.1kB  dist/cjs/hosting-api.test.js.map                  
npm notice 1.8kB  dist/cjs/hosting-database.node.test.js            
npm notice 1.5kB  dist/cjs/hosting-database.node.test.js.map        
npm notice 2.7kB  dist/cjs/hosting-json.node.js                     
npm notice 3.2kB  dist/cjs/hosting-json.node.js.map                 
npm notice 2.3kB  dist/cjs/hosting-json.node.test.js                
npm notice 2.2kB  dist/cjs/hosting-json.node.test.js.map            
npm notice 3.1kB  dist/cjs/hosting-node.js                          
npm notice 3.7kB  dist/cjs/hosting-node.js.map                      
npm notice 1.6kB  dist/cjs/hosting.js                               
npm notice 554B   dist/cjs/hosting.js.map                           
npm notice 3.4kB  dist/cjs/hosting.test.js                          
npm notice 3.9kB  dist/cjs/hosting.test.js.map                      
npm notice 1.8kB  dist/cjs/index-node.js                            
npm notice 514B   dist/cjs/index-node.js.map                        
npm notice 2.0kB  dist/cjs/index.js                                 
npm notice 634B   dist/cjs/index.js.map                             
npm notice 27B    dist/cjs/package.json                             
npm notice 6.7kB  dist/cjs/sustainable-web-design.js                
npm notice 13.8kB dist/cjs/sustainable-web-design.js.map            
npm notice 3.8kB  dist/cjs/sustainable-web-design.test.js           
npm notice 5.1kB  dist/cjs/sustainable-web-design.test.js.map       
npm notice 1.0kB  dist/esm/1byte.js                                 
npm notice 360B   dist/esm/1byte.test.js                            
npm notice 4.0kB  dist/esm/co2.js                                   
npm notice 10.9kB dist/esm/co2.test.js                              
npm notice 117B   dist/esm/constants/file-size.js                   
npm notice 62B    dist/esm/constants/index.js                       
npm notice 1.8kB  dist/esm/data/average-intensities-2021.min.js     
npm notice 3.5kB  dist/esm/data/marginal-intensities-2021.min.js    
npm notice 85B    dist/esm/helpers/index.js                         
npm notice 1.3kB  dist/esm/hosting-api.js                           
npm notice 1.1kB  dist/esm/hosting-api.test.js                      
npm notice 810B   dist/esm/hosting-database.node.test.js            
npm notice 1.2kB  dist/esm/hosting-json.node.test.js                
npm notice 275B   dist/esm/hosting.js                               
npm notice 2.2kB  dist/esm/hosting.test.js                          
npm notice 377B   dist/esm/index.js                                 
npm notice 25B    dist/esm/package.json                             
npm notice 5.2kB  dist/esm/sustainable-web-design.js                
npm notice 2.8kB  dist/esm/sustainable-web-design.test.js           
npm notice 15.3kB dist/iife/index.js                                
npm notice 58.6kB dist/iife/index.js.map                            
npm notice 365B   fixup                                             
npm notice 2.3kB  package.json                                      
npm notice 2.3kB  src/1byte.js                                      
npm notice 5.2kB  src/co2.js                                        
npm notice 70B    src/constants/file-size.js                        
npm notice 61B    src/constants/index.js                            
npm notice 1.5kB  src/data/average-intensities-2021.min.js          
npm notice 3.0kB  src/data/marginal-intensities-2021.min.js         
npm notice 84B    src/helpers/index.js                              
npm notice 1.4kB  src/hosting-api.js                                
npm notice 1.7kB  src/hosting-json.node.js                          
npm notice 2.3kB  src/hosting-node.js                               
npm notice 232B   src/hosting.js                                    
npm notice 270B   src/index-node.js                                 
npm notice 341B   src/index.js                                      
npm notice 3.3kB  src/readme.md                                     
npm notice 10.5kB src/sustainable-web-design.js                     
npm notice === Tarball Details === 
npm notice name:          @tgwf/co2                               
npm notice version:       0.11.1                                  
npm notice filename:      @tgwf/co2-0.11.1.tgz                    
npm notice package size:  82.9 kB                                 
npm notice unpacked size: 429.6 kB                                
npm notice shasum:        18cf1eb13d629f61adc4540fe1af49cd043c2838
npm notice integrity:     sha512-uUH/eajZsmAVd[...]9eTOcu6ksY79w==
npm notice total files:   95

A total of 95 files, compared to 115 previously. Total package size 429.6 kB (unpackaged).