npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@energypatrikhu/node-exe-compile

v1.0.0

Published

A small config based wrapper for @yao-pkg/pkg (fork of vercel's pkg package), using esbuild to minify and bundle the script specified in the config file, then using pkg it compiles to an exe file

Downloads

92

Readme

node-exe-compile

node-exe-compile is a small config based wrapper for @yao-pkg/pkg (fork of vercel's pkg package)

it is using esbuild to minify and bundle the script specified in the config file, then using pkg it compiles to an exe file

Warning

This package is not well tested, and may not work as expected, use at your own risk, the package was tested on Windows and Linux, but may not work on other platforms

Usage

  1. Install the package

    npm install -D @energypatrikhu/node-exe-compile
  2. Add the following scripts to your package.json

    {
      "scripts": {
        "compile": "node-exe-compile"
      }
    }
  3. Start the script

    this creates an example configuration file, that later can be modified to set the compiled name and others..

    npm run compile
  4. After that is done, you have to start node-exe-compile again

    now the script minifies and then compiles the given script to an executable

    npm run compile

Configuration

The generated configuration file is almost identical to the default configuration file needed for the pkg package, with a few additions

  • name: the name of the file after compiling
  • main: this is the location of the main file, commonly src/index.[ts,js]
  • bin: the path to the minified and bundled script (this most of the times does not need to be changed)
  • autoCopy: this is a boolean value, if set to true it will copy the needed files to the output directory
  • pkg: pkg options
    • targets: NodeJS version (latest == node20)
    • assets: when using packages that has .node extension the value has to be set, otherwise it may fail to start
    • outputPath: the path where the executable will be built
    • additional: this contains the additional settings for pkg
      • compress: the compression used at complile time
      • ...