vercel/hyper

Support XDG

Open

#137 opened on Jul 16, 2016

View on GitHub
 (33 comments) (35 reactions) (0 assignees)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

Contributor guide

Tech stack
electronnodejstypescriptjavascript
Domain
desktopcli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
mostly clear
Prerequisites
Node.js basicsElectron application structureXDG Base Directory specification
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.