https://github.com/unfoldingword-dev/electronite-cli
A npm package to make electronite easy to use
https://github.com/unfoldingword-dev/electronite-cli
electron electronite graphite
Last synced: 6 months ago
JSON representation
A npm package to make electronite easy to use
- Host: GitHub
- URL: https://github.com/unfoldingword-dev/electronite-cli
- Owner: unfoldingWord-dev
- Created: 2020-02-06T04:53:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-02T20:44:18.000Z (almost 3 years ago)
- Last Synced: 2025-02-20T00:41:20.212Z (over 1 year ago)
- Topics: electron, electronite, graphite
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/electronite
- Size: 784 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Electronite CLI
This is a drop-in replacement for [electron](https://www.npmjs.com/package/electron)
that provides an enhanced font rendering system.
## Why?
[Electronite](https://github.com/unfoldingWord-dev/electronite) is a fork of electron that has been compiled with [Graphite](https://graphite.sil.org/).
> Graphite is a "smart font" system developed specifically to handle the complexities of lesser-known languages of the world.
## Installation
```
npm i electronite
```
## Usage
In your package.json
```josn
{
"scripts": {
"start": "electronite ."
}
}
```
In your javascript
```js
const {...} = require("electronite");
```
### A Note About Importing
It's important to note that when you use `require("electron")`,
you aren't importing code from your dependencies but from the electron runtime.
So, even when you have only installed electronite you can still use `require("electron")`.
However, since electron isn't installed you won't have the typings, so your IDE's auto-complete won't work.
Using `require("electronite")` provides the proper typings so auto-complete will work.
It also makes more sense from a developer perspective.
However, in order for the application to work,
electronite automatically returns the real electron package when available from the runtime.
All of this is to say that `electronite` **must** be installed as a dependency, not a dev-dependency.
The downside is that now there's potentially a large binary in your production code (depending on your build process).
If you are using webpack to build your application before compiling the electronite application,
this won't be a problem because webpack should automatically exclude the binary.
## Development
When a new version of this package is released, the corresponding version of `electron.d.ts`
needs to be copied from https://github.com/electron/electron/releases.
E.g. for version `6.0.7` of this package we downloaded `electron.d.ts` from https://github.com/electron/electron/releases/tag/v6.0.7.
Then you must edit `electron.d.ts` to declare the `electronite` module.
```typescript
// line 10542
declare module 'electronite' {
export = Electron;
}
interface NodeRequireFunction {
(moduleName: 'electronite'): typeof Electron;
}
```
Then you need to update the version of this package in `package.json` to match the version of electronite that you are supporting.
It is important that the version matches exactly.
An easy way to make sure you are setting the correct version is to look inside `electron.d.ts` and make sure the version indicated at the top of that file
is the same as the one in `package.json`.