vtimofei
/
surfingkeys-conf
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

tweak: change output filename to surfingkeys.js 

installdir is now ~/.config/ rather than ~/
This commit is contained in:
Maddison Hellstrom 2019-06-02 22:25:50 -07:00
parent 4e5064928d
commit 2ddaa0806e
3 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -541,10 +541,10 @@ Building `surfingkeys-conf` requires a few dependencies to be installed:
4. __Gulp Build/Install__ 4. __Gulp Build/Install__
```shell ```shell
$ gulp install # OR "gulp build" to build to ./build/.surfingkeys without installing $ gulp install # OR "gulp build" to build to ./build/surfingkeys.js without installing
``` ```
This will build the final configuration file and place it at `~/.surfingkeys`. This will build the final configuration file and place it at `~/.config/surfingkeys.js`.
If you already have a file in that location, make sure you back it up first! If you already have a file in that location, make sure you back it up first!
5. __Load your configuration into the SurfingKeys Extension__ 5. __Load your configuration into the SurfingKeys Extension__
@ -560,9 +560,9 @@ Building `surfingkeys-conf` requires a few dependencies to be installed:
_Note: you must specify the full, absolute path; environment variables like `$HOME` or the tilde `~` won't work_: _Note: you must specify the full, absolute path; environment variables like `$HOME` or the tilde `~` won't work_:
- __Linux__: `file:///home/{USERNAME}/.surfingkeys` (replace `{USERNAME}` with your username) - __Linux__: `file:///home/{USERNAME}/.config/surfingkeys.js` (replace `{USERNAME}` with your username)
- __macOS__: `file:///Users/{USERNAME}/.surfingkeys` (replace `{USERNAME}` with your username) - __macOS__: `file:///Users/{USERNAME}/.config/surfingkeys.js` (replace `{USERNAME}` with your username)
- __Windows__: `file://%Homedrive%%Homepath%/.surfingkeys` (This is a guess, please correct me if I'm wrong) - __Windows__: `file://%Homedrive%%Homepath%/surfingkeys.js` (This is a guess, please correct me if I'm wrong)
- __IV.__ Hack Away! If you ever make a change to any of your configuration files in the future, simply run `gulp install` again and your new configuration will automatically be loaded by SurfingKeys. - __IV.__ Hack Away! If you ever make a change to any of your configuration files in the future, simply run `gulp install` again and your new configuration will automatically be loaded by SurfingKeys.
</details> </details>
@ -570,7 +570,7 @@ Building `surfingkeys-conf` requires a few dependencies to be installed:
<details> <details>
<summary><strong>Option B</strong>: Manually copy/paste into the SurfingKeys configuration form</summary> <summary><strong>Option B</strong>: Manually copy/paste into the SurfingKeys configuration form</summary>
- __I.__ Copy the contents of `./build/.surfingkeys` (or `$HOME/.surfingkeys` if you ran `gulp install`) - __I.__ Copy the contents of `./build/surfingkeys.js` (or `$HOME/.config/surfingkeys.js` if you ran `gulp install`)
- __II.__ Open the SurfingKeys [configuration page](chrome-extension://mffcegbjcdejldmihkogmcnkgbbhioid/pages/options.html) - __II.__ Open the SurfingKeys [configuration page](chrome-extension://mffcegbjcdejldmihkogmcnkgbbhioid/pages/options.html)
@ -635,4 +635,4 @@ Todo
License License
------- -------
&copy;2017-2018 Maddison Hellstrom - MIT License &copy;2017-2019 Maddison Hellstrom - MIT License

14
README.tmpl.md
View File

@ -106,10 +106,10 @@ Building `surfingkeys-conf` requires a few dependencies to be installed:
4. __Gulp Build/Install__ 4. __Gulp Build/Install__
```shell ```shell
$ gulp install # OR "gulp build" to build to ./build/.surfingkeys without installing $ gulp install # OR "gulp build" to build to ./build/surfingkeys.js without installing
``` ```
This will build the final configuration file and place it at `~/.surfingkeys`. This will build the final configuration file and place it at `~/.config/surfingkeys.js`.
If you already have a file in that location, make sure you back it up first! If you already have a file in that location, make sure you back it up first!
5. __Load your configuration into the SurfingKeys Extension__ 5. __Load your configuration into the SurfingKeys Extension__
@ -125,9 +125,9 @@ Building `surfingkeys-conf` requires a few dependencies to be installed:
_Note: you must specify the full, absolute path; environment variables like `$HOME` or the tilde `~` won't work_: _Note: you must specify the full, absolute path; environment variables like `$HOME` or the tilde `~` won't work_:
- __Linux__: `file:///home/{USERNAME}/.surfingkeys` (replace `{USERNAME}` with your username) - __Linux__: `file:///home/{USERNAME}/.config/surfingkeys.js` (replace `{USERNAME}` with your username)
- __macOS__: `file:///Users/{USERNAME}/.surfingkeys` (replace `{USERNAME}` with your username) - __macOS__: `file:///Users/{USERNAME}/.config/surfingkeys.js` (replace `{USERNAME}` with your username)
- __Windows__: `file://%Homedrive%%Homepath%/.surfingkeys` (This is a guess, please correct me if I'm wrong) - __Windows__: `file://%Homedrive%%Homepath%/surfingkeys.js` (This is a guess, please correct me if I'm wrong)
- __IV.__ Hack Away! If you ever make a change to any of your configuration files in the future, simply run `gulp install` again and your new configuration will automatically be loaded by SurfingKeys. - __IV.__ Hack Away! If you ever make a change to any of your configuration files in the future, simply run `gulp install` again and your new configuration will automatically be loaded by SurfingKeys.
</details> </details>
@ -135,7 +135,7 @@ Building `surfingkeys-conf` requires a few dependencies to be installed:
<details> <details>
<summary><strong>Option B</strong>: Manually copy/paste into the SurfingKeys configuration form</summary> <summary><strong>Option B</strong>: Manually copy/paste into the SurfingKeys configuration form</summary>
- __I.__ Copy the contents of `./build/.surfingkeys` (or `$HOME/.surfingkeys` if you ran `gulp install`) - __I.__ Copy the contents of `./build/surfingkeys.js` (or `$HOME/.config/surfingkeys.js` if you ran `gulp install`)
- __II.__ Open the SurfingKeys [configuration page](chrome-extension://mffcegbjcdejldmihkogmcnkgbbhioid/pages/options.html) - __II.__ Open the SurfingKeys [configuration page](chrome-extension://mffcegbjcdejldmihkogmcnkgbbhioid/pages/options.html)
@ -161,4 +161,4 @@ Todo
License License
------- -------
&copy;2017-2018 Maddison Hellstrom - MIT License &copy;2017-2019 Maddison Hellstrom - MIT License

6
gulpfile.js
View File

@ -44,7 +44,7 @@ const paths = {
screenshots: "assets/screenshots", screenshots: "assets/screenshots",
favicons: "assets/favicons", favicons: "assets/favicons",
readmeOut: "README.md", readmeOut: "README.md",
scriptOut: ".surfingkeys", scriptOut: "surfingkeys.js",
installDir: platforms.getConfigHome(), installDir: platforms.getConfigHome(),
} }
@ -234,7 +234,7 @@ task("build",
"lint", "lint",
() => src(paths.entry, { read: false }) () => src(paths.entry, { read: false })
.pipe(parcel()) .pipe(parcel())
.pipe(rename(".surfingkeys")) .pipe(rename(paths.scriptOut))
.pipe(dest("build")), .pipe(dest("build")),
) )
)) ))
@ -263,7 +263,7 @@ const serve = (done) => {
res.writeHead(200, { res.writeHead(200, {
"Content-Type": "text/javascript; charset=UTF-8", "Content-Type": "text/javascript; charset=UTF-8",
}) })
res.end(await fs.readFile("./build/.surfingkeys")) res.end(await fs.readFile(path.join("build", paths.scriptOut)))
}) })
srv.listen(servePort) srv.listen(servePort)
console.log(`web server is listening on port ${servePort}`) // eslint-disable-line no-console console.log(`web server is listening on port ${servePort}`) // eslint-disable-line no-console