Have ideas to improve npm?Join in the discussion! »

    flipper-pkg
    TypeScript icon, indicating that this package has built-in type declarations

    0.86.0 • Public • Published

    flipper-pkg

    flipper-pkg is a tool for bundling and publishing Flipper plugins.

    Usage

    $ npm install -g flipper-pkg
    $ flipper-pkg COMMAND
    running command...
    $ flipper-pkg (-v|--version|version)
    flipper-pkg/0.86.0 linux-x64 node-v12.22.1
    $ flipper-pkg --help [COMMAND]
    USAGE
      $ flipper-pkg COMMAND
    ...

    Commands

    flipper-pkg bundle [DIRECTORY]

    transpiles and bundles plugin

    USAGE
      $ flipper-pkg bundle [DIRECTORY]
    
    ARGUMENTS
      DIRECTORY  [default: .] Path to plugin package directory for bundling. Defaults to the current working directory.
    
    OPTIONS
      --production  Force env.NODE_ENV=production, enable minification and disable producing source maps.
      --watch       Watch for plugin source code and bundle it after every change.
    
    EXAMPLE
      $ flipper-pkg bundle path/to/plugin
    

    See code: src/commands/bundle.ts

    flipper-pkg checksum [DIRECTORY]

    computes the total checksum of all the package files

    USAGE
      $ flipper-pkg checksum [DIRECTORY]
    
    ARGUMENTS
      DIRECTORY  [default: .] Path to plugin package directory. Defaults to the current working directory.
    
    EXAMPLE
      $ flipper-pkg checksum path/to/plugin
    

    See code: src/commands/checksum.ts

    flipper-pkg help [COMMAND]

    display help for flipper-pkg

    USAGE
      $ flipper-pkg help [COMMAND]
    
    ARGUMENTS
      COMMAND  command to show help for
    
    OPTIONS
      --all  see all commands in CLI
    

    See code: @oclif/plugin-help

    flipper-pkg init [DIRECTORY]

    initializes a Flipper desktop plugin template in the provided directory

    USAGE
      $ flipper-pkg init [DIRECTORY]
    
    ARGUMENTS
      DIRECTORY  [default: .] Path to the directory where the plugin package template should be initialized. Defaults to the
                 current working directory.
    
    EXAMPLE
      $ flipper-pkg init path/to/plugin
    

    See code: src/commands/init.ts

    flipper-pkg lint [DIRECTORY]

    validates a plugin package directory

    USAGE
      $ flipper-pkg lint [DIRECTORY]
    
    ARGUMENTS
      DIRECTORY  [default: .] Path to plugin package directory for linting. Defaults to the current working directory.
    
    EXAMPLE
      $ flipper-pkg lint path/to/plugin
    

    See code: src/commands/lint.ts

    flipper-pkg migrate [DIRECTORY]

    migrates a Flipper desktop plugin to the latest version of specification

    USAGE
      $ flipper-pkg migrate [DIRECTORY]
    
    ARGUMENTS
      DIRECTORY  [default: .] Path to the plugin directory. Defaults to the current working directory.
    
    OPTIONS
      --no-dependencies  Do not add or change package dependencies during migration.
      --no-scripts       Do not add or change package scripts during migration.
    
    EXAMPLE
      $ flipper-pkg migrate path/to/plugin
    

    See code: src/commands/migrate.ts

    flipper-pkg pack [DIRECTORY]

    packs a plugin folder into a distributable archive

    USAGE
      $ flipper-pkg pack [DIRECTORY]
    
    ARGUMENTS
      DIRECTORY  [default: .] Path to plugin package directory to pack. Defaults to the current working directory.
    
    OPTIONS
      -o, --output=output  [default: .] Where to output the package, file or directory. Defaults to the current working
                           directory.
    
      --production         Force env.NODE_ENV=production, enable minification and disable producing source maps.
    
    EXAMPLE
      $ flipper-pkg pack path/to/plugin
    

    See code: src/commands/pack.ts

    License

    MIT

    Keywords

    Install

    npm i flipper-pkg

    DownloadsWeekly Downloads

    2,144

    Version

    0.86.0

    License

    MIT

    Unpacked Size

    98.6 kB

    Total Files

    78

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar