forked from Brummolix/AutoarchiveReloaded
-
Notifications
You must be signed in to change notification settings - Fork 0
/
devhints.txt
36 lines (32 loc) · 1.87 KB
/
devhints.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Development hints:
- typescript is used to translate files to javascript
- npm is used to install needed dependencies
- grunt is used to build everything
- Visual Studio Code can be used for editing
- how to install?
- install Visual Studio code
- install some special build tools (windows only, installs Visual Studio Build and Python)
(I think with the current node installer this step is no longer needed, as the installer installs the build tools if you tick the checkbox at install)
- open elevated shell/powershell
- run "npm install --global --production windows-build-tools"
(this is needed for the node-gyp package which is needed by the grunt-contrib-compress package which is needed for the grunt build
see also https://github.com/nodejs/node-gyp)
- install needed node packages
- open shell at project dir or open terminal in visual studio code
- run "npm install"
- if this fails on windows because of node-gyp then you should again use an elevated terminal (because the install of grunt-contrib-compress will build something on the fly with Visual Studio build)
- now you should be able to build with grunt and/or visual studio code
- how to install a new npm/grunt module?
npm install MODULENAME --save-dev
- it will refresh package.json und package-lock.json
- it will install the module under node_modules (which is excluded from git)
- module system
Typescript code uses import/export statements
The code is translated from typescript to Js and then packed with webpack to single js files including all needed modules.
- directory structure
src/sharedWebextension - contains all sources used by the webextension scripts
src/options - contains the sources for the option page
uses sharedWebextension
src/backgroundScript - contains the sources for the backgroundScript
uses sharedWebextension
src/resources - contains all files that are needed additionally