feat: visualize and analyze commands

.eslintrc.js

@@ -2,7 +2,18 @@
 const config = {
   root: true,
   extends: ['@callstack'],
-  ignorePatterns: ['node_modules/', '**/node_modules/', 'lib/', '**/lib/', 'build/', '**/build/', 'docs/**'],
+  ignorePatterns: [
+    'node_modules/',
+    '**/node_modules/',
+    'lib/',
+    '**/lib/',
+    'build/',
+    '**/build/',
+    'visualizer-build/',
+    'doc_build',
+    'docs/**',
+    'packages/visualizer/',
+  ],
   rules: {
     // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
     '@typescript-eslint/consistent-type-imports': ['error'],

.gitignore

@@ -3,7 +3,8 @@
 .DS_Store
 
 # VSCode
-.vscode/
+.vscode/*
+!.vscode/settings.json
 
 # Yarn
 node_modules/

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "eslint.workingDirectories": [{ "mode": "auto" }],
+  "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+}

commitlint.config.ts

@@ -0,0 +1,7 @@
+import type { UserConfig } from '@commitlint/types';
+
+const Configuration: UserConfig = {
+  extends: ['@commitlint/config-conventional'],
+};
+
+export default Configuration;

docs/docs/docs/react-native.mdx

@@ -27,7 +27,7 @@ If you are using Expo, you need to add the config plugin to your `app.json` or `
 ```diff
 {
   "expo": {
-++  "plugins": ["react-native-legal"]
++  "plugins": ["react-native-legal"]
   }
 }
 ```

docs/docs/docs/standalone-cli.mdx

@@ -2,7 +2,7 @@
 sidebar_position: 3
 ---
 
-import { PackageManagerTabs, Badge } from '@theme';
+import { Badge, PackageManagerTabs } from '@theme';
 
 # Standalone CLI (Node.js)
 
@@ -96,6 +96,35 @@ Generates a licenses report in the specified format. The output can be written t
 | `--format [type]`                         | Output format, one of: `'json'`, `'about-json'` (AboutLibraries-compatible), `'text'`, `'markdown'`                                                                                                                                                                                                                                                      | `'json'`                  |
 | `--output [path]`                         | Where to write the output - either `'stdout'` or a path to an output file                                                                                                                                                                                                                                                                                | `'stdout'`                |
 
+#### Command: `analyze`
+
+Scan licenses & report the insights: summary, top license types, optionally unknowns & breakdown of licenses by different features.
+
+| Flag / Option                            | Description                                                                                                                                                                                                                                                                                                                                              | Default                   |
+| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
+| `--root [path]`                          | Path to the root of your project.                                                                                                                                                                                                                                                                                                                        | Current working directory |
+| `--list-unknown`                         | List unknown licenses.                                                                                                                                                                                                                                                                                                                                   | `false`                   |
+| `--show-breakdown`                       | Show breakdown of licenses by category and type.                                                                                                                                                                                                                                                                                                         | `false`                   |
+| `--tm, --transitive-deps-mode [mode]`    | Controls, which transitive dependencies are included: <ul><li>`'all'`</li> <li>`'from-external-only'` (only transitive dependencies of direct dependencies specified by non-workspace:... specifiers)</li> <li>`'from-workspace-only'` (only direct dependencies of direct dependencies specified by `workspace:` specifier)</li> <li>`'none'`</li></ul> | `'all'`                   |
+| `--dm, --dev-deps-mode [mode]`           | <ul><li>`'root-only'` (only direct devDependencies from the scanned project's root package.json)</li> <li>`'none'`</li></ul>                                                                                                                                                                                                                             | `'root-only'`             |
+| `--od`, `--include-optional-deps [bool]` | Whether to include `optionalDependencies` in the scan; other flags apply.                                                                                                                                                                                                                                                                                | `true`                    |
+| `-h`, `--help`                           | Display help for command.                                                                                                                                                                                                                                                                                                                                | —                         |
+
+#### Command: `visualize`
+
+Launches a local server providing a web license graph visualizer & analyzer app: summarizes the dependency graph state, shows an interactive graph of licenses with possibility to select a subgraph, provides browser built-in AI-turbocharged summary of the dependency graph.
+
+| Flag / Option                            | Description                                                                                                                                                                                                                                                                                                                                              | Default       |
+| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
+| `--port [port]`                          | Port on which to launch the app.                                                                                                                                                                                                                                                                                                                         | `8094`        |
+| `--h, --host [host]`                     | Host on which to launch the app.                                                                                                                                                                                                                                                                                                                         | `"localhost"` |
+| `--a, --auto-open [open]`                | Automatically open the app in the browser after launching.                                                                                                                                                                                                                                                                                               | `true`        |
+| `--root [path]`                          | Path to the root of your project.                                                                                                                                                                                                                                                                                                                        | `"."`         |
+| `--tm, --transitive-deps-mode [mode]`    | Controls, which transitive dependencies are included: <ul><li>`'all'`</li> <li>`'from-external-only'` (only transitive dependencies of direct dependencies specified by non-workspace:... specifiers)</li> <li>`'from-workspace-only'` (only direct dependencies of direct dependencies specified by `workspace:` specifier)</li> <li>`'none'`</li></ul> | `'all'`       |
+| `--dm, --dev-deps-mode [mode]`           | <ul><li>`'root-only'` (only direct devDependencies from the scanned project's root package.json)</li> <li>`'none'`</li></ul>                                                                                                                                                                                                                             | `'root-only'` |
+| `--od`, `--include-optional-deps [bool]` | Whether to include `optionalDependencies` in the scan; other flags apply.                                                                                                                                                                                                                                                                                | `true`        |
+| `-h`, `--help`                           | Display help for command.                                                                                                                                                                                                                                                                                                                                | —             |
+
 #### Command: `help`
 
 Displays help, listing the available commands.

examples/bare-example/e2e/common/acceptChromeTerms-AcceptContinueVariant.yaml

@@ -1,9 +1,9 @@
-name: "[Android] Accept Chrome T & C - Use without an account variant"
+name: '[Android] Accept Chrome T & C - Use without an account variant'
 appId: com.android.chrome
 ---
 - tapOn:
-        label: Accept Chrome T & C
-        text: "Accept & continue"
+    label: Accept Chrome T & C
+    text: 'Accept & continue'
 - tapOn:
-        label: "Turn off Chrome sync"
-        text: "No thanks"
+    label: 'Turn off Chrome sync'
+    text: 'No thanks'

examples/bare-example/e2e/common/acceptChromeTerms-UseWithoutAnAccountVariant.yaml

@@ -1,9 +1,9 @@
-name: "[Android] Accept Chrome T & C - Accept and Continue variant"
+name: '[Android] Accept Chrome T & C - Accept and Continue variant'
 appId: com.android.chrome
 ---
 - tapOn:
-      label: Dismiss Chrome sign in
-      text: "Use without an account"
+    label: Dismiss Chrome sign in
+    text: 'Use without an account'
 - tapOn:
-      label: "Dismiss Chrome notifications"
-      id: "com.android.chrome:id/negative_button"
+    label: 'Dismiss Chrome notifications'
+    id: 'com.android.chrome:id/negative_button'

examples/bare-example/index.js

@@ -1,7 +1,6 @@
 /**
  * @format
  */
-
 import { AppRegistry } from 'react-native';
 
 import App from './App';

examples/node-example/__tests__/report.spec.ts

@@ -39,9 +39,15 @@ async function runReportCommandForJsonOutput(args: string[] = []) {
   const command = `yarn workspace license-kit-node-example report${args ? ` ${args.join(' ')}` : ''}`;
 
   const output = await new Promise<string>((resolve) => {
-    child_process.exec(command, (_, stdout) => {
-      resolve(stdout);
-    });
+    child_process.exec(
+      command,
+      {
+        maxBuffer: 1024 * 1024 * 100, // 100MB
+      },
+      (_, stdout) => {
+        resolve(stdout);
+      },
+    );
   });
 
   return JSON.parse(output);

lefthook.yml

@@ -2,10 +2,17 @@ pre-commit:
   piped: true
   commands:
     lint-js:
-      # Run ESLint for JS/TS files if any of them are staged
+      # Run ESLint for root ESLint config JS/TS files if any of them are staged
       files: git diff --name-only --cached
       glob: '*.{js,ts,jsx,tsx}'
       run: yarn lint:js
+      exclude:
+        - 'packages/visualizer/**'
+    lint-js-visualizer:
+      # Run ESLint for visualizer ESLint config JS/TS files if any of them are staged
+      files: git diff --name-only --cached
+      glob: 'packages/visualizer/**/*.{js,ts,jsx,tsx}'
+      run: yarn workspace @callstack/license-kit-visualizer lint
     lint-docs:
       # Run biome linter for docs files if any of them are staged
       files: git diff --name-only --cached

package.json

@@ -3,13 +3,14 @@
   "workspaces": {
     "packages": [
       "packages/*",
+      "packages/license-kit/visualizer",
       "docs",
       "examples/*",
       "examples/packages/*"
     ]
   },
   "scripts": {
-    "build:library": "yarn workspace @callstack/licenses build && yarn workspace react-native-legal build-plugins && yarn workspace license-kit build-library && yarn workspace react-native-legal build-library",
+    "build:library": "yarn workspace @callstack/licenses build && yarn workspace react-native-legal build-plugins && yarn workspace license-kit build-library && yarn workspace react-native-legal build-library && yarn workspace @callstack/license-kit-visualizer build",
     "lint:js": "eslint \"**/*.{js,ts,tsx}\"",
     "lint:docs": "yarn workspace docs check",
     "typescript": "yarn build:library && tsc --noEmit -p examples/bare-example/tsconfig.json && tsc --noEmit -p examples/expo-example/tsconfig.json",
@@ -39,18 +40,14 @@
     "@changesets/changelog-github": "^0.5.1",
     "@changesets/cli": "^2.28.1",
     "@commitlint/config-conventional": "17.6.6",
-    "@evilmartians/lefthook": "1.4.3",
+    "@evilmartians/lefthook": "1.12.2",
     "commitlint": "17.6.6",
     "eslint": "^8.46.0",
     "eslint-plugin-flowtype": "^8.0.3",
-    "eslint-plugin-prettier": "^5.0.0",
-    "prettier": "^3.0.1",
+    "eslint-plugin-prettier": "^5.5.3",
+    "expo": "~52.0.36",
+    "prettier": "^3.6.2",
     "typescript": "^5.1.3"
   },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
   "packageManager": "yarn@3.6.1"
 }

packages/license-kit/.gitignore

@@ -0,0 +1 @@
+visualizer-build/