Commit Graph

84 Commits

Author SHA1 Message Date
Ronan Jouchet c9ee6667d4
Revamp and move to TypeScript (#898)
## Breaking changes

- Require **Node >= 8.10.0 and npm 5.6.0**
- Move to **Electron 8.1.1**.
- That's it. Lots of care went into breaking CLI & programmatic behavior
  as little as possible. **Please report regressions**.
- Known issue: build may fail behind a proxy. Get in touch if you use one:
  https://github.com/jiahaog/nativefier/issues/907#issuecomment-596144768

## Changes summary

Nativefier didn't get much love recently, to the point that it's
becoming hard to run on recent Node, due to old dependencies.
Also, some past practices now seem weird, as better expressible
by modern JS/TS, discouraging contributions including mine.

Addressing this, and one thing leading to another, came a
bigger-than-expected revamp, aiming at making Nativefier more
**lean, stable, future-proof, user-friendly and dev-friendly**,
while **not changing the CLI/programmatic interfaces**. Highlights:

- **Require Node>=8**, as imposed by many of our dependencies. Node 8
  is twice LTS, and easily available even in conservative Linux distros.
  No reason not to demand it.
- **Default to Electron 8**.
- **Bump** all dependencies to latest version, including electron-packager.
- **Move to TS**. TS is great. As of today, I see no reason not to use it,
  and fight interface bugs at runtime rather than at compile time.
  With that, get rid of everything Babel/Webpack.
- **Move away from Gulp**. Gulp's selling point is perf via streaming,
  but for small builds like Nativefier, npm tasks are plenty good
  and less dependency bloat. Gulp was the driver for this PR: broken
  on Node 12, and I didn't feel like just upgrading and keeping it.
- Add tons of **verbose logs** everywhere it makes sense, to have a
  fine & clear trace of the program flow. This will be helpful to
  debug user-reported issues, and already helped me fix a few bugs.
    - With better simple logging, get rid of the quirky and buggy
      progress bar based on package `progress`. Nice logging (minimal
      by default, the verbose logging mentioned above is only used
      when passing `--verbose`) is better and one less dependency.
- **Dump `async` package**, a relic from old callback-hell early Node.
  Also dump a few other micro-packages unnecessary now.
- A first pass of code **cleanup** thanks to modern JS/TS features:
  fixes, simplifications, jsdoc type annotations to types, etc.
- **Remove GitHub integrations Hound & CodeClimate**, which are more
  exotic than good'ol'linters, and whose signal-to-noise ratio is too low.
- Quality: **Add tests** and add **Windows + macOS CI builds**.
  Also, add a **manual test script**, helping to quickly verify the
  hard-to-programatically-test stuff before releases, and limit regressions.
- **Fix a very small number of existing bugs**. The goal of this PR was
  *not* to fix bugs, but to get Nativefier in better shape to do so.
  Bugfixes will come later. Still, these got addressed:
  - Add common `Alt`+`Left`/`Right` for previous/next navigation.
  - Improve #379: fix zoom with `Ctrl` + numpad `+`/`-`
  - Fix pinch-to-zoom (see https://github.com/jiahaog/nativefier/issues/379#issuecomment-598612128 )
2020-03-15 16:50:01 -04:00
Robert Barat 9acd85bb65 README: fix typo (#723) 2018-12-14 08:37:08 -05:00
Ronan Jouchet 1f6e74b1e3
README: fix broken link to changelog 2018-12-01 00:21:32 -05:00
Ronan Jouchet 38edc9191e README: document node 4 is not supported/tested 2018-07-22 13:27:18 -04:00
Ronan Jouchet eb23217766 README: link to bugs and feature requests, cleanup 2018-07-22 11:49:50 -04:00
chocolateboy 22ef3d39b6 Fix doc typo (#656) 2018-07-20 12:29:37 -04:00
David Kramer dc257052c5 Fix #199 - macOS: Perform image conversion tasks using sips when available (PR #583)
Eliminates the requirement for imagemagick to be present on macOS for icon conversion.
Based off of the code from PR #279.
2018-04-26 07:42:03 -04:00
Ronan Jouchet 6ac4f33661 Update Dockerfile to node8-alpine, fix typos 2017-11-16 14:08:30 -05:00
ReadmeCritic 952290899e Correct the capitalization of Xcode in README (#459) 2017-10-03 11:44:31 -04:00
Tobias Schneck 95cc30983b Run Nativefier with Docker (#311)
TODO: windows are currently not possible, because of non 64-bit version of `node-rcedit`, see https://github.com/electron/node-rcedit/issues/22. Also there is currently no 32-bit alpine package for wine, what possible solve this image.
2017-05-19 21:21:16 +08:00
Jia Hao Goh 36e34c95a5 Remove `$` from docs
This allows shell commands to be copy and pasted easily
2017-04-09 10:36:27 +08:00
Jia Hao Goh 1658db53a6 Document minimum macOS version in docs 2017-04-09 10:35:46 +08:00
Lucas Caton 7512701a50 Replace OSX with macOS in README (#331) 2017-04-07 22:29:38 -04:00
Callum Macdonald e83ffcd481 Use absolute link to changelog 2017-02-12 23:39:44 +08:00
follower b9974c55b7 Fix typo in documentation (#237) 2016-10-09 12:06:01 +08:00
Goh Jia Hao 785a3b54bf Update docs to reflect node support for >=4 only 2016-05-27 00:11:24 +08:00
Goh Jia Hao 4e7fe7fa55 Add dependency status 2016-05-26 23:08:32 +08:00
Jia Hao 2cd251739e Add walkthrough gif in readme
Use relative link for dock screenshot
2016-03-27 11:36:04 +08:00
Jia Hao 404bab30c3 No longer enable flash by default
Flash should be enabled with `--flash`, which will also enable the `--insecure` flag
2016-03-26 15:06:50 +08:00
Jia Hao 08575ca75f Put changelog in `./docs` 2016-03-14 00:35:46 +08:00
Jia Hao 517cfd7df7 Add link to api docs 2016-03-13 15:31:15 +08:00
Jia Hao 67dc46adf5 Split docs into multiple files 2016-03-13 15:27:32 +08:00
Jia Hao 5bad1d08dd Use `windows` and `osx` to specify platform 2016-03-12 16:47:18 +08:00
Jia Hao cbff6ba50d Add note about nativefier-icons 2016-03-12 16:38:24 +08:00
Jia Hao e6dc4b8441 Override output directory by default 2016-03-12 16:07:21 +08:00
Jia Hao 7ba016bf50 Support only node 0.12 onwards 2016-03-12 02:00:00 +08:00
Jia Hao a49decbae8 Add optional dependencies 2016-03-11 02:29:13 +08:00
Jia Hao dea22336d9 Update Readme for Windows dev setup 2016-03-11 02:27:49 +08:00
Jia Hao 79c7767bb0 Add note about wine 2016-03-10 13:03:40 +08:00
Jia Hao 38a15baac2 Make section on optional dependencies clearer 2016-03-09 14:24:00 +08:00
Jia Hao 9d1276353e Remove dependency on Sips
Also update documentation for icon conversion dependencies
2016-03-09 00:01:27 +08:00
Jia Hao 866991d6a1 Fix typo in header 2016-02-25 19:09:08 +08:00
Jia Hao 31ee80f84f Implement command line flag to start app in full screen, resolves #109 2016-02-25 18:26:28 +08:00
Jia Hao 166aa8962e Add readme for injection 2016-02-25 15:09:26 +08:00
Jia Hao 4c03e72137 Add note about flash needing testing 2016-02-25 12:12:23 +08:00
Jia Hao 1b0351cd01 Change flag usage
- `--ignore-certificate` to ignore invalid certificate errors,
- `--insecure` to disable web security to allow mixed content
2016-02-23 21:31:47 +08:00
Jia Hao 2a31561fda Add documentation about flash and web security 2016-02-23 21:25:20 +08:00
Jia Hao 7bfa42ef71 Merge branch 'development' into feature/flash
# Conflicts:
#	README.md
#	src/build/buildApp.js
#	src/cli.js
#	src/options/optionsMain.js
2016-02-23 21:13:20 +08:00
Jia Hao dab9a06774 Update documentation for flash 2016-02-23 17:13:51 +08:00
Benjamin Wiederkehr dc51407ccb Added option to disable web security. 2016-02-22 21:33:33 +01:00
Benjamin Wiederkehr 481793b02f Promise to add insecure-content option. 2016-02-22 18:39:41 +01:00
Jia Hao 4663b99050 Merge pull request #142 from jiahaog/master
Add version flag for readme

Former-commit-id: a6280c7234af246df0a13cad45b5870715f25a09
2016-02-19 12:32:10 +08:00
Jia Hao 69a4d97ac2 Update example api usage for `require('nativefier').default`
Fixes #120

Former-commit-id: 6cf9926e3f7ff59639f4df58b9db77b99f33f82b
2016-02-19 00:54:43 +08:00
Jia Hao 6625446b01 Update readme 2016-01-31 22:02:35 +08:00
taiyoslime 4c21d3ac8e Update Readme to add usage of -V option 2016-01-30 18:16:21 +09:00
Jia Hao 2b616e0e4a Add note about not putting spaces in user defined app name 2016-01-30 02:08:53 +08:00
Jia Hao f471fe240e Update readme 2016-01-30 01:57:30 +08:00
Jia Hao a9ccaa5c10 Add note about `.png` to `.icns` conversion only supported on OSX 2016-01-29 22:09:33 +08:00
Jia Hao 421838d986 Update badge to reference development branch 2016-01-29 22:05:52 +08:00
Jia Hao 7417c7da0d Update readme 2016-01-29 14:46:09 +08:00