onivim/oni

Enable Asar packaging for installation

Open

#350 opened on Apr 3, 2017

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (11,389 stars) (336 forks)batch import
bountybounty-50chorehelp wantedinsiderperformance

Description

For v0.2, the asar option was set to false - meaning the app is not bundled into an asar archive. The electron-builder docs recommend keeping this as true, but excluding certain files. This can also help with the app launch speed. On all platforms, we get this warning due to disabling asar packing:

Packaging using asar archive is disabled — it is strongly not recommended.

To re-enable it, the files in the bin folder must be excluded.

Contributor guide

Tech stack
typescriptnodejs
Domain
desktopbuild systemperformance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Electron packaging basicselectron builder configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Investigate the electron builder configuration in package.json or a separate build config file. Enable asar packaging by setting 'asar' to true and add a file exclusion pattern for the 'bin' folder using the 'files' or 'asarUnpack' option. Test the build on all platforms to ensure the warning about disabled asar is no longer shown.