hotballoon-shed

Test, Develop, Manage, Generate sources, Build Hotballoon applications

version latest : webpack5 version <= 1.43.0 : webpack4

Installation

https://github.com/flexiooss/hotballoon-shed-playbook

before usage : ensure you have your settings with de right access for codingmatters-realeases repository

if dev web server watch file is too short :

 echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

Configuration

package.json

For an application

{
  "hotballoon-shed": {
    "build": {
      "builder": "webpack5",
      "entries": [
        "src/js/bootstrap.js"
      ],
      "html_template": "src/js/index.html",
      "output": "./dist",
      "output-type": "production" //production*|debug
    },
    "generate-sources": {
      "value-objects": {
        "extension": ".spec"
      }
    },
    "dev": {
      "entries": [
        "src/js/bootstrap.js"
      ]
    },
    "test": {
      "tester": "code-altimeter-js",
      "path": "src/test"
    }
  }
}

Declare a PWA

NB : default config

{
  "hotballoon-shed": {
    "build": {
      "application": {
        "name": "Flexio application",
        "short_name": "Flexio",
        "description": "Flexio application by flexio.fr",
        "display": "standalone", // fullscreen | standalone | minimal-ui | browser
        "crossorigin": "use-credentials",  // null | use-credentials | anonymous
        "theme_color": "#eea900",
        "background_color": "#3e4b53",
        "orientation": "landscape",// any | natural | landscape | landscape-primary | landscape-secondary | portrait | portrait-primary | portrait-secondary
        "start_url": "/"
      },
      "builder": "webpack5",
      "entries": [
        "src/js/bootstrap.js"
      ],
      "html_template": "src/js/index.html",
      "html_template_name": "flexio-loader", // flexio-loader | flexio-loader-embeded | minimal
      "output": "./dist"
    }
  }
}

For a package

{
  "hotballoon-shed": {
    "build": {
      "builder": "webpack5"
    },
    "test": {
      "tester": "code-altimeter-js",
      "path": "src/test"
    },
    "generate-sources": {
      "value-objects": {
        "extension": ".spec"
      }
    }
  }
}

Modules

The main purpose of this module manager is only to ensure the consistency of the versions of the project packages without breaking the npm philosophy.

Configuration example for this following folder structure

pakage-a
|- package-b
|- package-c
   |-package-d

package-a

{
    "name": "package-a",
    "version": "1.0.0",
    "devDependencies": {
      "dependency-a": "latest"
    },
    "dependencies": {
      "dependency-b": "latest"
    },
    "hotballoon-shed": {
        "modules": [
        "package-b",
        "package-c"
        ]
      }
}

It is possible to declare an external parent with an optional version

{
    "name": "package-a",
    "version": "1.0.0",
    "devDependencies": {
      "dependency-a": "latest"
    },
    "dependencies": {
      "dependency-b": "latest"
    },
    "hotballoon-shed": {
        "module": {
            "parent": {
                "name": "my-external-parent",
                "version": "0.0.0",
                "external": true
            }
        },
        "modules": [
        "package-b",
        "package-c"
        ]
      }
}

It is possible to declare an external parent with dependencies

{
    "name": "package-a",
    "version": "1.0.0",
    "devDependencies": {
      "dependency-a": "latest"
    },
    "dependencies": {
      "dependency-b": "latest"
    },
    "hotballoon-shed": {
        "module": {
            "parent": {
                "name": "my-external-parent",
                "version": "0.0.0",
                "external": true
            },
            "dependencies": ["my-external-dep"]
        },
        "modules": [
        "package-b",
        "package-c"
        ]
      }
}

package-c

{
    "name": "package-c",
    "hotballoon-shed": {
        "module" : {
            "parent": {
              "name" : "package-a"        
            },
            "devDependencies": ["dependency-a"],
            "dependencies": ["dependency-b"]
        },
        "modules": ["package-d"]
      }
}

It is possible to declare parent version with :

{
    "name": "package-c",
    "hotballoon-shed": {
        "module" : {
            "parent": {
              "name" : "package-a",
              "version": "1.0.0"        
            },
            "devDependencies": ["dependency-a"],
            "dependencies": ["dependency-b"]
        },
        "modules": ["package-d"]
      }
}

dev server config

Choose your server config option with

hbshed dev server-config stack
hbshed dev server-config local

or set a configuration used with

hbshed dev 

{
  "hotballoon-shed": {
    "dev": {
      "server": {
        "host": "172.17.0.1",
        "disableHostCheck": true,
        "publicPath": "/",
        "public": "https://dev.flexio.io/devui",
        "sockPath": "/socketjs",
        "proxy": [
          {
            "context": [
              "//[a-z]+/*"
            ],
            "logLevel": "debug",
            "target": "https://dev.flexio.io/devui",
            "secure": false,
            "pathRewrite": {
              "^//[a-z]+/*": "/"
            }
          }
        ]
      }
    }
  }
}

html template

Choose html template

hbshed dev --html-template ./my/path/to/template.html
hbshed dev --html-template-name local-dev-minimal

or set a configuration used with

hbshed dev 

{
  "hotballoon-shed": {
    "dev": {
      "html_template" : "./my/path/to/template.html",
      "html_template_name" : "local-dev-minimal"  // local-dev-minimal|stack-dev-minimal
    }
  }
}

Usage

hbshed --help