vercel/hyper

Support XDG

Open

#137 ouverte le 16 juil. 2016

Voir sur GitHub
 (33 commentaires) (35 réactions) (0 assignés)TypeScript (44 582 stars) (3 558 forks)batch import
help wanted🎨 Type: Enhancement

Description

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

Guide contributeur

Stack technique
electronnodejstypescriptjavascript
Domaine
desktopcli
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Node.js basicsElectron application structureXDG Base Directory specification
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65
Direction de recherche
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.