Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cfsghost/npk
Node.js packaging utility
https://github.com/cfsghost/npk
Last synced: 15 days ago
JSON representation
Node.js packaging utility
- Host: GitHub
- URL: https://github.com/cfsghost/npk
- Owner: cfsghost
- Created: 2013-05-05T15:56:35.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-01-02T04:32:33.000Z (almost 10 years ago)
- Last Synced: 2024-10-22T20:24:52.916Z (24 days ago)
- Language: JavaScript
- Size: 294 KB
- Stars: 137
- Watchers: 14
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-tw-foss - Npk - Node.js packaging utility. (Lib/Framework/API/Dev Tool)
README
NPK
===
Node.js packaging utility to bundle javascript and resource files.
[](https://nodei.co/npm/npk/)
[](https://travis-ci.org/cfsghost/npk)
Usage
-
Install NPK globally via NPM:
```
npm install npk -g
```
Using command to pack your project:
```
npk tests/purejs/
```
After packaging, NPK will create a new folder `out` for package. You can find out the package in there:
```
tests/purejs/out/app.js/
```
Finally, you can run packaged application directly:
```
node tests/purejs/out/app.js/app.js
```
Three levels for packaging
-
NPK has special and funny options for three levels for packaging your project.
__Remove Mock-up (default)__
```
npk [project path]
```
__Mom doesn't recognize__
```
npk [project path] --mom-doesnt-recognize
```
__Dad doesn't recognize__
At this level, NPK is packaging your project with C/C++ compiler, to generate a Node.js native module.
```
npk [project path] --dad-doesnt-recognize
```
Note that the third level will attempt to compile all things with machine code then saving as a binary file. It means packed application is not going to work on cross-platform. If you need to support several various platform for your project, it must re-package you application on specific platform what you want.
Note for Windows Users
-
Generating Node.js native module requires C/C++ compiler and Python development. You must install Visual Studio(Express version is fine) and Python 2.7(NOT 3.x) before using "Dad doesn' recognize" option.
How it works
-
NPK is similar to general compiler for computer language. With linking and managing symbol table, NPK can bundle multiple JavaScript source code files, that's just like that compiler is getting objects for making a single binary file.
Actual mechanism to package JavaScript source code files:
1. Getting source files defined in the 'npk_target' property in package.json.
2. Generating symbol table for storing source code files.
3. Linking and bundling symbol table files to generate a single file.
License
-
Licensed under the MIT License
Authors
-
Copyright(c) 2013 Fred Chien <>