vercel/hyper

Support XDG

Open

#137 geöffnet am 16. Juli 2016

Auf GitHub ansehen
 (33 Kommentare) (35 Reaktionen) (0 zugewiesene Personen)TypeScript (44.582 Stars) (3.558 Forks)batch import
help wanted🎨 Type: Enhancement

Beschreibung

Hi,

I just discovered Hyperterm today and I'm really liking the idea of a web-based terminal (I use Atom as my code editor of choice). However, reading through the documentation, I noticed that configuring the editor (plugins and all) creates several files in your home directory (i.e. ~/.hyperterm.js and ~/.hyperterm_plugins). I also found issues on this repo like #10 and #14 which propose a possible custom stylesheet file (as well as the addition of an Extensions API).

I'd prefer not to clutter my home directory with more hidden files, if possible. Therefore, I feel that all of these files should be consolidated under a single ~/.hyperterm directory, similar to Atom's. It could have the following structure:

.hyperterm/
- plugins/
  - ...
- config.js
- styles.css (future)

...and whatever else might be added.

I figure to migrate current users to the new hierarchy, some backwards-compatibility code could be added which does the following:

  1. Use .hyperterm for all configuration/plugins if the directory exists
  2. If it does not exist, create a new .hyperterm directory and move ~/.hyperterm.js and ~/.hyperterm_plugins to their new respective paths

Thoughts? :) Caleb

Contributor Guide

Tech Stack
electronnodejstypescriptjavascript
Domain
desktopcli
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Node.js basicsElectron application structureXDG Base Directory specification
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65
Research-Richtung
Investigate the current configuration loading mechanism in the Hyper terminal, likely in `app/index.js` or similar files. The issue proposes moving `~/.hyperterm.js` and `~/.hyperterm plugins` into a `~/.hyperterm/` directory. Implementation should include checking for the new directory first, and if not present, migrating the old files. Refer to the XDG Base Directory specification for proper paths. Consider backward compatibility and handling of existing plugins and custom stylesheets. No existing PR or work in progress is linked.