fusepm

    0.2.6 • Public • Published

    fusepm - A Fusetools package manager

    Build Status NPM Version

    Installation

    $ npm install -g fusepm
    

    Usage

     Usage: fusepm [options] [command]
    
    
     Commands:
    
       install <module>  install fuse module
       list              modules in registry
       bump <release>    bump version
       fixunoproj        fix the unoproj
       npm <module...>   make npm module(s) ready for fuse (experimental)
    
     Options:
    
       -h, --help                output usage information
       -V, --version             output the version number
       -p, --unoproj [filename]  Specify .unoproj file
    

    CLI usage examples

    List modules in registry

    $ fusepm list
    Registered fuse modules:
    ========================
    datepicker
    barcodescanner
    cachingimagesource
    camerapanel
    contacts
    dropbox
    emacs
    facebook-login
    gallery
    onetimepassword
    qreader
    fontawesome
    ...

    Install registered module

    fusepm install gallery

    You can also directly reference a git repo location:

    fusepm install https://github.com/bolav/fuse-datepicker

    The gallery module (library) will be installed by copying the git repo into fuse_modules/<account> where account is the git user account such as bolav.

    The application .unoproj file will be updated with the following:

      "Projects": [
        "fuse_modules/bolav/fuse-datepicker/datepicker_include.unoproj"
      ],
      "Excludes": [
        "fuse_modules/"
      ],
      "FusePM": {
        "Dependencies": [
          "https://github.com/bolav/fuse-datepicker"
        ]
      }
    

    Each Projects entry will merge that project into the main project so it can be referenced as though it was part of the root project.

    Updating module registry

    Update the module registry with additional official/community modules in /registry/index.js. Make sure it always exports an Object where the keys are the names of each module and the value the URI for where to fetch and clone the files.

    module.exports = {
      "datepicker": "https://github.com/bolav/fuse-datepicker",
      // ...
    }

    Local use and debug/development

    • Fork/clone this repo
    • npm link
    • Use as outlined above

    Creating a library

    The docs in uno-projects mention the concept of Fuse libraries.

    "An Uno project can either be a library project consisting of assets and components for use in other projects, or an actual app project. The presence of an App class in the project indicates that the project is an app project."

    The fusepm tool is a way to import Fuse libraries into your project using the following conventions.

    A for a library to work with fusepm, it must have a <xyz>_include.unoproj file such as sqlite_include.unoproj in fuse-sqlite

    The library <xyz>_include.unoproj file can include one or more .ux files without an <App> tag. These tags (components) will be available in the App .ux file of the application project just like if they had been created there. Libraries makes it easy to partition your app into smaller parts, such as a library per page or libraries for view components to be reused/shared across multiple apps.

    Example: Creating loginscreen reusable library

    loginscreen_include.unoproj file

      "Includes": [
        "*.uno",
        "*.uxl",
        "LoginScreen.ux",
    

    LoginScreen.ux file

    <Page ux:Class="LoginScreen">
      <Router ux:Dependency="router" />
      ...
    </Page>
    

    Using LoginScreen from loginscreen library, imported into an app:

    <PageControl Active="login">
      <LoginScreen ux:Name="login" router="router"/>
    </PageControl>
    

    Alternatively you can include using ux:Include if the .ux file is completely self-contained

    <PageControl Active="login">
      <ux:Include File="LoginScreen.ux"/>
    </PageControl>
    

    TODO

    • Add lib command to create a new fusepm library project that follows conventions
    • Allow install of multiple modules in one command
    • Allow install of a pre-defined collection of modules

    Keywords

    Install

    npm i fusepm

    DownloadsWeekly Downloads

    14

    Version

    0.2.6

    License

    ISC

    Last publish

    Collaborators

    • bolav