{"id":13912533,"url":"https://github.com/HaxeFoundation/npm-haxe","last_synced_at":"2025-07-18T12:31:11.062Z","repository":{"id":57261837,"uuid":"44110239","full_name":"HaxeFoundation/npm-haxe","owner":"HaxeFoundation","description":"Install Haxe using Node Package Manager aka npm","archived":false,"fork":false,"pushed_at":"2024-05-26T04:34:11.000Z","size":77,"stargazers_count":46,"open_issues_count":6,"forks_count":19,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-06-17T03:44:18.948Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HaxeFoundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-10-12T13:49:39.000Z","updated_at":"2025-05-15T08:09:13.000Z","dependencies_parsed_at":"2024-06-18T16:42:19.828Z","dependency_job_id":"3bf937d0-1165-4ea7-8c50-87144d3fb55e","html_url":"https://github.com/HaxeFoundation/npm-haxe","commit_stats":{"total_commits":109,"total_committers":17,"mean_commits":6.411764705882353,"dds":0.7064220183486238,"last_synced_commit":"dda49270194224832e8fe205446b1ec9be6ef5e2"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/HaxeFoundation/npm-haxe","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fnpm-haxe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fnpm-haxe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fnpm-haxe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fnpm-haxe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HaxeFoundation","download_url":"https://codeload.github.com/HaxeFoundation/npm-haxe/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fnpm-haxe/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265673732,"owners_count":23809154,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-07T01:01:32.132Z","updated_at":"2025-07-18T12:31:10.753Z","avatar_url":"https://github.com/HaxeFoundation.png","language":"JavaScript","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"# npm-haxe v5\n[![TravisCI Build Status](https://travis-ci.org/HaxeFoundation/npm-haxe.svg?branch=master)](https://travis-ci.org/HaxeFoundation/npm-haxe)\n[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/HaxeFoundation/npm-haxe?branch=master\u0026svg=true)](https://ci.appveyor.com/project/HaxeFoundation/npm-haxe)\n[![dependencies Status](https://david-dm.org/HaxeFoundation/npm-haxe/status.svg)](https://david-dm.org/HaxeFoundation/npm-haxe)\n\nInstalls [Haxe](http://haxe.org) using [Node Package Manager](https://www.npmjs.com/) aka `npm` \n\n**WARNING : The version contains breaking changes from npm-haxe v4**\n\n## Key-features\n\n* Global or per-project, sandboxed, standard Haxe installation\n* Includes [Haxelib](http://lib.haxe.org/)\n* Includes [Neko](https://nekovm.org)\n* Support both Haxelib and NPM dependencies \n* Tested on Ubuntu/Linux and Windows\n\n## Usage\n\n### CLI installation\n\n```bash\nnpm install haxe\n```\n\nBy default, this will make `haxe` and `haxelib` available to [npm scripts](https://docs.npmjs.com/misc/scripts) only,\nwith haxelib repository sandboxed to your current working directory.\n\nTo have `haxe` and `haxelib` commands available globally, use the `-g` flag.\nThis will also make the haxelib repo global.\n\n### Package.json sample\n\n```js\n{\n  \"scripts\":{\n    \"postinstall\": \"haxelib --always install build.hxml\",\n    \"build\": \"haxe build.hxml\"\n  },\n  \"dependencies\": {\n    \"haxe\": \"^5.0.0\" // the npm haxe module\n  },\n \"haxeDependencies\": {\n   \"haxe\": \"3.4.7\", // haxe version\n   \"haxelib\": \"3.3.0\", // haxelib version\n   \"neko\": \"2.2.0\", // neko version\n   \"pixijs\": \"4.5.5\", // additionnal haxelib dependency\n   \"tamina\": \"git+https://github.com/damoebius/taminahx.git\" //haxelib git dependency\n }\n}\n```\n\nPlease notice the `--always` flag in the `haxelib` command, to avoid having to confirm haxelibs installation.\n\n### Running Haxe from NodeJS\n\nThis package also comes with the minimal bindings to run the Haxe compiler from NodeJS.\n\n\n```js\nvar haxe = require('haxe').haxe;\nvar haxelib = require('haxe').haxelib;\n\n// all commands return a ChildProcess instance\n\nhaxe( \"-version\" );\nhaxelib( \"install\", \"hxnodejs\" );\n\nvar server = haxe(\"--wait\", \"6000\");\n```\n\nSee also [test.js](https://github.com/HaxeFoundation/npm-haxe/blob/master/test/test.js)\n\n\n### Configuration options\n\nThe following configuration options can be set in your package.json. \n\nPlease note they must be set before installing the package.\n\n```json\n\"haxeDependencies\": {\n   \"haxe\": \"3.4.7\",\n   \"haxelib\": \"3.3.0\",\n   \"neko\": \"2.2.0\",\n   \"pixijs\": \"4.5.5\",\n   \"perfjs\": \"1.1.18\"\n }\n```\n\n#### Version\n\nSee [Haxe Download list](http://haxe.org/download/list/).\nPlease notice the directory name in the archive must match.\n\nIn this case, the `haxeDependencies.haxe` value is still used, and must match the one of the directory extracted from the archive.\n\n#### Haxelib\n\n`haxeDependencies.haxelib` must match a release from the [official Haxelib repo](https://github.com/HaxeFoundation/haxelib/releases)\n\n### Known issues\n\nThe package relies on the `node` command, which [has issues on some Ubuntu versions] (http://stackoverflow.com/questions/21168141/cannot-install-packages-using-node-package-manager-in-ubuntu).\n\nIf you get an error similar to this :\n```\nsh: 1: node: not found\nnpm WARN This failure might be due to the use of legacy binary \"node\"\nnpm WARN For further explanations, please read /usr/share/doc/nodejs/README.Debian\n```\nJust install the `nodejs-legacy` package:\n```bash\nsudo apt-get install nodejs-legacy\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHaxeFoundation%2Fnpm-haxe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHaxeFoundation%2Fnpm-haxe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHaxeFoundation%2Fnpm-haxe/lists"}