Skip to content

Commit 293a593

Browse files
authored
chore: rename @callstack/react-native-legal-shared to @callstack/licenses (#64)
* chore: rename @callstack/react-native-legal-shared to @callstack/licenses-api * chore: added changeset
1 parent 6780d77 commit 293a593

11 files changed

Lines changed: 37 additions & 23 deletions

File tree

.changeset/cool-sheep-unite.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@callstack/licenses': patch
3+
---
4+
5+
Rename API package to @callstack/licenses

.github/workflows/test-unit-shared.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ concurrency: ${{ github.workflow }}-${{ github.ref }}
1818

1919
jobs:
2020
unit-test-shared:
21-
name: Run unit tests for @callstack/react-native-legal-shared
21+
name: Run unit tests for @callstack/licenses
2222
runs-on: ubuntu-latest
2323
steps:
2424
- name: Checkout Repo
@@ -30,4 +30,4 @@ jobs:
3030
uses: ./.github/actions/setup
3131

3232
- name: Run unit tests
33-
run: yarn workspace @callstack/react-native-legal-shared test
33+
run: yarn workspace @callstack/licenses test

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ To get started with the project, run `yarn` in the root directory to install the
1010
yarn
1111
```
1212

13-
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:
13+
All packages in this monorepo depend on the [shared package](packages/shared) (`@callstack/licenses`). 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:
1414

1515
```sh
16-
yarn workspace @callstack/react-native-legal-shared dev
16+
yarn workspace @callstack/licenses dev
1717
```
1818

1919
While developing, you will have 2 example apps that can be used to test your changes.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,13 @@ npm i --save-dev license-kit
7171
### Node.js - API
7272

7373
```sh
74-
yarn add -D @callstack/react-native-legal-shared
74+
yarn add -D @callstack/licenses
7575
```
7676

7777
or
7878

7979
```sh
80-
npm i --save-dev @callstack/react-native-legal-shared
80+
npm i --save-dev @callstack/licenses
8181
```
8282

8383
## Usage
@@ -181,7 +181,7 @@ For a list of supported flags and the default values, run `npx license-kit --hel
181181

182182
### I want to customize the presentation of the licenses in my JS/TS project
183183

184-
You can use the `@callstack/react-native-legal-shared` package to access the core functionalities of the license management tool. To do so, please read the [programmatic usage documentation](https://callstackincubator.github.io/react-native-legal/docs/programmatic-usage#usage).
184+
You can use the `@callstack/licenses` package to access the core functionalities of the license management tool. To do so, please read the [programmatic usage documentation](https://callstackincubator.github.io/react-native-legal/docs/programmatic-usage#usage).
185185

186186
## Expo
187187

docs/docs/docs/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ React Native Legal (`react-native-legal`) helps you acknowledge open-source libr
1414

1515
We expose the core functionality related to Node.JS dependencies as a standalone CLI tool, `license-kit`, which can be used in any Node.js project, not just React Native apps. This allows you to generate license reports for any Node.js application.
1616

17-
In case your use case involves programmatic usage of the functionality provided by `license-kit`, you can use the `@callstack/react-native-legal-shared` package. This package exposes the core functionalities of the license management tool, allowing you to integrate it into your Node.js applications.
17+
In case your use case involves programmatic usage of the functionality provided by `license-kit`, you can use the `@callstack/licenses` package. This package exposes the core functionalities of the license management tool, allowing you to integrate it into your Node.js applications.

docs/docs/docs/programmatic-usage.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ import { PackageManagerTabs, Badge } from '@theme';
66

77
# Programmatic Usage (API)
88

9-
In case your use case involves programmatic usage of the functionality provided by `license-kit`, you can use the `@callstack/react-native-legal-shared` package. This package exposes the core functionalities of the license management tool, allowing you to integrate it into your Node.js applications.
9+
In case your use case involves programmatic usage of the functionality provided by `license-kit`, you can use the `@callstack/licenses` package. This package exposes the core functionalities of the license management tool, allowing you to integrate it into your Node.js applications.
1010

1111
## Installation
1212

1313
To get started, install the package using your preferred package manager:
1414

1515
<PackageManagerTabs
1616
command={{
17-
npm: 'npm install -D @callstack/react-native-legal-shared',
18-
pnpm: 'pnpm add -D @callstack/react-native-legal-shared',
19-
yarn: 'yarn add -D @callstack/react-native-legal-shared',
20-
bun: 'bun add -d @callstack/react-native-legal-shared',
17+
npm: 'npm install -D @callstack/licenses',
18+
pnpm: 'pnpm add -D @callstack/licenses',
19+
yarn: 'yarn add -D @callstack/licenses',
20+
bun: 'bun add -d @callstack/licenses',
2121
}}
2222
/>
2323

@@ -31,7 +31,7 @@ import {
3131
generateLicensePlistNPMOutput,
3232
scanDependencies,
3333
Types,
34-
} from '@callstack/react-native-legal-shared';
34+
} from '@callstack/licenses';
3535
import * as md from 'ts-markdown-builder';
3636

3737
// apart from dependencies, also include devDependencies, but only from the root package.json;

docs/docs/docs/react-native.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ On **iOS**, all detected licenses will also appear in the **Settings app** under
8888
If you want to use the license management functionality in a Node.js project or any non-React Native application, you can either:
8989

9090
- use the `license-kit` CLI tool, which is a standalone tool that can be used in any Node.js project to generate license metadata - see [this section](/docs/standalone-cli) for more details
91-
- programmatically use the `@callstack/react-native-legal-shared` package, which exposes the core functionalities of this tool - see [this section](/docs/programmatic-usage) for more details
91+
- programmatically use the `@callstack/licenses` package, which exposes the core functionalities of this tool - see [this section](/docs/programmatic-usage) for more details
9292

9393
## Additional details
9494

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
]
99
},
1010
"scripts": {
11-
"build:library": "yarn workspace @callstack/react-native-legal-shared build && yarn workspace react-native-legal build-plugins && yarn workspace license-kit build-library && yarn workspace react-native-legal build-library",
11+
"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",
1212
"lint:js": "eslint \"**/*.{js,ts,tsx}\"",
1313
"typescript": "yarn build:library && tsc --noEmit -p examples/bare-example/tsconfig.json && tsc --noEmit -p examples/expo-example/tsconfig.json",
1414
"lint:android": "./scripts/lint-android.sh",

packages/shared/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @callstack/react-native-legal-shared
1+
# @callstack/licenses
22

33
## Features
44

@@ -9,20 +9,20 @@
99
## Installation
1010

1111
```bash
12-
npm install @callstack/react-native-legal-shared
12+
npm install @callstack/licenses
1313
```
1414

1515
## Programmatic Usage
1616

17-
You can use `@callstack/react-native-legal-shared` programmatically in your Node.js applications. Here's a basic example of how to use it:
17+
You can use `@callstack/licenses` programmatically in your Node.js applications. Here's a basic example of how to use it:
1818

1919
```typescript
2020
import {
2121
generateAboutLibrariesNPMOutput,
2222
generateLicensePlistNPMOutput,
2323
scanDependencies,
2424
Types,
25-
} from '@callstack/react-native-legal-shared';
25+
} from '@callstack/licenses';
2626
import * as md from 'ts-markdown-builder';
2727

2828
// apart from dependencies, also include devDependencies, but only from the root package.json;

packages/shared/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@callstack/react-native-legal-shared",
2+
"name": "@callstack/licenses",
33
"version": "0.2.0",
44
"description": "Shared code for all packages",
55
"main": "build/index",

0 commit comments

Comments
 (0)