Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for bundling Handsontable^7.0.0 #30

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Add support for bundling Handsontable^7.0.0 #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a30667
Add support for bundling Handsontable^7.0.0
budnix Dec 7, 2018
22d203e
Fix building Handsontable with Pro plugins
budnix Dec 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A CLI tool for building custom [Handsontable](https://github.com/handsontable/ha

## Installation

Install the tool using [npm](http://npmjs.com/).
Install the tool using [npm](https://npmjs.com/).

```sh
npm install hot-builder -g
Expand All @@ -23,14 +23,13 @@ npm install hot-builder -g
Builds custom version of handsontable.

Arguments:
- ```-i, --input``` - Path to a directory where Handsontable Community Edition or Handsontable PRO repository was downloaded.
- ```-i, --input``` - The path to a directory where Handsontable repository was downloaded.
- ```-o, --output-dir``` - Output directory where generated bundle will be saved.
- ```-a, --include-all``` - Includes all found modules into generated bundle.
- ```-A, --add-module``` - Includes specified modules into generated bundle (eg. `-A ContextMenu,ManualRowMove`).
- ```-R, --remove-module``` - Excludes specified modules from generated bundle (eg. `-R ContextMenu,ManualRowMove`).
- ```-a, --include-all``` - Includes all found modules into a generated bundle.
- ```-A, --add-module``` - Includes specified modules into a generated bundle (eg. `-A ContextMenu,ManualRowMove,TrimRows`).
- ```-R, --remove-module``` - Excludes specified modules from a generated bundle (eg. `-R ContextMenu,ManualRowMove,TrimRows`).
- ```-U, --no-ui``` - Disables the UI.
- ```--repository-tag``` - Specifies which version of Handsontable Community Edition or Handsontable PRO repository will be cloned (eg. `--repository-tag develop`, or `--repository-tag 0.32.0`). This option is active only if you omitted `-i`, `--input` argument.
- ```--pro``` - Indicates that version specified by `--repository-tag` argument will be referring to the Handsontable PRO package.
- ```--repository-tag``` - Specifies which version of Handsontable repository will be cloned (eg. `--repository-tag develop`, or `--repository-tag 7.0.0`). This option is active only if you omitted `-i`, `--input` argument.
- ```--debug``` - Debug mode - will output debug messages from workers.

##### ```> hot-builder -h```
Expand All @@ -43,13 +42,13 @@ Prints the installed `hot-builder` version.

## Examples

Build your custom handsontable Community Edition package (from the handsontable remote repository)
Build your custom Handsontable package (from the Handsontable remote repository)

```sh
$ hot-builder build -o hot-dist
```

Or build your custom handsontable Community Edition package using a local directory
Or build your custom Handsontable package using a local directory

```sh
$ hot-builder build -i path-to-your-handsontable-copy/ -o hot-dist
Expand All @@ -59,15 +58,15 @@ After executing command and selecting plugins, the builder automatically resolve

If it works correctly, you should see something like:

![hot-builder #1](http://i.imgur.com/huCCrWj.png)
![hot-builder #1](https://i.imgur.com/huCCrWj.png)
![hot-builder #1](https://i.imgur.com/B7xwiLy.png)

Additional examples:

- [Building Handsontable Community Edition package from the remote repository](https://asciinema.org/a/117465)
- [Building Handsontable Community Edition package from a local directory](https://asciinema.org/a/117464)
- [Building Handsontable package from the remote repository](https://asciinema.org/a/117465)
- [Building Handsontable package from a local directory](https://asciinema.org/a/117464)
- [Building Handsontable PRO package from the remote repository](https://asciinema.org/a/117462)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update this line after Handsontable 7.0.0 release.

- [Building Handsontable Community Edition package with specified plugins only](https://asciinema.org/a/117466)
- [Building Handsontable package with specified plugins only](https://asciinema.org/a/117466)

## License
`hot-builder` is released under the [MIT license](https://github.com/handsontable/hot-builder/blob/master/LICENSE).
Expand Down
Loading