Nimble Prime Musketeers

    react-native-oss-license

    0.6.0 • Public • Published

    react-native-oss-license

    npm badge
    react-native-oss-license is license list generator for React Native App(iOS & Android).
    It generates license lists of npm libraries for iOS, Android.
    This CLI tool allow you to easily generate content of oss-license.

    Installation

    npm i -g react-native-oss-license

    Sample App

    Usage

    iOS

    Recommended to use with LicensePlist that scan cocoaopds, carthage.

    LicensePlist

    react-native-oss-license generate plist that you can locate to Settings.bundle.
    Run react-native-oss-license --format settings-bundle when your are in the directory that contains package.json You can merge output react-native-oss-license and LicensePlist.

    Android

    It is assumed to be used with other tools.

    LicenseToolsPlugin

    License Tools Plugin for Android is Gradle plugin to check library licenses and generate license pages.
    Run react-native-oss-license --format license-tools-plugin. It generate license list in YAML format.
    react-native-oss-license generate same format content. You can merge results.

    AboutLibraries

    AboutLibraries provides fragment/activity that show license list.
    react-native-oss-license generate string resource xml AboutLibraries use.
    Run react-native-oss-license --format about-libraries, output strings.xml that you can put into res/values/.
    and output stdout withLibraries("package_name_A", "package_name_B" ...) that pass to method withLibraries.

    CLI

    > cd {project-root}
    > react-native-oss-license --help
    Usage: react-native-oss-license [options]
    
    Options:
      -f, --format <format>       output format. options:[settings-bundle,license-tools-plugin,about-libraries]
      --dev                       include devDependencies (default: false)
      --depth <depth>             dependencies depth (default: null)
      --output-path <outputPath>  specify path where output file
      --json                      output json to stdout (default: false)
      --add-version-number        write library version number (default: false)
      --only-direct-dependency    output only dependencies you write packages.json. (default: false)
      --skip-not-required         skip licenses those not require copyright notice (default: false)
      --bundle-id <bundleId>      unique id of your app.  It is used for output such as "plist" filename, etc. (default: null)
      --uses-plugin               whether AboutLibraries android plugin is used on native side as well (default: false)
      --version                   show current version
      -h, --help                  output usage information
    
    > react-native-oss-license --format settings-bundle
    output settings-bundle format to 'ios/com.k-tomoyasu.react-native-oss-license.Output'

    screen-shots

    iOS

    settings-bundle-list settings-bundle-detail

    Android

    license-tools-plugin

    license-tools-plugin

    AboutLibraries

    about-libraries

    Acknowledgment

    This is based on dart-oss-licenses consepts.
    And referred license-list.

    Install

    npm i react-native-oss-license

    DownloadsWeekly Downloads

    922

    Version

    0.6.0

    License

    MIT

    Unpacked Size

    340 kB

    Total Files

    6

    Last publish

    Collaborators

    • k-tomoyasu