feat: update package name

sandworm-hq · Feb 10, 2023 · baa9281 · baa9281
1 parent 6741287
commit baa9281
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 235 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -40,7 +40,7 @@ jobs:
           command: yarn global add release-please
       - run:
           name: Create or update release PR
-          command: release-please release-pr --token=${GH_TOKEN} --repo-url=sandworm-hq/sinkchart
+          command: release-please release-pr --token=${GH_TOKEN} --repo-url=sandworm-hq/sandworm
   github-release:
     executor: node/default
     steps:
@@ -51,7 +51,7 @@ jobs:
           command: yarn global add release-please
       - run:
           name: Create release
-          command: release-please github-release --token=${GH_TOKEN} --repo-url=sandworm-hq/sinkchart
+          command: release-please github-release --token=${GH_TOKEN} --repo-url=sandworm-hq/sandworm
   publish-npm:
     executor: node/default
     steps:
@@ -90,12 +90,12 @@ workflows:
             branches:
               ignore: /.*/
             tags:
-              only: /^sinkchart-v.*/
+              only: /^sandworm-v.*/
       - publish-npm:
           requires:
             - setup
           filters:
             branches:
               ignore: /.*/
             tags:
-              only: /^sinkchart-v.*/
+              only: /^sandworm-v.*/
diff --git a/.npmignore b/.npmignore
@@ -1,4 +1,4 @@
-.sinkchart
+.sandworm
 .husky/commit-msg
 .husky/pre-commit
 .circleci

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,207 +0,0 @@
-# Changelog
-
-## [1.17.2](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.17.1...sinkchart-v1.17.2) (2023-02-10)
-
-
-### Bug Fixes
-
-* include recommendations in license issue output ([c23b5ee](https://github.com/sandworm-hq/sinkchart/commit/c23b5ee8171f6ef6f158f8d5c95b8d5d9e125e3b))
-
-## [1.17.1](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.17.0...sinkchart-v1.17.1) (2023-02-10)
-
-
-### Bug Fixes
-
-* crash for undefined dependencyVulnerabilities ([1214155](https://github.com/sandworm-hq/sinkchart/commit/1214155f9c499898cccca66c9e663b5d84d7e4aa))
-
-## [1.17.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.16.0...sinkchart-v1.17.0) (2023-02-09)
-
-
-### Features
-
-* include license issue recommendations ([f2af2f4](https://github.com/sandworm-hq/sinkchart/commit/f2af2f4c950e9739ff0a617d0eb727dfdae53203))
-
-## [1.16.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.15.0...sinkchart-v1.16.0) (2023-02-06)
-
-
-### Features
-
-* better license usage data structure ([3e373fa](https://github.com/sandworm-hq/sinkchart/commit/3e373fa41b72b2d091865ea0ffa621f2d9ab10ce))
-
-## [1.15.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.14.0...sinkchart-v1.15.0) (2023-02-05)
-
-
-### Features
-
-* charts now display license issues ([9b38f08](https://github.com/sandworm-hq/sinkchart/commit/9b38f089b624faf9dad4869a4b39d13501edb797))
-* cli now displays licence scanning phase ([b5467f8](https://github.com/sandworm-hq/sinkchart/commit/b5467f8ab633fdee45f32d81db798943e8a1b113))
-* configurable min severity level for charts ([2950408](https://github.com/sandworm-hq/sinkchart/commit/2950408da998eb294e6a37d105cc1d1d7bb79ddc))
-* icon now represents severity in node tooltip ([8ccfb97](https://github.com/sandworm-hq/sinkchart/commit/8ccfb97e99c69ec2c622850b7d4c0101a0c1fb64))
-
-
-### Bug Fixes
-
-* long license strings now truncated in tooltip ([50b0403](https://github.com/sandworm-hq/sinkchart/commit/50b0403976f433630e9a9f96698522da5a21450b))
-
-## [1.14.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.13.1...sinkchart-v1.14.0) (2023-02-03)
-
-
-### Features
-
-* output license usage and issues ([99aa988](https://github.com/sandworm-hq/sinkchart/commit/99aa988001b22c64313fd5f28231a1401c539a90))
-
-## [1.13.1](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.13.0...sinkchart-v1.13.1) (2023-01-27)
-
-
-### Bug Fixes
-
-* json license data parsing ([c625d06](https://github.com/sandworm-hq/sinkchart/commit/c625d06942ff59464e519e73244a8f0fdd66cb81))
-
-## [1.13.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.12.0...sinkchart-v1.13.0) (2023-01-27)
-
-
-### Features
-
-* support json stringified licence data ([fff0585](https://github.com/sandworm-hq/sinkchart/commit/fff0585592943978036310791177d2f47d514901))
-
-## [1.12.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.11.0...sinkchart-v1.12.0) (2023-01-25)
-
-
-### Features
-
-* expose array with processed dependency data ([557cfe4](https://github.com/sandworm-hq/sinkchart/commit/557cfe41710e9c651fe0489dc3785a8e2572c0da))
-
-## [1.11.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.10.0...sinkchart-v1.11.0) (2023-01-24)
-
-
-### Features
-
-* output all dependency data as csv ([eb92647](https://github.com/sandworm-hq/sinkchart/commit/eb9264766631ef3c17a8c64cbde72b7ca66b8b90))
-
-## [1.10.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.9.0...sinkchart-v1.10.0) (2023-01-22)
-
-
-### Features
-
-* better package size estimation ([c98752f](https://github.com/sandworm-hq/sinkchart/commit/c98752f5b7ae5ce0fcb0fb05532b37664cda1974))
-* better treemap package labeling ([3bfadd7](https://github.com/sandworm-hq/sinkchart/commit/3bfadd7a0a17e7950009985c06b8f66216fae4e4))
-* better vulnerability reporting ([e33941e](https://github.com/sandworm-hq/sinkchart/commit/e33941eb27276c9a780489e5672e123f55459cd2))
-
-
-### Bug Fixes
-
-* root vulnerabilities access ([1c39fab](https://github.com/sandworm-hq/sinkchart/commit/1c39fab1863c5d7bad8955bf4202aa147af7983c))
-* treemap now represents root module sizes ([958e7b0](https://github.com/sandworm-hq/sinkchart/commit/958e7b07809e38b8d1240584b3e46760b65df475))
-
-## [1.9.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.8.0...sinkchart-v1.9.0) (2023-01-21)
-
-
-### Features
-
-* better vulnerability reporting ([976dad6](https://github.com/sandworm-hq/sinkchart/commit/976dad6486bdb75587715b433bd8f4bcbd12ff06))
-
-## [1.8.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.7.1...sinkchart-v1.8.0) (2023-01-13)
-
-
-### Features
-
-* allow providing custom dep graphs ([e3b4a77](https://github.com/sandworm-hq/sinkchart/commit/e3b4a77a048b6828e64462b7555d8f975c23635c))
-
-## [1.7.1](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.7.0...sinkchart-v1.7.1) (2023-01-12)
-
-
-### Bug Fixes
-
-* generate multiple charts in the same session ([552f446](https://github.com/sandworm-hq/sinkchart/commit/552f446fd6c70217b8c53acffa0d99526727bd0e))
-
-## [1.7.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.6.4...sinkchart-v1.7.0) (2023-01-11)
-
-
-### Features
-
-* add config to disable size scanning ([88dda72](https://github.com/sandworm-hq/sinkchart/commit/88dda724d6296ca6c7ca9aed49389750bd3f751d))
-
-## [1.6.4](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.6.3...sinkchart-v1.6.4) (2023-01-10)
-
-
-### Bug Fixes
-
-* crash when audit returns empty ([996c5b8](https://github.com/sandworm-hq/sinkchart/commit/996c5b8004deb66f8e8e4965db2ce9e54f33cd64))
-
-## [1.6.3](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.6.2...sinkchart-v1.6.3) (2023-01-10)
-
-
-### Bug Fixes
-
-* crash when post-processing empty graphs ([9bddc17](https://github.com/sandworm-hq/sinkchart/commit/9bddc170e8678b51a50618bf7481464e91c9361a))
-
-## [1.6.2](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.6.1...sinkchart-v1.6.2) (2023-01-10)
-
-
-### Bug Fixes
-
-* parsing vulnerabilities from empty response ([813ceba](https://github.com/sandworm-hq/sinkchart/commit/813ceba51c7786e662d73e8c7dd91f20d9905488))
-
-## [1.6.1](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.6.0...sinkchart-v1.6.1) (2023-01-10)
-
-
-### Bug Fixes
-
-* crash when using pnpm with no dependencies ([dc4696b](https://github.com/sandworm-hq/sinkchart/commit/dc4696bcf9bea203c2b2f71cf1108a04cee6c117))
-
-## [1.6.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.5.0...sinkchart-v1.6.0) (2023-01-07)
-
-
-### Features
-
-* include vulnerabilities in exported data ([2528072](https://github.com/sandworm-hq/sinkchart/commit/2528072c04d329cc9647c305d3f4f1f008e2cf32))
-
-## [1.5.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.4.0...sinkchart-v1.5.0) (2022-12-22)
-
-
-### Features
-
-* remove svg width and height attributes ([b9e3d45](https://github.com/sandworm-hq/sinkchart/commit/b9e3d45020996ed91a8cdc9d81c71d28ca2b91f0))
-
-## [1.4.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.3.0...sinkchart-v1.4.0) (2022-12-05)
-
-
-### Features
-
-* universal support for license info ([6b8817f](https://github.com/sandworm-hq/sinkchart/commit/6b8817f44ba2a0b50bf743aad12b71a21c3b85cd))
-
-## [1.3.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.2.1...sinkchart-v1.3.0) (2022-12-03)
-
-
-### Features
-
-* add license info to tooltip, when available ([291991c](https://github.com/sandworm-hq/sinkchart/commit/291991cb5cfaf0bc4441211a4d5f7df4412d197d))
-
-## [1.2.1](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.2.0...sinkchart-v1.2.1) (2022-12-02)
-
-
-### Bug Fixes
-
-* represent non-prod dependencies ([5e04c15](https://github.com/sandworm-hq/sinkchart/commit/5e04c1598f98e28f7db6d56f5e79c22bffee8f20))
-
-## [1.2.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.1.0...sinkchart-v1.2.0) (2022-11-28)
-
-
-### Features
-
-* build all charts by default ([a1db19a](https://github.com/sandworm-hq/sinkchart/commit/a1db19ad97b747989c078be109643eefc1f1e889))
-* support all js package managers ([bc2c2e2](https://github.com/sandworm-hq/sinkchart/commit/bc2c2e2e1f7b3306314184eee8a9c77c05099f6a))
-
-## [1.1.0](https://github.com/sandworm-hq/sinkchart/compare/sinkchart-v1.0.0...sinkchart-v1.1.0) (2022-10-27)
-
-
-### Features
-
-* initial commit ([f46ae74](https://github.com/sandworm-hq/sinkchart/commit/f46ae749dbb3dee41d79099004cb521387e26415))
-* support yarn audit ([5c701b1](https://github.com/sandworm-hq/sinkchart/commit/5c701b15d69373f81536f1835ef43e02a093e66c))
-* update max depth arg type ([aac673a](https://github.com/sandworm-hq/sinkchart/commit/aac673ac41d9e6654b055d39ae0c1c1ecbde6ed6))
-
-
-### Bug Fixes
-
-* remove package lock ([98bbdf5](https://github.com/sandworm-hq/sinkchart/commit/98bbdf526e7ef67f326f4575f515bc6b1ce0d526))

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,19 +2,19 @@
 
 ## Introduction
 
-First off, thank you for considering contributing to Sinkchart.
+First off, thank you for considering contributing to Sandworm.
 
 Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
 
-Sinkchart is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Sinkchart itself.
+Sandworm is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Sandworm itself.
 
 ## How to report a bug
 
-If you find a security issue or a vulnerability in Sinkchart, please do NOT open an issue. See [SECURITY.md](security.md) instead.
+If you find a security issue or a vulnerability in Sandworm, please do NOT open an issue. See [SECURITY.md](security.md) instead.
 
 When filing an issue with our GitHub issue tracker, make sure to answer these five questions:
 
-* What version of Sinkchart are you using?
+* What version of Sandworm are you using?
 * What Node version are you using?
 * What package manager are you using?
 * What did you do?
@@ -25,7 +25,7 @@ Please add the `bug` label to all bug-reporting issues.
 
 ## How to suggest a feature or enhancement
 
-If you find yourself wishing for a feature that doesn't exist in Sinkchart, you are probably not alone! Please [create a new discussion here](https://github.com/sandworm-hq/sinkchart/discussions/categories/ideas) which describes the feature you would like to see, why you need it, and how it should work.
+If you find yourself wishing for a feature that doesn't exist in Sandworm, you are probably not alone! Please [create a new discussion here](https://github.com/sandworm-hq/Sandworm/discussions/categories/ideas) which describes the feature you would like to see, why you need it, and how it should work.
 
 ## Ground Rules
 

diff --git a/README.md b/README.md
@@ -17,26 +17,23 @@ Beautiful Visualizations For Your App's Dependencies 🪱
 * Works with npm, yarn, and pnpm
 * Made by the team behind [Sandworm](https://sandworm.dev/) - Easy auditing & sandboxing for your JavaScript dependencies
 
-![Sinkchart Tooltips](https://sandworm-assets.s3.amazonaws.com/sinkchart/demos/sinkchart-tooltip.png)
+![Sandworm Tooltips](https://sandworm-assets.s3.amazonaws.com/sinkchart/demos/sinkchart-tooltip.png)
 
 > **Warning**
-> Sinkchart does NOT currently support [workspaces](https://docs.npmjs.com/cli/v9/using-npm/workspaces).
-
-> **Warning**
-> License info is currently only available when using npm - but we're working on universal support.
+> Sandworm does NOT currently support [workspaces](https://docs.npmjs.com/cli/v9/using-npm/workspaces).
 
 ### Get Involved
 
-* Have a support question? [Post it here](https://github.com/sandworm-hq/sinkchart/discussions/categories/q-a).
-* Have a feature request? [Post it here](https://github.com/sandworm-hq/sinkchart/discussions/categories/ideas).
+* Have a support question? [Post it here](https://github.com/sandworm-hq/sandworm/discussions/categories/q-a).
+* Have a feature request? [Post it here](https://github.com/sandworm-hq/sandworm/discussions/categories/ideas).
 * Did you find a security issue? [See SECURITY.md](SECURITY.md).
-* Did you find a bug? [Post an issue](https://github.com/sandworm-hq/sinkchart/issues/new/choose).
+* Did you find a bug? [Post an issue](https://github.com/sandworm-hq/sandworm/issues/new/choose).
 * Want to write some code? See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## Install
 
 ```bash
-yarn global add sinkchart # or npm install -g sinkchart
+yarn global add sandworm # or npm install -g sandworm
 ```
 
 ## Options
@@ -46,7 +43,7 @@ Options:
       --version          Show version number                           [boolean]
       --help             Show help                                     [boolean]
   -o, --output           The name of the output directory, relative to the
-                         application path       [string] [default: ".sinkchart"]
+                         application path        [string] [default: ".sandworm"]
   -d, --include-dev      Include dev dependencies     [boolean] [default: false]
   -v, --show-versions    Show package versions        [boolean] [default: false]
   -t, --type             Visualization type[string] [choices: "tree", "treemap"]
@@ -66,7 +63,7 @@ Options:
 * Click on a node to make the tooltip persist; click outside to close it;
 * When representing deep dependencies, the surface area of certain packages might reach zero, making them invisible.
 
-![Sinkchart Treemap Chart](https://sandworm-assets.s3.us-east-1.amazonaws.com/sinkchart/demos/sinkchart-treemap.png)
+![Sandworm Treemap Chart](https://sandworm-assets.s3.us-east-1.amazonaws.com/sinkchart/demos/sinkchart-treemap.png)
 
 ### Tree
 * Nodes are grouped by color based on the root dependency that they belong to;
@@ -75,7 +72,7 @@ Options:
 * Click on a node to make the tooltip persist; click outside to close it;
 * By default, the tree chart has a maximum depth of 7, meaning only seven levels of dependencies will be represented, to keep the output readable; you can override this using the `--md` option.
 
-![Sinkchart Tree Chart](https://sandworm-assets.s3.us-east-1.amazonaws.com/sinkchart/demos/sinkchart-tree.png)
+![Sandworm Tree Chart](https://sandworm-assets.s3.us-east-1.amazonaws.com/sinkchart/demos/sinkchart-tree.png)
 
 ## Samples
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "sinkchart",
-  "version": "1.17.2",
+  "name": "sandworm",
+  "version": "1.3.2",
   "description": "Beautiful Visualizations For Your App's Dependencies 🪱",
   "main": "src/index.js",
   "bin": "src/cli.js",
@@ -10,7 +10,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/sandworm-hq/sinkchart-js.git"
+    "url": "git+https://github.com/sandworm-hq/sandworm.git"
   },
   "keywords": [
     "security",

diff --git a/src/cli.js b/src/cli.js
@@ -63,7 +63,7 @@ const onProgress =
   };
 
 require('yargs')
-  .scriptName('Sinkchart')
+  .scriptName('Sandworm')
   .command(
     '*',
     "Better Visualizations For Your App's Dependencies 🪱",
@@ -72,7 +72,7 @@ require('yargs')
         .option('o', {
           alias: 'output',
           demandOption: false,
-          default: '.sinkchart',
+          default: '.sandworm',
           describe: 'The name of the output directory, relative to the application path',
           type: 'string',
         })
@@ -112,7 +112,7 @@ require('yargs')
         });
     },
     async (argv) => {
-      logger.log('\x1b[36m%s\x1b[0m', `Sinkchart 🧭`);
+      logger.log('\x1b[36m%s\x1b[0m', `Sandworm 🪱`);
       const {default: ora} = await import('ora');
 
       const {svgs, csv, name, version} = await getReport({