generator-ko-spa

    1.2.0 • Public • Published

    generator-ko-spa

    NPM MIT Travis CodeClimate Test Coverage Dependency Status

    Quickly scaffold out webpack + KnockoutJS SPAs, complete with testing (via karma & tape)

    Supports ES2015 and incremental loading ootb 💥 🎉

    Includes jquery, lodash, knockout-punches & knockout-fast-foreach by default because you probably want them.

    $ npm install -g yo generator-ko-spa
     
    ...
     
    $ mkdir my-app && cd my-app
    $ yo ko-spa & yo ko-spa:view home /
    $ npm run serve

    Generators

    app [entry]

    Generates the basic app structure.

    When optional entry parameter is supplied, multi entry points are enabled and the app will be created in a subdirectory.

    This can only be done the first time the app generator is ran, unless you want to go tweaking files later (which isn't difficult, but nice is avoided.)

    view [entry] name route

    Generates a new view (component) with the given route.

    If the project is using multiple entry points, entry will be required.

    binding name

    Generates a new binding.

    component name

    Generates a new component.

    extender name

    Generates a new extender.

    filter name

    Generates a new knockout-punches filter.

    util name

    Generates a new utility.

    Scripts

    These are all available via npm run <cmd>

    build webpack

    Builds the project

    build:prod webpack -p

    Builds the project for production

    watch webpack --watch

    Builds the project once and rebuilds on change.

    watch:prod

    Same as watch, but with -p

    serve

    Serves app via webpack-dev-server (caution: webpack's docs suck. that's why this project exists.)

    serve:prod

    Same as serve, but with -p

    Note: You wouldn't actually want to use this in production.

    test

    Runs the tests.

    coverage

    Runs the tests and generates code coverage.

    Install

    npm i generator-ko-spa

    DownloadsWeekly Downloads

    1

    Version

    1.2.0

    License

    MIT

    Last publish

    Collaborators

    • caseywebb