{"id":20942339,"url":"https://github.com/unfoldingword-dev/electronite-cli","last_synced_at":"2026-01-08T20:12:30.879Z","repository":{"id":40313779,"uuid":"238610484","full_name":"unfoldingWord-dev/electronite-cli","owner":"unfoldingWord-dev","description":"A npm package to make electronite easy to use","archived":false,"fork":false,"pushed_at":"2023-08-02T20:44:18.000Z","size":803,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-20T00:41:20.212Z","etag":null,"topics":["electron","electronite","graphite"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/electronite","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unfoldingWord-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-06T04:53:04.000Z","updated_at":"2023-09-04T12:03:41.000Z","dependencies_parsed_at":"2024-11-16T18:43:48.798Z","dependency_job_id":null,"html_url":"https://github.com/unfoldingWord-dev/electronite-cli","commit_stats":{"total_commits":26,"total_committers":3,"mean_commits":8.666666666666666,"dds":"0.34615384615384615","last_synced_commit":"b16489eeba655249fdb3459c281d094182fccb5b"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord-dev%2Felectronite-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord-dev%2Felectronite-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord-dev%2Felectronite-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord-dev%2Felectronite-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unfoldingWord-dev","download_url":"https://codeload.github.com/unfoldingWord-dev/electronite-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243335382,"owners_count":20274898,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","electronite","graphite"],"created_at":"2024-11-18T23:26:10.821Z","updated_at":"2026-01-08T20:12:30.849Z","avatar_url":"https://github.com/unfoldingWord-dev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Electronite CLI\n\nThis is a drop-in replacement for [electron](https://www.npmjs.com/package/electron)\nthat provides an enhanced font rendering system.\n\n## Why?\n[Electronite](https://github.com/unfoldingWord-dev/electronite) is a fork of electron that has been compiled with [Graphite](https://graphite.sil.org/).\n\n\u003e Graphite is a \"smart font\" system developed specifically to handle the complexities of lesser-known languages of the world.\n\n## Installation\n\n```\nnpm i electronite\n```\n\n## Usage\n\nIn your package.json\n```josn\n{\n    \"scripts\": {\n        \"start\": \"electronite .\"\n    }\n}\n```\n\nIn your javascript\n```js\nconst {...} = require(\"electronite\");\n```\n\n### A Note About Importing\nIt's important to note that when you use `require(\"electron\")`,\nyou aren't importing code from your dependencies but from the electron runtime.\nSo, even when you have only installed electronite you can still use `require(\"electron\")`.\nHowever, since electron isn't installed you won't have the typings, so your IDE's auto-complete won't work.\n\nUsing `require(\"electronite\")` provides the proper typings so auto-complete will work.\nIt also makes more sense from a developer perspective.\nHowever, in order for the application to work,\nelectronite automatically returns the real electron package when available from the runtime.\n\nAll of this is to say that `electronite` **must** be installed as a dependency, not a dev-dependency.\nThe downside is that now there's potentially a large binary in your production code (depending on your build process).\nIf you are using webpack to build your application before compiling the electronite application,\nthis won't be a problem because webpack should automatically exclude the binary.\n\n## Development\n\nWhen a new version of this package is released, the corresponding version of `electron.d.ts`\nneeds to be copied from https://github.com/electron/electron/releases.\nE.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.\n\nThen you must edit `electron.d.ts` to declare the `electronite` module.\n\n```typescript\n// line 10542\ndeclare module 'electronite' {\n  export = Electron;\n}\n\ninterface NodeRequireFunction {\n  (moduleName: 'electronite'): typeof Electron;\n}\n```\nThen you need to update the version of this package in `package.json` to match the version of electronite that you are supporting.\nIt is important that the version matches exactly.\nAn 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\nis the same as the one in `package.json`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfoldingword-dev%2Felectronite-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funfoldingword-dev%2Felectronite-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfoldingword-dev%2Felectronite-cli/lists"}