# grunt-crosswalk

> grunt task for packaging apps into apk files

Latest version **0.0.9** (published 2016-01-18) · Apache v2 license · 0 weekly downloads

## Install

```sh
npm install grunt-crosswalk
pnpm add grunt-crosswalk
yarn add grunt-crosswalk
bun add grunt-crosswalk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2016-01-18 |
| First published | 2014-03-07 |
| Weekly downloads | 0 |
| License | Apache v2 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | davidmaxwaterman |

## Links

- npm: https://www.npmjs.com/package/grunt-crosswalk
- Repository: https://github.com/crosswalk-project/grunt-crosswalk
- Homepage: https://github.com/crosswalk-project/grunt-crosswalk#readme
- Issues: https://github.com/crosswalk-project/grunt-crosswalk/issues
- npm.io page: https://npm.io/package/grunt-crosswalk

## Dependencies (1)

- [crosswalk-app-tools](https://npm.io/package/crosswalk-app-tools.md) ~0.8.0

## Recent versions

- 0.0.9 (latest) — 2016-01-18
- 0.0.8 — 2015-07-08
- 0.0.7 — 2015-07-08
- 0.0.6 — 2014-05-09
- 0.0.5 — 2014-04-29
- 0.0.4 — 2014-03-19
- 0.0.3 — 2014-03-11
- 0.0.2 — 2014-03-07
- 0.0.1 — 2014-03-07

## README

# grunt-crosswalk

grunt-crosswalk is a grunt plugin for packaging applications into an apk so they can be installed on an android device. It builds on top of the [crosswalk-app-tools](https://github.com/crosswalk-project/crosswalk-app-tools).

# License

Apache version 2, copyright Intel Corporation Ltd. See <em>LICENSE</em> for more details.

# Contributing

Bug reports and feature requests are encouraged: please
use the [github issue tracker for the project]
(https://github.com/crosswalk-project/grunt-crosswalk/issues)
to file them.

If you are interested in contributing code to the project, please see
the <em>HACKING.md</em> file. Pull requests should be targeted at the
master branch.

# Getting started

To use grunt-crosswalk in your own project, install it with:

    npm install grunt-crosswalk --save-dev

Once the plugin has been installed, enable it with a line of JavaScript in your Gruntfile.js:

    module.exports = function (grunt) {
      grunt.loadNpmTasks('grunt-crosswalk');

      // grunt.initConfig({ ... }) etc.
    };

grunt-crosswalk has been tested on:

*   Ubuntu Linux (64bit)

# Dependencies

grunt-crosswalk depends on the [crosswalk-app-tools]
(https://github.com/crosswalk-project/crosswalk-app-tools) and shares
its dependencies.

# General configuration

The [Android SDK](http://developer.android.com/sdk/index.html) should
be installed and setup up correctly, particularly the 'android' command
should be in the PATH.

# Tasks

You can list options in the *crosswalk* target.

## Example Gruntfile.js

```
  grunt.initConfig({
    ...
    packageInfo: grunt.file.readJSON('package.json'),
    ...
    crosswalk: {
      options: {
        verbose: true, // informative output, otherwise quiet

        debug: false, // includes output of rm and cp commands (-v option)

        version: '<%= packageInfo.version %>',

        // display name for the app on the device;
        // the sanitisedName used to construct the Locations object later
        // is derived from this
        name: '<%= packageInfo.name %>',

        // package for the app's generated Java files; this works best if
        // you have at least one period character between two character
        // strings, and no digits
        pkg: 'org.org01.webapps.<%= packageInfo.name.toLowerCase() %>',

        // the icon used in the android launcher/etc
        icon: 'icon_128.png',

        // path to the directory containing your HTML5 app;
        // note that this must use the correct path separators for your
        // platform: Windows uses '\\' while Linux uses '/'
        appRoot: 'build/apk'
      },
     }
      ...
    },
    ...
  }
```

---
_Source: https://npm.io/package/grunt-crosswalk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
