crystal/scripts/README.md
2025-06-16 15:22:30 -04:00

37 lines
1.1 KiB
Markdown

# Scripts Directory
This directory contains build and maintenance scripts for the Crystal application.
## generate-notices.js
Generates a NOTICES file containing all third-party licenses for dependencies included in the Crystal distribution.
### Usage
```bash
# Generate NOTICES file
pnpm run generate-notices
# Or run directly
node scripts/generate-notices.js
```
### How it works
1. Scans all node_modules directories in the workspace
2. Collects license information from LICENSE files and package.json
3. Excludes development-only dependencies that aren't distributed
4. Creates a NOTICES file in the project root
### When to run
- Automatically runs during `pnpm run build:mac` and `pnpm run release:mac`
- Should be run whenever dependencies change
- CI/CD runs this in the license-compliance workflow
### License compliance
The script helps ensure Crystal complies with open source license requirements by:
- Including all third-party license texts in distributions
- Identifying packages with missing license information
- Supporting the license-compliance GitHub workflow