Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.96 KB

DEVELOPMENT.md

File metadata and controls

82 lines (53 loc) · 2.96 KB
Raw

PKG Development

This document aims to help you get started with pkg developemnt.

Release Process

In order to create release just run the command:

npm run release

This command will start an interactive process that will guide you through the release process using release-it

Testing

Before running tests ensure you have build the project by running:

npm run build

Note

Remember to run again npm run build after changing source code (everything inside lib folder).

Than you can use the following command to run tests:

node test/test.js <target> [no-npm | only-npm | all] [<flavor>]
  • <target> is the node target the test will use when creating executables, can be nodeXX (like node20) or host (uses host node version as target).
  • [no-npm | only-npm | all] to specify which tests to run. no-npm will run tests that don't require npm, only-npm will run against some specific npm modules, and all will run all tests.
  • <flavor> to use when you want to run only tests matching a specific pattern. Example: node test/test.js all test-99-*. You can also set this by using FLAVOR environment variable.

Each test is located inside test directory into a dedicated folder named following the pattern test-XX-*. The XX is a number that represents the order the tests will run.

When running node test/test.js all, based on the options, each test will be run consecutively by running main.js file inside the test folder.

Example test

Create a directory named test-XX-<name> and inside it create a main.js file with the following content:

#!/usr/bin/env node

'use strict';

const assert = require('assert');
const utils = require('../utils.js');

assert(!module.parent);
assert(__dirname === process.cwd());

const input = './test-x-index';

const newcomers = [
  'test-x-index-linux',
  'test-x-index-macos',
  'test-x-index-win.exe',
];

const before = utils.filesBefore(newcomers);

utils.pkg.sync([input], { stdio: 'inherit' });

utils.filesAfter(before, newcomers);

Explaining the code above:

  • assert(!module.parent); ensures the script is being run directly.
  • assert(__dirname === process.cwd()); ensures the script is being run from the correct directory.
  • utils.filesBefore(newcomers); get current files in the directory.
  • utils.pkg.sync([input], { stdio: 'inherit' }); runs pkg passing input file as only argument.
  • utils.filesAfter(before, newcomers); checks if the output files were created correctly and cleans up the directory to the original state.

Special tests

  • test-79-npm: It's the only test runned when using only-npm. It install and tests all node modules listed inside that dir and verifies if they are working correctly.
  • test-42-fetch-all: Foreach known node version verifies there is a patch existing for it using pkg-fetch.
  • test-46-multi-arch: Tries to cross-compile a binary for all known architectures.