feat: extracted packages: license-kit CLI and @callstack/react-native-legal-shared

.changeset/bright-bags-peel.md

@@ -0,0 +1,5 @@
+---
+'license-kit': minor
+---
+
+Separated copyleft and report commands, general code refactor

.changeset/bright-bags-scream.md

@@ -0,0 +1,5 @@
+---
+'react-native-legal': minor
+---
+
+Consume extracted core logic from @callstack/react-native-legal-shared

.changeset/many-things-joke.md

@@ -0,0 +1,5 @@
+---
+'@callstack/react-native-legal-shared': minor
+---
+
+Complete refactor, renamed generate* functions to write* and extracted generation logic to functions under previous generate\* names

.changeset/tall-ghosts-stick.md

@@ -0,0 +1,6 @@
+---
+'license-kit': patch
+'@callstack/react-native-legal-shared': patch
+---
+
+feat: setup new packages in monorepo

.eslintrc.js

@@ -1,7 +1,7 @@
 /** @type {import("eslint").Linter.Config} */
 const config = {
   root: true,
-  extends: '@callstack',
+  extends: ['@callstack'],
   ignorePatterns: ['node_modules/', '**/node_modules/', 'lib/', '**/lib/', 'build/', '**/build/'],
   rules: {
     // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
@@ -15,6 +15,7 @@ const config = {
           '**/babel.config.js',
           '**/jest.config.js',
           '**/metro.config.js',
+          '**/rspress.config.ts',
         ],
       },
     ],

.gitignore

@@ -48,7 +48,8 @@ project.xcworkspace
 
 # Library
 build/
-packages/react-native-legal/lib/
+packages/*/lib/
+packages/*/build/
 
 # Expo example
 examples/expo-example/android

CONTRIBUTING.md

@@ -10,6 +10,12 @@ To get started with the project, run `yarn` in the root directory to install the
 yarn
 ```
 
+All packages in this monorepo depend on the [shared package](packages/shared) (`@callstack/react-native-legal-shared`). This package needs to be rebuilt whenever you make changes to it since other packages consume the exported, built JS code with emitted typings. You can do this by running the following command from the root directory, which will start `tsc` in watch mode:
+
+```sh
+yarn workspace @callstack/react-native-legal-shared dev
+```
+
 While developing, you will have 2 example apps that can be used to test your changes.
 Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild.
 If you change any native code, then you'll need to rebuild the example app.
@@ -79,6 +85,7 @@ The codebase of Expo Config Plugin is located in:
 - `packages/react-native-legal/plugin`
 - `packages/react-native-legal/plugin-utils`
 - `packages/react-native-legal/app.plugin.js` (the entry point)
+- `packages/license-kit` (logic)
 
 To test the changes, build the plugin run (from the root directory, the one with consisting all workspaces):
 
@@ -99,8 +106,9 @@ The codebase of RN CLI plugin is located in:
 - `packages/react-native-legal/bare-plugin`
 - `packages/react-native-legal/plugin-utils`
 - `packages/react-native-legal/react-native.config.js` (the entry point)
+- `packages/license-kit` (logic)
 
-To test the changes, build the plugin run (from the root directory, the one with consisting all workspaces):
+To test the changes, build the plugin (run from the root directory, the one with consisting all workspaces):
 
 ```sh
 yarn workspace react-native-legal build-plugins
@@ -145,23 +153,27 @@ yarn format:swift
 Objective-C code is linted and formatted using following commands:
 
 Lint code
+
 ```sh
 yarn lint:objc
 ```
 
 Fixing formatting errors
+
 ```sh
 yarn format:objc
 ```
 
 For Kotlin codebase, run the following to verify code quality:
 
 Lint Kotlin code
+
 ```sh
 yarn lint:android
 ```
 
 Format Kotlin code
+
 ```sh
 yarn format:android
 ```

README.md

@@ -1,6 +1,6 @@
 <a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=react-native-legal" align="center">
   <picture>
-  <img alt="React Native Legal" src="https://github.com/user-attachments/assets/dd266822-1f3c-48ff-816c-7aaeb95d85aa">
+    <img alt="React Native Legal" src="./images/banner.jpg">
   </picture>
 </a>
 
@@ -10,12 +10,40 @@
 
 ---
 
-| Android | iOS | AndroidTV | tvOS |
-| - | - | - | - |
+![E2E tests - Android](https://github.com/callstackincubator/react-native-legal/actions/workflows/test-e2e-android.yaml/badge.svg)
+![E2E tests - iOS](https://github.com/callstackincubator/react-native-legal/actions/workflows/test-e2e-ios.yaml/badge.svg)
+![Release](https://github.com/callstackincubator/react-native-legal/actions/workflows/release.yml/badge.svg)
+![Deploy Docs](https://github.com/callstackincubator/react-native-legal/actions/workflows/deploy-docs.yml/badge.svg)
+
+- [Documentation](#documentation)
+- [Installation](#installation)
+  - [React Native](#react-native)
+  - [Standalone CLI](#standalone-cli)
+  - [Node.js - API](#nodejs---api)
+- [Usage](#usage)
+  - [I want to generate licenses in my Expo project ](#i-want-to-generate-licenses-in-my-expo-project-)
+  - [I want to generate licenses reports in my bare RN project ](#i-want-to-generate-licenses-reports-in-my-bare-rn-project-)
+  - [I want to generate licenses reports in my Node.js project](#i-want-to-generate-licenses-reports-in-my-nodejs-project)
+  - [I want to customize the presentation of the licenses in my JS/TS project](#i-want-to-customize-the-presentation-of-the-licenses-in-my-jsts-project)
+- [Expo](#expo)
+- [Contributing](#contributing)
+- [Acknowledgements](#acknowledgements)
+- [License](#license)
+
+Automagically generate license acknowledgements for your React Native app and any Node.js project 🚀
+
+| Android                                                                                                       | iOS                                                                                                   | AndroidTV                                                                                                     | tvOS                                                                                               |
+| ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
 | ![Android example](https://github.com/callstackincubator/react-native-legal/raw/main/static/android-expo.gif) | ![iOS example](https://github.com/callstackincubator/react-native-legal/raw/main/static/ios-expo.gif) | ![AndroidTV example](https://github.com/callstackincubator/react-native-legal/raw/main/static/android-tv.gif) | ![tvOS example](https://github.com/callstackincubator/react-native-legal/raw/main/static/tvos.gif) |
 
+## Documentation
+
+You can find the full documentation for all packages in this repository at [callstackincubator.github.io/react-native-legal](https://callstackincubator.github.io/react-native-legal/).
+
 ## Installation
 
+### React Native
+
 ```sh
 yarn add react-native-legal
 ```
@@ -26,11 +54,38 @@ or
 npm i --save react-native-legal
 ```
 
+### Standalone CLI
+
+```sh
+yarn add -D license-kit
+```
+
+or
+
+```sh
+npm i --save-dev license-kit
+```
+
+### Node.js - API
+
+```sh
+yarn add @callstack/react-native-legal-shared
+```
+
+or
+
+```sh
+npm i --save @callstack/react-native-legal-shared
+```
+
 ## Usage
 
-This tool is split into 2 parts:
-- a library that lets you display native screen with a list of all dependencies and their licenses
-- a [config plugin](https://docs.expo.dev/config-plugins/introduction/?redirected) (for Expo projects) and a [custom community cli plugin](https://github.com/react-native-community/cli/blob/main/docs/plugins.md) (for bare RN projects)
+This tool is split into 4 parts:
+
+- a React Native library that lets you display native screen with a list of all dependencies and their licenses
+- an [Expo config plugin](https://docs.expo.dev/config-plugins/introduction/?redirected) (for Expo projects) and a [custom community cli plugin](https://github.com/react-native-community/cli/blob/main/docs/plugins.md) (for bare RN projects)
+- a standalone CLI tool that can be used in any Node.js project to generate license metadata
+- a shared package that exposes the core functionality of the license management tool, allowing customization of presentation logic in your Node.js scripts
 
 ### I want to generate licenses in my Expo project <a name="usage-expo"></a>
 
@@ -68,7 +123,7 @@ function MyComponent() {
 
 3. Use [Prebuild](https://docs.expo.dev/workflow/prebuild/) or [EAS](https://docs.expo.dev/eas/) to build the app
 
-### I want to generate licenses in my bare RN project <a name="usage-bare-rn"></a>
+### I want to generate licenses reports in my bare RN project <a name="usage-bare-rn"></a>
 
 1. Invoke the CLI plugin from the root of your RN app
 
@@ -102,6 +157,49 @@ function MyComponent() {
 }
 ```
 
+### I want to generate licenses reports in my Node.js project
+
+You can use the `license-kit` CLI tool to generate license reports in your Node.js project. Here's how to do it:
+
+1. Run the CLI tool from the root of your Node.js project:
+
+```sh
+npx license-kit report --format markdown --output ./public/licenses.md
+```
+
+or
+
+```sh
+yarn license-kit report --format markdown --output ./public/licenses.md
+```
+
+This will scan your project's dependencies and generate a license report in the specified format (JSON, Markdown, raw text, or AboutLibraries-compatible JSON metadata).
+
+For a list of supported flags and the default values, run `npx license-kit --help` or read them documented [in the package's README](./packages/license-kit/README.md#command-line-options). To read more about a specific command, run `npx license-kit <command> --help`, e.g. `npx license-kit report --help`.
+
+### I want to customize the presentation of the licenses in my JS/TS project
+
+You can use the `@callstack/react-native-legal-shared` package to access the core functionalities of the license management tool. Here's a basic example of how to use it:
+
+```typescript
+import {
+  generateAboutLibrariesNPMOutput,
+  generateLicensePlistNPMOutput,
+  scanDependencies,
+} from '@callstack/react-native-legal-shared';
+
+// scan dependencies of a package
+const licenses = scanDependencies(packageJsonPath);
+
+// generate AboutLibraries-compatible JSON metadata
+const aboutLibrariesCompatibleReport = generateAboutLibrariesNPMOutput(licenses);
+
+// generate LicensePlist-compatible metadata
+const licensePlistReport = generateLicensePlistNPMOutput(licenses);
+```
+
+For more advanced usage, read the [programmatic usage documentation](https://callstackincubator.github.io/react-native-legal/docs/programmatic-usage#usage).
+
 ## Expo
 
 - ✅ You can use this library with [Development Builds](https://docs.expo.dev/development/introduction/) by adding `react-native-legal` to your `app.json`/`app.config.js` plugins array.

docs/.gitignore

@@ -12,3 +12,6 @@ doc_build/
 .vscode/*
 !.vscode/extensions.json
 .idea
+
+# @rspress/plugin-typedoc
+docs/api

docs/components/CustomHomePage.tsx

@@ -0,0 +1,101 @@
+import { usePageData } from 'rspress/runtime';
+import { Button, HomeFeature, HomeFooter, HomeHero } from 'rspress/theme';
+
+export function CustomHomePage() {
+  const {
+    page: { routePath },
+  } = usePageData();
+
+  return (
+    <>
+      <HomeHero
+        frontmatter={{
+          hero: {
+            name:
+              `<span class="hero-name">React Native Legal</span>` +
+              '<br/>' +
+              `<span class="hero-name">License Kit</span>`,
+            text: '',
+            tagline:
+              `<span class="hero-tagline" style="line-height: 1.4;">` +
+              'Automagically generate license acknowledgements' +
+              '\n' +
+              'for your <ins>React Native app</ins> & <ins>any Node.js</ins> project' +
+              `</span>`,
+            actions: [
+              { theme: 'brand', text: 'React Native', link: '/docs/react-native' },
+              { theme: 'brand', text: 'CLI', link: '/docs/standalone-cli' },
+              { theme: 'brand', text: 'API', link: '/docs/programmatic-usage' },
+              { theme: 'alt', text: 'GitHub', link: 'https://github.com/callstackincubator/react-native-legal' },
+            ],
+          },
+        }}
+        routePath={routePath}
+      />
+
+      <HomeFeature
+        frontmatter={{
+          features: [
+            {
+              title: 'Native Integration',
+              details:
+                'Uses native platform tools (LicensePlist for iOS and AboutLibraries for Android) to generate and display licenses.',
+              icon: '📱',
+              link: '/docs/react-native',
+            },
+            {
+              title: 'Expo & Bare Workflow Support',
+              details:
+                'Works with both Expo managed workflow via Config Plugin and React Native CLI via custom command.',
+              icon: '🔌',
+              link: '/docs/react-native#setup',
+            },
+            {
+              title: 'NodeJS / Non-RN Projects Support',
+              details:
+                'Works with any Node.js project, not just React Native apps. Use it to generate license reports for any Node.js application.',
+              icon: '💻',
+              link: '/docs/standalone-cli',
+            },
+            {
+              title: 'Versatile output formats (CLI & Programmatic)',
+              details:
+                'Generate license reports in a format of choice (JSON, Markdown, raw text, AboutLibraries-compatible JSON metadata).',
+              icon: '📝',
+              link: '/docs/standalone-cli#command-line-options',
+            },
+            {
+              title: 'Programmatic API',
+              details:
+                'Core functionalities are exposed as an importable package you can use programmatically and adjust the presentation / processing of the report contents.',
+              icon: '🛠️',
+              link: '/docs/programmatic-usage',
+            },
+            {
+              title: 'Automatic Scanning',
+              details:
+                'Automatically scans your dependencies and generates license information for both iOS and Android platforms.',
+              icon: '🔎',
+              link: '/docs/react-native',
+            },
+          ],
+        }}
+        routePath={routePath}
+      />
+
+      <div className="docs-introduction-cta">
+        <span
+          onClick={() => {
+            window.location.pathname = routePath + (routePath.endsWith('/') ? '' : '/') + 'docs/introduction';
+          }}
+        >
+          <Button text="Not sure, which to choose?" theme="alt" type="button" size="medium" />
+        </span>
+      </div>
+
+      <div className="home-footer-wrapper">
+        <HomeFooter />
+      </div>
+    </>
+  );
+}

docs/components/PackagesPresentation.tsx

@@ -0,0 +1,25 @@
+import { LinkCard } from 'rspress/theme';
+
+export function PackagesPresentation() {
+  return (
+    <div className="flex-intro-cards">
+      <LinkCard
+        href="/react-native-legal/docs/react-native"
+        title="React Native"
+        description="I'm using React Native, either bare (RN CLI) or with Expo and want to display a licenses screen in my app."
+      />
+
+      <LinkCard
+        href="/react-native-legal/docs/standalone-cli"
+        title="Node.js CLI"
+        description="I'm building a Node.js app or a non-React-Native project and want to generate license reports for my dependencies."
+      />
+
+      <LinkCard
+        href="/react-native-legal/docs/programmatic-usage"
+        title="Programmatic API"
+        description="I want to use the core functionalities but adjust the presentation of the license report, or process the data in a different way."
+      />
+    </div>
+  );
+}