https://github.com/markknol/hxnew
Create new Haxe projects in a blast
https://github.com/markknol/hxnew
bootstrap bootstrapping haxe project-generation project-template projects tool
Last synced: about 1 month ago
JSON representation
Create new Haxe projects in a blast
- Host: GitHub
- URL: https://github.com/markknol/hxnew
- Owner: markknol
- Created: 2016-10-23T19:59:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-22T12:17:28.000Z (almost 5 years ago)
- Last Synced: 2025-03-25T15:21:51.164Z (about 2 months ago)
- Topics: bootstrap, bootstrapping, haxe, project-generation, project-template, projects, tool
- Language: Haxe
- Size: 181 KB
- Stars: 23
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# hxnew
[](https://travis-ci.org/markknol/hxnew)
[](http://lib.haxe.org/p/hxnew)
> Create new Haxe projects in a blast!
> This tool is meant to create a plain Haxe project. Run it once.
## Installation
Install using [haxelib](http://lib.haxe.org/p/hxnew):
```
haxelib install hxnew
```
## How to use
#### `haxelib run hxnew -name MyProject`
This will create a js project with this directory structure:
```
MyProject/bin/index.html
MyProject/src/Main.hx
MyProject/.gitignore
MyProject/.travis.yml
MyProject/build.hxml
MyProject/haxelib.json
MyProject/makefile
MyProject/README.md
MyProject/release_haxelib.sh
MyProject/MyProject.hxproj
```
#### `haxelib run hxnew -name MyProject -pack com.company.tool`
This will create a js project with same directory structure as above but the Main class located in the com.company.tool package.
```
MyProject/src/com/company/tool/Main.hx
```
#### `haxelib run hxnew -name MyProject -target neko,nodejs -lib hxargs,format`
This will create a neko + nodejs project with this directory structure:
```
MyProject/bin/
MyProject/src/Main.hx
MyProject/.gitignore
MyProject/.travis.yml
MyProject/build-neko.hxml
MyProject/build-nodejs.hxml
MyProject/haxelib.json
MyProject/install.hxml
MyProject/makefile
MyProject/README.md
MyProject/run-neko.hxml
MyProject/run-nodejs.hxml
MyProject/release_haxelib.sh
MyProject/MyProject.hxproj
```
#### `haxelib run hxnew -name MyProject --lix`
This will create a [lix.pm](https://github.com/lix-pm/lix.client) project. It creates a package.json and requires all libraries using lix!
> Notes:
> * When providing a lib, an install.hxml is created. Run this to install the project dependencies.
> * The run files start the process to run the code
## Command line help
```
[-name | -n] : Name of the project. required
[-include | -i] : Folder to include in project
[-out] : Project out folder. default: same as name
[-src] : Class path source folder. default: 'src'
[-cp] : Additional class path
[-bin] : Output folder. default: 'bin'
[-lib | -libs] : Libs used in the project, comma separate
[-target | -t] : Target languages, comma separate. Or "all" for all targets. Default: 'js'
[-pack] : Package of the entry point
[--lix] : Use Lix.pm. Assumes global available `npm` command
[--makefile] : Generate a makefile
[--no-haxedevelop] : Don't generate HaxeDevelop project files
[--no-main] : Don't generate a Main.hx file
[--no-readme] : Don't generate README.md
[--no-gitignore] : Don't generate .gitignore
[--no-haxelib-json] : Don't generate a haxelib.json
[--no-travis] : Don't generate Travis files
[--version | -v] : Log version
```