Skip to content

Commit 4e6db20

Browse files
fxnoobfxnoob
committed
add jsdoc
1 parent c33330b commit 4e6db20

File tree

3 files changed

+150
-3
lines changed

3 files changed

+150
-3
lines changed

‎package.json‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@
33
"version": "1.0.0",
44
"description": "",
55
"main": "index.js",
6+
"homepage": "https://fxnoob.github.io/chrome-extension-boilerplate",
67
"scripts": {
78
"start": "webpack-dev-server --config ./webpack.config.js --mode development",
89
"dev": "webpack --watch --progress --colors --config webpack.config.js --mode=development",
910
"build": "webpack --progress --colors --config webpack.config.js --mode=production",
11+
"jsdoc": "jsdoc src -r",
12+
"deploy_jsdoc": "yarn jsdoc && gh-pages -d out",
1013
"prettier_check_src": "prettier --check src/**/*.{js,jsx}",
1114
"prettier_check_popup": "prettier --check src/**/*.{js,jsx}",
1215
"prettier_check_option": "prettier --check src/**/*.{js,jsx}",
@@ -32,8 +35,11 @@
3235
"babel-loader": "^8.0.6",
3336
"copy-webpack-plugin": "^5.0.4",
3437
"file-loader": "^4.2.0",
38+
"husky": "^3.0.9",
3539
"image-webpack-loader": "^5.0.0",
40+
"jsdoc": "^3.6.3",
3641
"prettier": "1.18.2",
42+
"pretty-quick": "^2.0.0",
3743
"react-hot-loader": "^4.12.10",
3844
"webpack": "^4.39.1",
3945
"webpack-cli": "^3.3.6",
@@ -44,8 +50,6 @@
4450
"@babel/runtime": "^7.5.5",
4551
"@material-ui/core": "^4.3.3",
4652
"@material-ui/icons": "^4.2.1",
47-
"husky": "^3.0.9",
48-
"pretty-quick": "^2.0.0",
4953
"react": "^16.8.6",
5054
"react-dom": "^16.8.6"
5155
}

‎src/background.js‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ import "@babel/polyfill";
22

33
let AppInitState = 0; // it means app is off on startup
44

5+
/**
6+
* Main extension functionality
7+
*
8+
* @class Main
9+
*/
510
class Main {
611
constructor() {}
712
popUpClickSetup() {
@@ -13,11 +18,23 @@ class Main {
1318
});
1419
}
1520

21+
/**
22+
* toggle app
23+
*
24+
* @method
25+
* @memberof Main
26+
*/
1627
toggleApp = () => {
1728
AppInitState = AppInitState ? 0 : 1;
1829
return AppInitState;
1930
};
2031

32+
/**
33+
* stop app
34+
*
35+
* @method
36+
* @memberof Main
37+
*/
2138
stopApp = () => {
2239
AppInitState = 0;
2340
};

‎yarn.lock‎

Lines changed: 127 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1400,6 +1400,11 @@ bl@^1.0.0:
14001400
readable-stream "^2.3.5"
14011401
safe-buffer "^5.1.1"
14021402

1403+
bluebird@^3.5.4:
1404+
version "3.7.1"
1405+
resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.7.1.tgz#df70e302b471d7473489acf26a93d63b53f874de"
1406+
integrity sha512-DdmyoGCleJnkbp3nkbxTLJ18rjDsE4yCggEwKNXkeV123sPNfOCYeDoeuOY+F2FrSjO1YXcTU+dsy96KMy+gcg==
1407+
14031408
bluebird@^3.5.5:
14041409
version "3.5.5"
14051410
resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.5.5.tgz#a8d0afd73251effbbd5fe384a77d73003c17a71f"
@@ -1726,6 +1731,13 @@ caniuse-lite@^1.0.30000984:
17261731
resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30000989.tgz#b9193e293ccf7e4426c5245134b8f2a56c0ac4b9"
17271732
integrity sha512-vrMcvSuMz16YY6GSVZ0dWDTJP8jqk3iFQ/Aq5iqblPwxSVVZI+zxDyTX0VPqtQsDnfdrBDcsmhgTEOh5R8Lbpw==
17281733

1734+
catharsis@^0.8.11:
1735+
version "0.8.11"
1736+
resolved "https://registry.yarnpkg.com/catharsis/-/catharsis-0.8.11.tgz#d0eb3d2b82b7da7a3ce2efb1a7b00becc6643468"
1737+
integrity sha512-a+xUyMV7hD1BrDQA/3iPV7oc+6W26BgVJO05PGEoatMyIuPScQKsde6i3YorWX1qs+AZjnJ18NqdKoCtKiNh1g==
1738+
dependencies:
1739+
lodash "^4.17.14"
1740+
17291741
caw@^2.0.0, caw@^2.0.1:
17301742
version "2.0.1"
17311743
resolved "https://registry.yarnpkg.com/caw/-/caw-2.0.1.tgz#6c3ca071fc194720883c2dc5da9b074bfc7e9e95"
@@ -2619,6 +2631,11 @@ entities@^2.0.0:
26192631
resolved "https://registry.yarnpkg.com/entities/-/entities-2.0.0.tgz#68d6084cab1b079767540d80e56a39b423e4abf4"
26202632
integrity sha512-D9f7V0JSRwIxlRI2mjMqufDrRDnx8p+eEOz7aUM9SuvF8gsBzra0/6tbjl1m8eQHrZlYj6PxqE00hZ1SAIKPLw==
26212633

2634+
entities@~1.1.1:
2635+
version "1.1.2"
2636+
resolved "https://registry.yarnpkg.com/entities/-/entities-1.1.2.tgz#bdfa735299664dfafd34529ed4f8522a275fea56"
2637+
integrity sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==
2638+
26222639
errno@^0.1.3, errno@~0.1.7:
26232640
version "0.1.7"
26242641
resolved "https://registry.yarnpkg.com/errno/-/errno-0.1.7.tgz#4684d71779ad39af177e3f007996f7c67c852618"
@@ -2664,6 +2681,11 @@ escape-string-regexp@^1.0.2, escape-string-regexp@^1.0.5:
26642681
resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"
26652682
integrity sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=
26662683

2684+
escape-string-regexp@^2.0.0:
2685+
version "2.0.0"
2686+
resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz#a30304e99daa32e23b2fd20f51babd07cffca344"
2687+
integrity sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==
2688+
26672689
eslint-scope@^4.0.3:
26682690
version "4.0.3"
26692691
resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-4.0.3.tgz#ca03833310f6889a3264781aa82e63eb9cfe7848"
@@ -3408,6 +3430,11 @@ graceful-fs@^4.1.10, graceful-fs@^4.1.11, graceful-fs@^4.1.15, graceful-fs@^4.1.
34083430
resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.2.tgz#6f0952605d0140c1cfdb138ed005775b92d67b02"
34093431
integrity sha512-IItsdsea19BoLC7ELy13q1iJFNmd7ofZH5+X/pJr90/nRoPEX0DJo1dHDbgtYWOhJhcCgMDTOw84RZ72q6lB+Q==
34103432

3433+
graceful-fs@^4.1.9:
3434+
version "4.2.3"
3435+
resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.3.tgz#4a12ff1b60376ef09862c2093edd908328be8423"
3436+
integrity sha512-a30VEBm4PEdx1dRB7MFK7BejejvCvBronbLjht+sHuGYj8PHs7M/5Z+rt5lw551vZ7yfTCj4Vuyy3mSJytDWRQ==
3437+
34113438
"graceful-readlink@>= 1.0.0":
34123439
version "1.0.1"
34133440
resolved "https://registry.yarnpkg.com/graceful-readlink/-/graceful-readlink-1.0.1.tgz#4cafad76bc62f02fa039b2f94e9a3dd3a391a725"
@@ -4208,6 +4235,33 @@ js-yaml@^3.13.1:
42084235
argparse "^1.0.7"
42094236
esprima "^4.0.0"
42104237

4238+
js2xmlparser@^4.0.0:
4239+
version "4.0.0"
4240+
resolved "https://registry.yarnpkg.com/js2xmlparser/-/js2xmlparser-4.0.0.tgz#ae14cc711b2892083eed6e219fbc993d858bc3a5"
4241+
integrity sha512-WuNgdZOXVmBk5kUPMcTcVUpbGRzLfNkv7+7APq7WiDihpXVKrgxo6wwRpRl9OQeEBgKCVk9mR7RbzrnNWC8oBw==
4242+
dependencies:
4243+
xmlcreate "^2.0.0"
4244+
4245+
jsdoc@^3.6.3:
4246+
version "3.6.3"
4247+
resolved "https://registry.yarnpkg.com/jsdoc/-/jsdoc-3.6.3.tgz#dccea97d0e62d63d306b8b3ed1527173b5e2190d"
4248+
integrity sha512-Yf1ZKA3r9nvtMWHO1kEuMZTlHOF8uoQ0vyo5eH7SQy5YeIiHM+B0DgKnn+X6y6KDYZcF7G2SPkKF+JORCXWE/A==
4249+
dependencies:
4250+
"@babel/parser" "^7.4.4"
4251+
bluebird "^3.5.4"
4252+
catharsis "^0.8.11"
4253+
escape-string-regexp "^2.0.0"
4254+
js2xmlparser "^4.0.0"
4255+
klaw "^3.0.0"
4256+
markdown-it "^8.4.2"
4257+
markdown-it-anchor "^5.0.2"
4258+
marked "^0.7.0"
4259+
mkdirp "^0.5.1"
4260+
requizzle "^0.2.3"
4261+
strip-json-comments "^3.0.1"
4262+
taffydb "2.6.2"
4263+
underscore "~1.9.1"
4264+
42114265
jsesc@^2.5.1:
42124266
version "2.5.2"
42134267
resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-2.5.2.tgz#80564d2e483dacf6e8ef209650a67df3f0c283a4"
@@ -4357,6 +4411,13 @@ kind-of@^6.0.0, kind-of@^6.0.2:
43574411
resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-6.0.2.tgz#01146b36a6218e64e58f3a8d66de5d7fc6f6d051"
43584412
integrity sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==
43594413

4414+
klaw@^3.0.0:
4415+
version "3.0.0"
4416+
resolved "https://registry.yarnpkg.com/klaw/-/klaw-3.0.0.tgz#b11bec9cf2492f06756d6e809ab73a2910259146"
4417+
integrity sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==
4418+
dependencies:
4419+
graceful-fs "^4.1.9"
4420+
43604421
lcid@^2.0.0:
43614422
version "2.0.0"
43624423
resolved "https://registry.yarnpkg.com/lcid/-/lcid-2.0.0.tgz#6ef5d2df60e52f82eb228a4c373e8d1f397253cf"
@@ -4369,6 +4430,13 @@ lines-and-columns@^1.1.6:
43694430
resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.1.6.tgz#1c00c743b433cd0a4e80758f7b64a57440d9ff00"
43704431
integrity sha1-HADHQ7QzzQpOgHWPe2SldEDZ/wA=
43714432

4433+
linkify-it@^2.0.0:
4434+
version "2.2.0"
4435+
resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-2.2.0.tgz#e3b54697e78bf915c70a38acd78fd09e0058b1cf"
4436+
integrity sha512-GnAl/knGn+i1U/wjBz3akz2stz+HrHLsxMwHQGofCDfPvlf+gDKN58UtfmUquTY4/MXeE2x7k19KQmeoZi94Iw==
4437+
dependencies:
4438+
uc.micro "^1.0.1"
4439+
43724440
load-json-file@^1.0.0:
43734441
version "1.1.0"
43744442
resolved "https://registry.yarnpkg.com/load-json-file/-/load-json-file-1.1.0.tgz#956905708d58b4bab4c2261b04f59f31c99374c0"
@@ -4409,7 +4477,7 @@ locate-path@^5.0.0:
44094477
dependencies:
44104478
p-locate "^4.1.0"
44114479

4412-
lodash@^4.17.11, lodash@^4.17.13:
4480+
lodash@^4.17.11, lodash@^4.17.13, lodash@^4.17.14:
44134481
version "4.17.15"
44144482
resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.15.tgz#b447f6670a0455bbfeedd11392eff330ea097548"
44154483
integrity sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==
@@ -4526,6 +4594,27 @@ map-visit@^1.0.0:
45264594
dependencies:
45274595
object-visit "^1.0.0"
45284596

4597+
markdown-it-anchor@^5.0.2:
4598+
version "5.2.5"
4599+
resolved "https://registry.yarnpkg.com/markdown-it-anchor/-/markdown-it-anchor-5.2.5.tgz#dbf13cfcdbffd16a510984f1263e1d479a47d27a"
4600+
integrity sha512-xLIjLQmtym3QpoY9llBgApknl7pxAcN3WDRc2d3rwpl+/YvDZHPmKscGs+L6E05xf2KrCXPBvosWt7MZukwSpQ==
4601+
4602+
markdown-it@^8.4.2:
4603+
version "8.4.2"
4604+
resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-8.4.2.tgz#386f98998dc15a37722aa7722084f4020bdd9b54"
4605+
integrity sha512-GcRz3AWTqSUphY3vsUqQSFMbgR38a4Lh3GWlHRh/7MRwz8mcu9n2IO7HOh+bXHrR9kOPDl5RNCaEsrneb+xhHQ==
4606+
dependencies:
4607+
argparse "^1.0.7"
4608+
entities "~1.1.1"
4609+
linkify-it "^2.0.0"
4610+
mdurl "^1.0.1"
4611+
uc.micro "^1.0.5"
4612+
4613+
marked@^0.7.0:
4614+
version "0.7.0"
4615+
resolved "https://registry.yarnpkg.com/marked/-/marked-0.7.0.tgz#b64201f051d271b1edc10a04d1ae9b74bb8e5c0e"
4616+
integrity sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==
4617+
45294618
md5.js@^1.3.4:
45304619
version "1.3.5"
45314620
resolved "https://registry.yarnpkg.com/md5.js/-/md5.js-1.3.5.tgz#b5d07b8e3216e3e27cd728d72f70d1e6a342005f"
@@ -4545,6 +4634,11 @@ mdn-data@~1.1.0:
45454634
resolved "https://registry.yarnpkg.com/mdn-data/-/mdn-data-1.1.4.tgz#50b5d4ffc4575276573c4eedb8780812a8419f01"
45464635
integrity sha512-FSYbp3lyKjyj3E7fMl6rYvUdX0FBXaluGqlFoYESWQlyUTq8R+wp0rkFxoYFqZlHCvsUXGjyJmLQSnXToYhOSA==
45474636

4637+
mdurl@^1.0.1:
4638+
version "1.0.1"
4639+
resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-1.0.1.tgz#fe85b2ec75a59037f2adfec100fd6c601761152e"
4640+
integrity sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=
4641+
45484642
media-typer@0.3.0:
45494643
version "0.3.0"
45504644
resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
@@ -5969,6 +6063,13 @@ requires-port@^1.0.0:
59696063
resolved "https://registry.yarnpkg.com/requires-port/-/requires-port-1.0.0.tgz#925d2601d39ac485e091cf0da5c6e694dc3dcaff"
59706064
integrity sha1-kl0mAdOaxIXgkc8NpcbmlNw9yv8=
59716065

6066+
requizzle@^0.2.3:
6067+
version "0.2.3"
6068+
resolved "https://registry.yarnpkg.com/requizzle/-/requizzle-0.2.3.tgz#4675c90aacafb2c036bd39ba2daa4a1cb777fded"
6069+
integrity sha512-YanoyJjykPxGHii0fZP0uUPEXpvqfBDxWV7s6GKAiiOsiqhX6vHNyW3Qzdmqp/iq/ExbhaGbVrjB4ruEVSM4GQ==
6070+
dependencies:
6071+
lodash "^4.17.14"
6072+
59726073
resolve-cwd@^2.0.0:
59736074
version "2.0.0"
59746075
resolved "https://registry.yarnpkg.com/resolve-cwd/-/resolve-cwd-2.0.0.tgz#00a9f7387556e27038eae232caa372a6a59b665a"
@@ -6611,6 +6712,11 @@ strip-indent@^1.0.1:
66116712
dependencies:
66126713
get-stdin "^4.0.1"
66136714

6715+
strip-json-comments@^3.0.1:
6716+
version "3.0.1"
6717+
resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-3.0.1.tgz#85713975a91fb87bf1b305cca77395e40d2a64a7"
6718+
integrity sha512-VTyMAUfdm047mwKl+u79WIdrZxtFtn+nBxHeb844XBQ9uMNTuTHdx2hc5RiAJYqwTj3wc/xe5HLSdJSkJ+WfZw==
6719+
66146720
strip-json-comments@~2.0.1:
66156721
version "2.0.1"
66166722
resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-2.0.1.tgz#3c531942e908c2697c0ec344858c286c7ca0a60a"
@@ -6661,6 +6767,11 @@ svgo@^1.0.5:
66616767
unquote "~1.1.1"
66626768
util.promisify "~1.0.0"
66636769

6770+
taffydb@2.6.2:
6771+
version "2.6.2"
6772+
resolved "https://registry.yarnpkg.com/taffydb/-/taffydb-2.6.2.tgz#7cbcb64b5a141b6a2efc2c5d2c67b4e150b2a268"
6773+
integrity sha1-fLy2S1oUG2ou/CxdLGe04VCyomg=
6774+
66646775
tapable@^1.0.0, tapable@^1.1.3:
66656776
version "1.1.3"
66666777
resolved "https://registry.yarnpkg.com/tapable/-/tapable-1.1.3.tgz#a1fccc06b58db61fd7a45da2da44f5f3a3e67ba2"
@@ -6861,6 +6972,11 @@ typedarray@^0.0.6:
68616972
resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
68626973
integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=
68636974

6975+
uc.micro@^1.0.1, uc.micro@^1.0.5:
6976+
version "1.0.6"
6977+
resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.6.tgz#9c411a802a409a91fc6cf74081baba34b24499ac"
6978+
integrity sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==
6979+
68646980
unbzip2-stream@^1.0.9:
68656981
version "1.3.3"
68666982
resolved "https://registry.yarnpkg.com/unbzip2-stream/-/unbzip2-stream-1.3.3.tgz#d156d205e670d8d8c393e1c02ebd506422873f6a"
@@ -6869,6 +6985,11 @@ unbzip2-stream@^1.0.9:
68696985
buffer "^5.2.1"
68706986
through "^2.3.8"
68716987

6988+
underscore@~1.9.1:
6989+
version "1.9.1"
6990+
resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.9.1.tgz#06dce34a0e68a7babc29b365b8e74b8925203961"
6991+
integrity sha512-5/4etnCkd9c8gwgowi5/om/mYO5ajCaOgdzj/oW+0eQV9WxKBDZw5+ycmKmeaTXjInS/W0BzpGLo2xR2aBwZdg==
6992+
68726993
unicode-canonical-property-names-ecmascript@^1.0.4:
68736994
version "1.0.4"
68746995
resolved "https://registry.yarnpkg.com/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-1.0.4.tgz#2619800c4c825800efdd8343af7dd9933cbe2818"
@@ -7261,6 +7382,11 @@ ws@^6.2.1:
72617382
dependencies:
72627383
async-limiter "~1.0.0"
72637384

7385+
xmlcreate@^2.0.0:
7386+
version "2.0.1"
7387+
resolved "https://registry.yarnpkg.com/xmlcreate/-/xmlcreate-2.0.1.tgz#2ec38bd7b708d213fd1a90e2431c4af9c09f6a52"
7388+
integrity sha512-MjGsXhKG8YjTKrDCXseFo3ClbMGvUD4en29H2Cev1dv4P/chlpw6KdYmlCWDkhosBVKRDjM836+3e3pm1cBNJA==
7389+
72647390
xtend@^4.0.0, xtend@~4.0.1:
72657391
version "4.0.2"
72667392
resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.2.tgz#bb72779f5fa465186b1f438f674fa347fdb5db54"

0 commit comments

Comments
 (0)