diff --git a/.github/issue_template.md b/.github/issue_template.md index dce16876..b7bef5b2 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,7 +1,7 @@ @@ -10,7 +10,7 @@ - [ ] I am on the [latest](https://github.com/zeit/hyper/releases/latest) Hyper.app version - [ ] I have searched the [issues](https://github.com/zeit/hyper/issues) of this repo and believe that this is not a duplicate - @@ -18,7 +18,7 @@ - **OS version and name**: - **Hyper.app version**: - **Link of a [Gist](https://gist.github.com/) with the contents of your .hyper.js**: -- **Relevant information from devtools** _(CMD+ALT+I on Mac OS, CTRL+SHIFT+I elsewhere)_: +- **Relevant information from devtools** _(CMD+ALT+I on macOS, CTRL+SHIFT+I elsewhere)_: - **The issue is reproducible in vanilla Hyper.app**: ## Issue diff --git a/app/config.js b/app/config.js index 50b726d8..b8d2dc3c 100644 --- a/app/config.js +++ b/app/config.js @@ -22,7 +22,7 @@ const _watch = function() { }; if (process.platform === 'win32') { - // watch for changes on config every 2s on windows + // watch for changes on config every 2s on Windows // https://github.com/zeit/hyper/pull/1772 _watcher = fs.watchFile(cfgPath, {interval: 2000}, (curr, prev) => { if (curr.mtime === 0) { diff --git a/app/config/config-default.js b/app/config/config-default.js index 57ea9b59..f19a76ad 100644 --- a/app/config/config-default.js +++ b/app/config/config-default.js @@ -4,8 +4,8 @@ module.exports = { config: { - // Choose either "stable" for receiving highly polished, - // or "canary" for less polished but more frequent updates + // choose either `'stable'` for receiving highly polished, + // or `'canary'` for less polished but more frequent updates updateChannel: 'stable', // default font size in pixels for all tabs @@ -17,10 +17,10 @@ module.exports = { // terminal cursor background color and opacity (hex, rgb, hsl, hsv, hwb or cmyk) cursorColor: 'rgba(248,28,229,0.8)', - // `BEAM` for |, `UNDERLINE` for _, `BLOCK` for █ + // `'BEAM'` for |, `'UNDERLINE'` for _, `'BLOCK'` for █ cursorShape: 'BLOCK', - // set to true for blinking cursor + // set to `true` (without backticks and without quotes) for blinking cursor cursorBlink: false, // color of the text @@ -32,23 +32,23 @@ module.exports = { // border color (window, tabs) borderColor: '#333', - // custom css to embed in the main window + // custom CSS to embed in the main window css: '', - // custom css to embed in the terminal window + // custom CSS to embed in the terminal window termCSS: '', // set to `true` (without backticks and without quotes) if you're using a // Linux setup that doesn't show native menus - // default: `false` on Linux, `true` on Windows (ignored on macOS) + // default: `false` on Linux, `true` on Windows, ignored on macOS showHamburgerMenu: '', - // set to `false` if you want to hide the minimize, maximize and close buttons + // set to `false` (without backticks and without quotes) if you want to hide the minimize, maximize and close buttons // additionally, set to `'left'` if you want them on the left, like in Ubuntu - // default: `true` on windows and Linux (ignored on macOS) + // default: `true` (without backticks and without quotes) on Windows and Linux, ignored on macOS showWindowControls: '', - // custom padding (css format, i.e.: `top right bottom left`) + // custom padding (CSS format, i.e.: `top right bottom left`) padding: '12px 14px', // the full list. if you're going to provide the full color palette, @@ -83,25 +83,25 @@ module.exports = { // Bash on Windows // - Example: `C:\\Windows\\System32\\bash.exe` // - // Powershell on Windows + // PowerShell on Windows // - Example: `C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\powershell.exe` shell: '', - // for setting shell arguments (i.e. for using interactive shellArgs: ['-i']) - // by default ['--login'] will be used + // for setting shell arguments (i.e. for using interactive shellArgs: `['-i']`) + // by default `['--login']` will be used shellArgs: ['--login'], // for environment variables env: {}, - // set to false for no bell + // set to `false` for no bell bell: 'SOUND', - // if true, selected text will automatically be copied to the clipboard + // if `true` (without backticks and without quotes), selected text will automatically be copied to the clipboard copyOnSelect: false, - // if true, on right click selected text will be copied or pasted if no - // selection is present (true by default on Windows) + // if `true` (without backticks and without quotes), on right click selected text will be copied or pasted if no + // selection is present (`true` by default on Windows and disables the context menu feature) // quickEdit: true, // URL to custom bell diff --git a/app/ui/window.js b/app/ui/window.js index 6d2ba71c..1377ce4d 100644 --- a/app/ui/window.js +++ b/app/ui/window.js @@ -23,7 +23,7 @@ module.exports = class Window { backgroundColor: toElectronBackgroundColor(cfg.backgroundColor || '#000'), titleBarStyle: 'hidden-inset', title: 'Hyper.app', - // we want to go frameless on windows and linux + // we want to go frameless on Windows and Linux frame: process.platform === 'darwin', transparent: process.platform === 'darwin', icon, diff --git a/lib/components/header.js b/lib/components/header.js index b1a618b1..8df41278 100644 --- a/lib/components/header.js +++ b/lib/components/header.js @@ -73,10 +73,10 @@ export default class Header extends PureComponent { const defaults = { hambMenu: process.platform === 'win32', // show by default on windows - winCtrls: !this.props.isMac // show by default on windows and linux + winCtrls: !this.props.isMac // show by default on Windows and Linux }; - // don't allow the user to change defaults on MacOS + // don't allow the user to change defaults on macOS if (this.props.isMac) { return defaults; } diff --git a/lib/utils/paste.js b/lib/utils/paste.js index 5309271b..2f3eef04 100644 --- a/lib/utils/paste.js +++ b/lib/utils/paste.js @@ -10,7 +10,7 @@ const getPath = platform => { const filepath = clipboard.read('FileNameW'); return filepath.replace(new RegExp(String.fromCharCode(0), 'g'), ''); } - // linux already pastes full path + // Linux already pastes full path default: return null; } diff --git a/readme.md b/readme.md index 5c5c68a3..60904733 100644 --- a/readme.md +++ b/readme.md @@ -20,7 +20,7 @@ brew update brew cask install hyper ``` -If you are on windows, you can use [chocolatey](https://chocolatey.org/) to install the app by running the following command (package information can be found [here](https://chocolatey.org/packages/hyper/)): +If you are on Windows, you can use [chocolatey](https://chocolatey.org/) to install the app by running the following command (package information can be found [here](https://chocolatey.org/packages/hyper/)): ```bash choco install hyper @@ -51,8 +51,8 @@ Regardless of the platform you are working on, you will need to have Yarn instal 4. Build the code and watch for changes: `yarn run dev` 5. To run `hyper` * `yarn run app` from another terminal tab/window/pane - * If you are using **Visual Studio Code**, select `Launch Hyper` in debugger configuration to launch a new Hyper instance with debugger attached. - + * If you are using **Visual Studio Code**, select `Launch Hyper` in debugger configuration to launch a new Hyper instance with debugger attached. + To make sure that your code works in the finished application, you can generate the binaries like this: ```bash