Compare commits

...

151 Commits

Author SHA1 Message Date
dependabot[bot] 4d5e6b31d3 Bump cookiejar from 2.1.2 to 2.1.4
Bumps [cookiejar](https://github.com/bmeck/node-cookiejar) from 2.1.2 to 2.1.4.
- [Release notes](https://github.com/bmeck/node-cookiejar/releases)
- [Commits](https://github.com/bmeck/node-cookiejar/commits)

---
updated-dependencies:
- dependency-name: cookiejar
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-01-24 00:39:49 +00:00
Klemek ab23e4aa3c Create docker.yml 2021-06-09 15:34:57 +02:00
Klemek ab573f91ee Merge pull request #58 from Klemek/f-stats-all
/stats?all=true
2021-04-06 10:10:00 +02:00
Klemek 8a9b9cdcfe /stats?all=true 2021-04-06 09:58:51 +02:00
Klemek e56867a269 Update bot_detector.js 2021-04-04 23:33:59 +02:00
Klemek 8e795c6371 Merge pull request #57 from Klemek/f-ignore-bots
ignore bots in hit counter
2021-04-04 23:31:38 +02:00
Klemek c3e53c7df8 more unit tests 2021-04-04 23:24:33 +02:00
Klemek 404b02830d unit testing 2021-04-04 22:48:21 +02:00
Klemek 2fe9a8fecd updated package.json 2021-04-04 21:57:54 +02:00
Klemek 078f3d7416 updated readme 2021-04-04 21:57:16 +02:00
Klemek d69e10202c bot detector handling requests and disabling hit counter 2021-04-04 21:57:09 +02:00
Klemek 140e472e29 bot detector base code 2021-04-04 21:56:39 +02:00
Klemek 823d97f4bb parseInt redis values 2021-03-30 20:19:37 +02:00
Klemek f7167a85a8 1.3.1: current visitors 2021-03-30 20:16:15 +02:00
Klemek 4a3b8267ec update Dockerfile 2021-03-30 19:56:08 +02:00
Klemek d0bebcba87 fix Dockerfile 2021-03-30 19:53:26 +02:00
Klemek 56d7993116 bump to node 15 2021-03-30 19:47:18 +02:00
Klemek 99a19edb93 updated README.md 2021-03-30 19:19:55 +02:00
Klemek da900d2d02 update version to 1.3.0 2021-03-30 19:19:29 +02:00
Klemek 51c1afb4d6 Merge pull request #53 from Klemek/f-hit-counter
Hit counter #47
2021-03-30 19:17:30 +02:00
Klemek dd088a04a3 removed invalid tests 2021-03-30 19:14:00 +02:00
Klemek 6439f8eb92 hit-counter 2021-03-30 19:11:31 +02:00
Klemek 88cb7ce30f eslint update 2021-03-30 16:29:20 +02:00
Klemek b0ba52e140 work in progress hit_counter 2021-03-30 15:30:54 +02:00
Klemek fa5cf31983 comma dangle 2021-03-30 15:20:22 +02:00
Klemek 18b02cf267 eslint jest 2021-03-30 15:07:08 +02:00
Klemek d194fbf032 eslint in CI 2021-03-30 14:56:04 +02:00
Klemek e9d67985a6 eslint integration 2021-03-30 14:53:26 +02:00
Klemek f6d6f04d59 Ci setup (#52)
* Create node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml

* Update node.js.yml
2021-03-30 13:37:31 +02:00
Klemek 5e817cc296 fix tests 2021-03-30 12:48:04 +02:00
Klemek 0f5e40c9ff fix dependencies 2021-03-30 12:32:18 +02:00
Klemek ec79c88bdf Merge pull request #51 from Klemek/snyk-fix-1fcf8450e3fce8a6dcdfb766b19e91f2
[Snyk] Security upgrade ejs from 2.7.1 to 3.1.6
2021-03-30 10:56:07 +02:00
snyk-bot 604d291c37 fix: package.json & package-lock.json to reduce vulnerabilities
The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/SNYK-JS-EJS-1049328
2021-03-30 08:55:25 +00:00
Klemek 0896256e20 Merge branch 'master' of github.com:klemek/gitblog.md 2021-03-30 10:50:32 +02:00
Klemek 250b8a8625 Removed travis CI 2021-03-30 10:50:26 +02:00
Klemek 4f0d37f959 Merge pull request #49 from Klemek/dependabot/npm_and_yarn/y18n-4.0.1
Bump y18n from 4.0.0 to 4.0.1
2021-03-30 10:46:34 +02:00
dependabot[bot] 1bdf10a046 Bump y18n from 4.0.0 to 4.0.1
Bumps [y18n](https://github.com/yargs/y18n) from 4.0.0 to 4.0.1.
- [Release notes](https://github.com/yargs/y18n/releases)
- [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md)
- [Commits](https://github.com/yargs/y18n/commits)

Signed-off-by: dependabot[bot] <support@github.com>
2021-03-30 08:46:04 +00:00
Klemek d25d1a3aa9 Merge pull request #48 from Klemek/dependabot/npm_and_yarn/handlebars-4.7.7
Bump handlebars from 4.2.0 to 4.7.7
2021-03-30 10:45:52 +02:00
Klemek 507d0a792e Merge branch 'master' into dependabot/npm_and_yarn/handlebars-4.7.7 2021-03-30 10:45:45 +02:00
dependabot[bot] da613867d9 Bump handlebars from 4.2.0 to 4.7.7
Bumps [handlebars](https://github.com/wycats/handlebars.js) from 4.2.0 to 4.7.7.
- [Release notes](https://github.com/wycats/handlebars.js/releases)
- [Changelog](https://github.com/handlebars-lang/handlebars.js/blob/master/release-notes.md)
- [Commits](https://github.com/wycats/handlebars.js/compare/v4.2.0...v4.7.7)

Signed-off-by: dependabot[bot] <support@github.com>
2021-03-30 08:45:09 +00:00
Klemek 50074a17c8 Merge pull request #45 from Klemek/dependabot/npm_and_yarn/prismjs-1.23.0
Bump prismjs from 1.17.1 to 1.23.0
2021-03-30 10:44:47 +02:00
Klemek 53c197146a Merge pull request #41 from Klemek/dependabot/npm_and_yarn/handlebars-4.7.6
Bump handlebars from 4.2.0 to 4.7.6
2021-03-30 10:44:35 +02:00
Klemek 09bef2aadd Merge branch 'master' into dependabot/npm_and_yarn/handlebars-4.7.6 2021-03-30 10:44:16 +02:00
Klemek 77e723e6f6 Merge pull request #40 from Klemek/dependabot/npm_and_yarn/showdown-1.9.1
Bump showdown from 1.9.0 to 1.9.1
2021-03-30 10:44:06 +02:00
Klemek 1d50072cc5 Merge pull request #37 from Klemek/dependabot/npm_and_yarn/lodash-4.17.19
Bump lodash from 4.17.15 to 4.17.19
2021-03-30 10:43:54 +02:00
Klemek 157bb405c3 Merge pull request #34 from Klemek/dependabot/npm_and_yarn/acorn-5.7.4
Bump acorn from 5.7.3 to 5.7.4
2021-03-30 10:43:41 +02:00
Klemek 4e10d0326b removed travis CI 2021-03-30 10:43:27 +02:00
dependabot[bot] c03393604c Bump prismjs from 1.17.1 to 1.23.0
Bumps [prismjs](https://github.com/PrismJS/prism) from 1.17.1 to 1.23.0.
- [Release notes](https://github.com/PrismJS/prism/releases)
- [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PrismJS/prism/compare/v1.17.1...v1.23.0)

Signed-off-by: dependabot[bot] <support@github.com>
2021-03-01 20:51:32 +00:00
klemek d15f3e04fb Dockerfile support 2021-01-20 17:00:28 +01:00
dependabot[bot] a21393294b Bump handlebars from 4.2.0 to 4.7.6
Bumps [handlebars](https://github.com/wycats/handlebars.js) from 4.2.0 to 4.7.6.
- [Release notes](https://github.com/wycats/handlebars.js/releases)
- [Changelog](https://github.com/handlebars-lang/handlebars.js/blob/master/release-notes.md)
- [Commits](https://github.com/wycats/handlebars.js/compare/v4.2.0...v4.7.6)

Signed-off-by: dependabot[bot] <support@github.com>
2020-09-07 08:56:42 +00:00
dependabot[bot] 191e24d218 Bump showdown from 1.9.0 to 1.9.1
Bumps [showdown](https://github.com/showdownjs/showdown) from 1.9.0 to 1.9.1.
- [Release notes](https://github.com/showdownjs/showdown/releases)
- [Changelog](https://github.com/showdownjs/showdown/blob/1.9.1/CHANGELOG.md)
- [Commits](https://github.com/showdownjs/showdown/compare/1.9.0...1.9.1)

Signed-off-by: dependabot[bot] <support@github.com>
2020-09-04 06:02:55 +00:00
dependabot[bot] 2c31015a14 Bump lodash from 4.17.15 to 4.17.19
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.15...4.17.19)

Signed-off-by: dependabot[bot] <support@github.com>
2020-07-18 08:05:56 +00:00
dependabot[bot] 4b681d5c3e Bump acorn from 5.7.3 to 5.7.4
Bumps [acorn](https://github.com/acornjs/acorn) from 5.7.3 to 5.7.4.
- [Release notes](https://github.com/acornjs/acorn/releases)
- [Commits](https://github.com/acornjs/acorn/compare/5.7.3...5.7.4)

Signed-off-by: dependabot[bot] <support@github.com>
2020-03-16 12:59:05 +00:00
Klemek b19cf416f9 Merge pull request #29 from Klemek/add-license-1
Create LICENSE
2019-11-12 15:11:43 +01:00
Klemek 5c1a41c319 Create LICENSE 2019-11-12 15:09:46 +01:00
klemek 6e4b50eaa5 link to top was not working in most browsers 2019-10-25 08:26:58 +02:00
klemek 72e880eaf2 test 2019-10-22 21:48:42 +02:00
klemek 919b13db9c test 2019-10-19 16:25:52 +02:00
klemek e598a43acc test 2019-10-19 16:23:11 +02:00
Klemek 6fe5260bd2 Update README.md 2019-10-01 09:04:52 +02:00
Klemek 29ca0d291c Update README.md 2019-10-01 09:04:19 +02:00
Klemek 32f9ea74f1 Merge pull request #27 from Klemek/dev
GitBlog v1.2.8
2019-09-19 20:38:38 +02:00
Klemek 9d1fb69fee nvm 2019-09-19 20:37:40 +02:00
Klemek 24a02d862f fml2 2019-09-19 20:30:35 +02:00
Klemek cfe9965d03 fml 2019-09-19 20:28:20 +02:00
Klemek d260b9d2f8 Merge pull request #26 from Klemek/dev
GitBlog v1.2.8
2019-09-19 20:13:36 +02:00
Klemek 9ec55b3c01 dependencies fix ffs 2019-09-19 20:12:49 +02:00
Klemek c693d96339 Merge pull request #25 from Klemek/dev
GitBlog v1.2.8
2019-09-19 20:09:57 +02:00
Klemek 8bb6b6db66 Merge branch 'master' into dev 2019-09-19 20:07:59 +02:00
Klemek 849cdf2a19 dependencies fix FINALLY 2019-09-19 20:05:10 +02:00
Klemek d0d3f94049 wtf2 2019-09-19 20:02:23 +02:00
Klemek 613e663c13 wtf 2019-09-19 20:01:32 +02:00
Klemek bd10871da9 Merge branch 'dev' 2019-09-19 19:52:55 +02:00
Klemek 671a4314d7 Merge branch 'master' into dev 2019-09-19 19:51:04 +02:00
Klemek 1cee7094f3 Delete package-lock.json 2019-09-19 19:47:33 +02:00
Klemek 2284d46bb5 Merge remote-tracking branch 'origin/dev' into dev 2019-09-19 19:46:19 +02:00
Klemek 7245876b07 dependencies fix 2019-09-19 19:46:09 +02:00
Klemek 7a35aec7ad Merge pull request #23 from Klemek/dependabot/npm_and_yarn/mixin-deep-1.3.2
Bump mixin-deep from 1.3.1 to 1.3.2
2019-09-19 19:27:34 +02:00
dependabot[bot] 870701b6c6 Bump mixin-deep from 1.3.1 to 1.3.2
Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2.
- [Release notes](https://github.com/jonschlinkert/mixin-deep/releases)
- [Commits](https://github.com/jonschlinkert/mixin-deep/compare/1.3.1...1.3.2)

Signed-off-by: dependabot[bot] <support@github.com>
2019-09-19 17:23:38 +00:00
Klemek 3be86dec58 Merge pull request #22 from Klemek/dev
GitBlog.md v1.2.8
2019-09-19 19:22:16 +02:00
Klemek 48d9535007 Merge branch 'master' into dev 2019-09-19 19:16:59 +02:00
Klemek ae2eb52cf8 [skip CI]updated README.md 2019-09-19 19:16:31 +02:00
Klemek 7e9e1e19fa changed version number 2019-09-19 19:14:16 +02:00
Klemek c9ef93088b express rate limit 2019-09-19 19:13:41 +02:00
Klemek 99e4bb5c4d [skip CI] lgtm config 2019-09-19 19:03:49 +02:00
Klemek dd5af2b865 [skip CI] update README.md 2019-09-19 09:26:17 +02:00
Klemek 4671253147 Merge pull request #21 from Klemek/dev
v1.2.7
2019-08-19 14:34:32 +02:00
Klemek add01b28fe Update package.json 2019-08-19 14:25:01 +02:00
Klemek a27a53e238 faDiagram switch to TOML lang 2019-08-19 14:14:52 +02:00
Klemek 6aff9b4d93 Merge remote-tracking branch 'origin/dev' into dev 2019-08-19 14:14:05 +02:00
Klemek c9f57233a4 faDiagram switch to TOML lang 2019-08-19 14:13:54 +02:00
Klemek 7d72e94aa3 Merge pull request #20 from Klemek/dev
updated package-lock
2019-07-19 11:00:33 +02:00
Klemek 3d6a0b4306 Merge branch 'master' into dev 2019-07-19 10:58:52 +02:00
Klemek babc533efc updated package-lock 2019-07-19 10:56:26 +02:00
Klemek 36908134e6 Merge pull request #19 from Klemek/dependabot/npm_and_yarn/lodash-4.17.15
Bump lodash from 4.17.11 to 4.17.15
2019-07-19 10:50:53 +02:00
dependabot[bot] d426b41368 Bump lodash from 4.17.11 to 4.17.15
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.11 to 4.17.15.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.11...4.17.15)

Signed-off-by: dependabot[bot] <support@github.com>
2019-07-19 08:48:39 +00:00
Klemek 1836a414eb Merge pull request #18 from Klemek/dev
v1.2.6
2019-07-19 10:46:33 +02:00
Klemek ca49a29dd9 [skip CI] updated version 2019-07-19 10:44:58 +02:00
Klemek 02a768a6af [skip CI] updated README.md 2019-07-19 10:44:26 +02:00
Klemek bbc4d7c270 [skip CI] updated README.md 2019-07-19 10:42:25 +02:00
Klemek bfa1521f85 updated sample to show fa-diagrams 2019-07-19 10:41:21 +02:00
Klemek a05d380fcf fixed parts detection 2019-07-19 10:41:01 +02:00
Klemek 4a32995ca1 fa-diagrams support 2019-07-19 10:19:12 +02:00
Klemek 53e1fe7201 mathjax/plantuml rendering only outside of code/scripts 2019-07-19 10:01:01 +02:00
Klemek 2e8ff1be92 fixed mathjax in code 2019-07-18 16:41:25 +02:00
Klemek e14f9fc4af Merge remote-tracking branch 'origin/dev' into dev 2019-07-18 14:07:34 +02:00
Klemek 896f302bcf updated default template 2019-07-18 14:07:24 +02:00
Klemek cc0bd1cf49 Merge pull request #17 from Klemek/dev
updated CI
2019-07-12 14:07:36 +02:00
Klemek 7a1d9cbbd6 Merge branch 'master' into dev 2019-07-12 13:59:54 +02:00
Clément GOUIN 34e8d4cb6f updated CI 2019-07-12 13:57:27 +02:00
Klemek 4a9b70ac68 Update .travis.yml 2019-07-12 13:53:55 +02:00
Klemek 889258c874 Update .travis.yml 2019-07-12 11:53:02 +02:00
Klemek de26feb05c Merge pull request #16 from Klemek/dev
v1.2.5
2019-07-01 23:17:56 +02:00
Klemek 8bb455b576 Fixed draft rendering bug 2019-07-01 23:15:13 +02:00
Klemek 378ed438b6 Merge pull request #15 from Klemek/dev
v1.2.4
2019-07-01 23:03:23 +02:00
Klemek 3b07b6b9c5 Drafted articles 2019-07-01 22:18:40 +02:00
Klemek b6afcd4992 Update README.md 2019-06-26 21:20:45 +02:00
Klemek 35fcdc7320 Merge pull request #14 from Klemek/dev
v1.2.3
2019-06-26 21:03:49 +02:00
Klemek dfb93b6764 [skip CI]Updated nodemon config 2019-06-26 21:03:39 +02:00
Klemek 6af4012522 Hidden files path matching 2019-06-26 20:59:42 +02:00
Klemek 1b91002c03 Updated templates meta tags 2019-06-26 20:09:08 +02:00
Klemek bedd6a2953 Merge pull request #13 from Klemek/dev
v1.2.2
2019-06-26 19:52:25 +02:00
Klemek 52d37d56cd Bug fix 2019-06-26 19:48:51 +02:00
Klemek fc7bc63c46 Nodemon config 2019-06-26 19:44:52 +02:00
Klemek 4397a76d9b Merge pull request #12 from Klemek/dev
v1.2.1
2019-06-26 19:35:29 +02:00
Klemek ddf964eb27 Updated version 2019-06-26 19:28:29 +02:00
Klemek 4b47276484 Updated readme 2019-06-26 19:28:18 +02:00
Klemek a7fedb149f Host from config if specified 2019-06-26 19:28:00 +02:00
Klemek ea95a285c9 Merge pull request #11 from Klemek/dev
v1.2.0
2019-06-26 19:00:30 +02:00
Klemek 0fde428806 Updated coverage 2019-06-26 18:56:01 +02:00
Klemek 8fc7ff1ca7 Updated version 2019-06-26 18:44:31 +02:00
Klemek ae4e2eb8d5 Fixing Firefox RSS handling 2019-06-26 18:43:41 +02:00
Klemek 528e4be1fe Updated templates 2019-06-26 18:34:40 +02:00
Klemek bd42883330 Update template.ejs 2019-06-26 18:21:44 +02:00
Klemek b6ac0a73b4 Update style.css 2019-06-26 18:21:26 +02:00
Klemek aebc3da5bc Update template.ejs 2019-06-26 16:43:03 +02:00
Klemek 7a4a4f9006 Update footer.ejs 2019-06-26 15:07:32 +02:00
Klemek 1341aa5a56 Update config.default.json 2019-06-26 11:46:06 +02:00
Klemek 5e05f250f4 Update style.css 2019-06-26 10:06:12 +02:00
Klemek 6cf7be3afb Update README.md 2019-06-23 15:37:23 +02:00
Klemek 6aceacad18 Update README.md 2019-06-23 15:34:46 +02:00
Klemek a3a23be1c2 Update README.md 2019-06-23 15:34:34 +02:00
Klemek e8e8024021 Merge pull request #10 from Klemek/dev
v1.1.5
2019-06-23 15:15:45 +02:00
Klemek 1806d60ca7 Fixed meta tags being wrong 2019-06-23 15:14:47 +02:00
Klemek 2c5f2e589f Merge pull request #9 from Klemek/dev
v1.1.4
2019-06-23 15:09:27 +02:00
Klemek 847d228c0a Updated templates 2019-06-23 15:06:15 +02:00
Klemek 576948acee ViewPort property 2019-06-23 15:05:06 +02:00
Klemek fa6d91db20 updated README.md 2019-06-23 15:04:15 +02:00
Klemek 989bcdf130 Pages metadata by default 2019-06-23 15:02:33 +02:00
Klemek 90c343c752 Merge remote-tracking branch 'origin/master' 2019-06-19 18:41:23 +02:00
Klemek ff7542af70 updated uml 2019-06-18 20:14:37 +02:00
40 changed files with 13592 additions and 6689 deletions
View File
+106
View File
@@ -0,0 +1,106 @@
module.exports = {
plugins: [ 'jest' ],
env: {
'commonjs': true,
'es2021': true,
'node': true,
'jest/globals': true,
},
extends: [
'eslint:recommended',
'plugin:jest/recommended',
],
parserOptions: {
ecmaVersion: 12,
},
rules: {
'indent': [
'error',
4,
],
'linebreak-style': [
'error',
'unix',
],
'quotes': [
'error',
'single',
],
'semi': [
'error',
'always',
],
'curly': [
'error',
'all',
],
'brace-style': [
'error',
'1tbs',
],
'jest/no-done-callback': 'off',
'jest/expect-expect': 'off',
'comma-dangle': [
'error',
'always-multiline',
],
'complexity': 'error',
'consistent-return': 'error',
'dot-location': [
'error',
'property',
],
'eqeqeq': [
'error',
'always',
{ null: 'ignore' },
],
'no-empty-function': 'error',
'no-floating-decimal': 'error',
'no-multi-spaces': 'error',
'camelcase': [
'error',
{ properties: 'never' },
],
'comma-spacing': [
'error',
{ before: false, after: true },
],
'array-bracket-newline': [
'error',
{ multiline: true },
],
'array-element-newline': [
'error',
{ multiline: true, minItems: 2 },
],
'array-bracket-spacing': [
'error',
'always',
],
'object-curly-spacing': [
'error',
'always',
],
'comma-style': 'error',
'computed-property-spacing': 'error',
'eol-last': 'error',
'func-call-spacing': 'error',
'key-spacing': 'error',
'keyword-spacing': 'error',
'multiline-comment-style': 'error',
'newline-per-chained-call': 'error',
'no-lonely-if': 'error',
'no-multiple-empty-lines': 'error',
'no-trailing-spaces': 'error',
'no-unneeded-ternary': 'error',
'no-whitespace-before-property': 'error',
'operator-assignment': 'error',
'quote-props': [
'error',
'consistent-as-needed',
],
'space-before-blocks': 'error',
'space-infix-ops': 'error',
},
};
+34
View File
@@ -0,0 +1,34 @@
name: Docker
on: ["push", "pull_request"]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
- name: Cache Docker layers
uses: actions/cache@v2
with:
path: /tmp/.buildx-cache
key: ${{ runner.os }}-buildx-${{ github.sha }}
restore-keys: |
${{ runner.os }}-buildx-
- name: Build
uses: docker/build-push-action@v2
with:
context: ./
file: ./Dockerfile
builder: ${{ steps.buildx.outputs.name }}
push: false
cache-from: type=local,src=/tmp/.buildx-cache
cache-to: type=local,dest=/tmp/.buildx-cache-new
- name: Move cache
run: |
rm -rf /tmp/.buildx-cache
mv /tmp/.buildx-cache-new /tmp/.buildx-cache
- name: Image digest
run: echo ${{ steps.docker_build.outputs.digest }}
+31
View File
@@ -0,0 +1,31 @@
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
name: Tests and coverage
on: ["push", "pull_request"]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x, 15.x]
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
- run: npm run build --if-present
- name: ESLint
run: npm run test-lint
- name: Jest
run: npm run test-cov
- name: Coveralls
run: npm run coveralls
env:
COVERALLS_REPO_TOKEN: "${{ secrets.COVERALLS_REPO_TOKEN }}"
COVERALLS_GIT_BRANCH: "${{ github.ref }}"
+2
View File
@@ -2,7 +2,9 @@
/node_modules
/config.json
/config.example.json
/robots_list.json
/data
/data/*
/test_data
/access.log
/error.log
-21
View File
@@ -1,21 +0,0 @@
{
"esversion": 6,
"maxerr": 999,
"indent": true,
"camelcase": true,
"eqeqeq": true,
"forin": true,
"immed": true,
"latedef": true,
"noarg": true,
"noempty": true,
"nonew": true,
"undef": true,
"unused": true,
"varstmt": true,
"sub": true,
"quotmark": "single",
"node": true,
"globals": {
}
}
-15
View File
@@ -1,15 +0,0 @@
dist: xenial
language: node_js
node_js:
- "12"
cache:
npm: true
directories:
- node_modules
install:
- npm install
before_script:
- npm install -g jshint
script:
- jest --silent --coverage --coverageReporters=text-lcov | coveralls
- jshint ./src
Executable
+22
View File
@@ -0,0 +1,22 @@
FROM node:15
# Create app directory
WORKDIR /usr/src/app
VOLUME [ "/usr/src/app/data" ]
# Install app dependencies
# A wildcard is used to ensure both package.json AND package-lock.json are copied
# where available (npm@5+)
COPY package*.json ./
COPY src/postinstall.js ./src/postinstall.js
COPY src/config.default.json ./src/config.default.json
RUN npm install
# If you are building your code for production
# RUN npm ci --only=production
# Bundle app source
COPY . .
CMD [ "sh", "-c", "node src/server.js" ]
+201
View File
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+80 -7
View File
@@ -1,8 +1,9 @@
# GitBlog.md
[![Build Status](https://img.shields.io/travis/Klemek/GitBlog.md.svg?branch=master)](https://travis-ci.org/Klemek/GitBlog.md)
[![Scc Count Badge](https://sloc.xyz/github/klemek/gitblog.md/?category=code)](https://github.com/boyter/scc/#badges-beta)
[![Coverage Status](https://img.shields.io/coveralls/github/Klemek/GitBlog.md.svg?branch=master)](https://coveralls.io/github/Klemek/GitBlog.md?branch=master)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Klemek/GitBlog.md.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Klemek/GitBlog.md/context:javascript)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/Klemek/GitBlog.md.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Klemek/GitBlog.md/alerts/)
# GitBlog.md
A static blog using Markdown pulled from your git repository.
@@ -125,6 +126,34 @@ Resources are located on the `data` folder and can be referenced as the root of
/styles/main.css => data/styles/main.css
```
In your template, the following data is sent :
<details>
<summary>details (click)</summary>
<p>
* `info` (every pages)
* `title` : the blog's title as in the config
* `description` the blog's description as in the config
* `host` : the specified or guessed host with the protocol
* `version` : the GitBlog.md current running version
* `request` : the Express request object
* `config` : the content of the config
* `article` (article pages only)
* `title` : the full title
* `thumbnail` the URL path of the thumbnail
* `url` : the URL path for this article (with the title)
* `date` : a JS date
* `year`
* `month`
* `day`
* `path` : the URL path for the folder of the article (without the title)
* `realPath` : the system's path for the folder
* `escapedTitle` : the code with alphanumeric and underscore characters only
* `error` (error pages only) : the error code
</p>
</details>
#### 5. Create and init your git source
You need to [create a new repository](https://github.com/new) on your favorite Git service.
@@ -132,7 +161,10 @@ You need to [create a new repository](https://github.com/new) on your favorite G
```bash
#gitblog.md/
cd data
git init
git remote add origin <url_of_your_repo.git>
git add .
git commit -m "initial commit"
git push -u origin master
```
@@ -157,7 +189,7 @@ Here are the steps for Github, if you use another platform adapt it your way (he
```json
"webhook": {
"endpoint": "/webhook",
"secret": "sha1=<value>",
"secret": "<value>",
"signature_header": "X-Hub-Signature"
},
```
@@ -165,6 +197,14 @@ Here are the steps for Github, if you use another platform adapt it your way (he
* Update your webhook on github to include the secret
* Check if Github successfully reached the endpoint
#### 8. Keep your server always up and running (optionnal)
This project `package.json` comes with a [nodemon](https://github.com/remy/nodemon) config.
After installing (`npm i -g nodemon`) you can then run the app with juste the `nodemon` command in the working directory.
With this method, you can do a simple `git pull` to update your server.
## Writing an article
[back to top](#gitblog-md)
@@ -206,16 +246,24 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
It allows you to add math equations to your articles by simply writing LaTeX between `$$` for full size (and between $ for inline) (more info [here](https://www.mathjax.org/))
* **PlantUML**
It allows you to add UML diagrams with PlantUML Syntax between `@startuml` and `@enduml` (more info [here](http://www.plantuml.com))
* **fa-diagrams**
It allows you to define SVG diagrams with Font-Awesome icons in [TOML](https://github.com/toml-lang/toml) between `@startfad` and `@endfad` (more info [here](https://github.com/Klemek/fa-diagrams))
## Configuration
[back to top](#gitblog-md)
* `node_port` (default: 3000)
the port the server is listening to
* `host` (default: none)
if set (like `https://mywebsite.com`, it will be used as reference for creating links
by default, host is guessed based on first request
* `data_dir` (default: data)
the directory where will be located the git repo with templates and articles
* `view_engine` (default: ejs)
the Express view engine used to render pages from templates
* `rate_limit` (default: 100)
number of requests allowed in a time-frame of 15 minutes
* `access_log` (default: access.log)
log file where to save access requests (empty to disable)
* `error_log` (default: error.log)
@@ -231,18 +279,30 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
activate MathJax equations formatting
* `plantuml` (default: true)
activate PlantUML diagram rendering
* `fa-diagrams` (default: true)
activate fa-diagrams rendering
* `hit_counter` (default: true)
activate /stats endpoints and visitor counting (need an active redis connection)
* `home`
* `title` (default: GitBlog.md)
the title of your blog, **strongly advised to be changed**
given to the template to complete page title and metadata
* `description` (default: A static blog using Markdown pulled from your git repository)
the description of your blog, **strongly advised to be changed**
given to the template to complete page title and metadata
* `index` (default: index.ejs)
the name of the home page template on the data directory
it will receive `articles`, a list of articles for rendering
* `error` (default: error.ejs)
the name of the error page template on the data directory
it will receive `error`, the error code
* `hidden` (default: `[.ejs]`)
file extensions to be returned 404 when reached
* `hidden` (default: `[*.ejs,/.git*]`)
path matches to be returned 404 when reached
* `article`
* `index` (default: index.md)
the name of the Markdown page of the article on the `/year/month/day/` directory
* `draft` (default: draft.md)
the name of the Markdown page of an article not shown on the list
* `template` (default: template.ejs)
the name of the article page template on the data directory
* `thumbnail_tag`: (default: thumbnail)
@@ -273,3 +333,16 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
specify the output format between svg, html or MathMl (mml)
* `speak_text`: (default: true)
activate the alternate text in equations
* `hit_counter`
* `unique_visitor_timeout`: (default: 7200000 / 2h)
specify the time (in ms) before a visitor can be accounted again
* `robots`
* `list_url`: (default: https://raw.githubusercontent.com/atmire/COUNTER-Robots/master/COUNTER_Robots_list.json)
url to fetch for web crawlers patterns
* `list_file`: (default: robots_list.json)
file to store web crawlers patterns
* `redis`
Options to connect to redis (see [redis options](https://github.com/NodeRedis/node-redis#options-object-properties) for more info)
* `host`: (default: localhost)
* `port`: (default: 6379)
+7
View File
@@ -0,0 +1,7 @@
path_classifiers:
test:
- test
docs:
- uml
library:
- src/lib
+10590 -5380
View File
File diff suppressed because it is too large Load Diff
+28 -10
View File
@@ -1,32 +1,39 @@
{
"name": "gitblog.md",
"version": "1.1.3",
"version": "1.3.3",
"description": "A static blog using Markdown pulled from your git repository.",
"main": "src/server.js",
"dependencies": {
"@iarna/toml": "^2.2.3",
"body-parser": "^1.19.0",
"crypto": "^1.0.1",
"ejs": "^2.6.2",
"ejs": "^3.1.6",
"express": "^4.17.1",
"express-rate-limit": "^5.0.0",
"fa-diagrams": "^1.0.3",
"mathjax-node": "^2.1.1",
"ncp": "^2.0.0",
"node-prismjs": "^0.1.2",
"prismjs": "^1.16.0",
"node-prismjs": "^0.1.0",
"prismjs": "^1.23.0",
"redis": "^3.0.2",
"rss": "^1.2.2",
"showdown": "^1.9.0"
"showdown": "^1.9.1"
},
"devDependencies": {
"babel-cli": "^6.26.0",
"babel-preset-env": "^1.7.0",
"coveralls": "^3.0.4",
"eslint": "^7.23.0",
"eslint-plugin-jest": "^24.3.2",
"jest": "^24.8.0",
"superagent": "^5.1.0",
"supertest": "^4.0.2"
},
"scripts": {
"start": "node src/server.js",
"test": "jest --silent",
"install": "node src/postinstall.js"
"test": "jest --silent -i",
"test-cov": "jest --silent -i --coverage",
"coveralls": "coveralls < coverage/lcov.info",
"test-lint": "eslint .",
"install": "node src/postinstall.js",
"lint": "eslint --fix ."
},
"repository": {
"type": "git",
@@ -46,5 +53,16 @@
"!src/postinstall.js",
"!src/lib/*.js"
]
},
"nodemonConfig": {
"verbose": true,
"ignore": [
"test/*",
"sample_data/*",
"data/*",
"uml/*",
"*.log",
"README.md"
]
}
}
+29
View File
@@ -19,6 +19,7 @@ If you see this page, that means it's working
* [Spoilers](#spoilers)
* [Math Equations](#mathequations)
* [UML](#uml)
* [Diagrams](#diagrams)
* [Youtube Videos](#youtubevideos)
### Headers
@@ -253,6 +254,34 @@ showdown -left-> express : 4. html
express -up-> web : 5. html
@enduml
### Diagrams
[Back to top](#top)
You can use [fa-diagrams](https://github.com/Klemek/fa-diagrams) with `@startfad` and `@endfad` tags and using [TOML](https://github.com/toml-lang/toml) inside
@startfad
[[nodes]]
name = "node1"
icon = "laptop-code"
color = "#4E342E"
bottom = "my app"
[[nodes]]
name = "node2"
icon = "globe"
color = "#455A64"
bottom = "world"
[[links]]
from = "node1"
to = "node2"
color = "#333333"
bottom = '"hello"'
[links.top]
icon = "envelope"
@endfad
### Youtube Videos
[Back to top](#top)
+2 -3
View File
@@ -1,9 +1,8 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Error <%= error %></title>
<link rel="stylesheet" type="text/css" href="/style.css">
<%- include('head'); %>
<title><%= info.title %> - Error <%= error %></title>
</head>
<body>
<main>
+1 -1
View File
@@ -1,6 +1,6 @@
<hr>
<footer>
<small><a href="/rss">RSS feed</a> - @<%= new Date().getFullYear() %> - Made with <a
<small><a href="/rss">RSS feed</a> - <%= new Date().getFullYear() %> - Made with <a
href="https://github.com/klemek/gitblog.md">GitBlog.md</a> (v<%= info.version %>)
</small>
</footer>
+30
View File
@@ -0,0 +1,30 @@
<meta charset="UTF-8">
<meta http-equiv="content-type" content="text/html;charset=UTF-8">
<META NAME="ROBOTS" CONTENT="INDEX, FOLLOW">
<meta name="twitter:card" content="summary_large_image">
<%- `<meta property="og:description" content="${info.description}">` %>
<%- `<meta property="twitter:description" content="${info.description}">` %>
<% if(locals.article){ %>
<%- `<meta property="org:url" content="${info.host + article.url}">` %>
<%- `<meta property="og:title" content="${info.title} - ${article.title}">` %>
<%- `<meta property="twitter:title" content="${info.title} - ${article.title}">` %>
<% if (article.thumbnail) { %>
<%- `<meta property="og:image" content="${info.host}/${article.thumbnail}">` %>
<%- `<meta property="twitter:image" content="${info.host}/${article.thumbnail}">` %>
<% } %>
<link rel="stylesheet" type="text/css" href="/css/prism.css">
<% } else { %>
<%- `<meta property="org:url" content="${info.host}/">` %>
<%- `<meta property="og:title" content="${info.title} - Home">` %>
<%- `<meta property="twitter:title" content="${info.title} - Home">` %>
<%- `<meta property="description" content="${info.description}">` %>
<% } %>
<link rel="alternate" type="application/rss+xml" title="RSS feed" href="/rss"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
<link rel="stylesheet" type="text/css" href="/style.css">
+8 -7
View File
@@ -1,22 +1,23 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>GitBlog.md - Home</title>
<link rel="stylesheet" type="text/css" href="style.css">
<%- include('head'); %>
<title><%= info.title %> - Home</title>
</head>
<body>
<main>
<h1>GitBlog.md</h1>
A static blog using Markdown pulled from your git repository
<h1 class="title"><%= info.title %></h1>
<%= info.description %>
<h2>Articles in this blog :</h2>
<% articles.forEach((article) => { %>
<div class="article">
<h3><%- `<a href="${article.url}">${article.title}</a>` %></h3>
<span class="time"><span>Published on</span> <%= article.year + '-' + article.month + '-' + article.day %></span>
<%- `<a href="${article.url}">` %>
<h3><%- `${article.title}` %></h3>
<span class="time"><span>Published on</span>&nbsp;&nbsp;<%= article.year + '-' + ('0' + article.month).slice(-2) + '-' + ('0' + article.day).slice(-2) %></span>
<% if(article.thumbnail){ %>
<%- `<img alt="thumbnail" src=${article.thumbnail}>` %>
<% } %>
<%- `</a>` %>
</div>
<% }); %>
<%- include('footer'); %>
+38 -7
View File
@@ -8,7 +8,7 @@ body, html {
}
body {
font: 14px/1.45 -apple-system, BlinkMacSystemFont, Segoe UI, sans-serif;
font: 15px sans-serif;
color: #111;
-webkit-text-size-adjust: none;
background-color: #F5F5F5;
@@ -16,8 +16,8 @@ body {
}
main {
max-width: 75ch;
padding: 2ch;
max-width: 45rem;
padding: 2rem;
margin: auto;
background-color: #F0F0F0;
min-height: 100vh;
@@ -54,11 +54,18 @@ pre {
padding: 10px 16px;
}
:not(pre) > code {
padding: 0.25em 0.5em;
border-radius: 0.25em;
background: #DDD;
font-size: 90%;
}
blockquote {
border-left: 0.5em solid #ccc;
padding-left: 1em;
margin: 0.25em 0;
color: #333;
color: #555;
}
blockquote > p {
@@ -108,10 +115,11 @@ main.article div.header a.link-home {
line-height: 2.4;
}
main.article div.header h1, main.article div.header h2, div.article h3 {
main.article div.header h1, main.article div.header h2, .title {
margin-top: 0.85em;
margin-bottom: 0.25em;
font-size: 2em;
font-weight: bold;
}
main.article div.header h1 a, main.article div.header h2 a, div.article h3 a {
@@ -123,13 +131,36 @@ main.article div.header span.time, div.article span.time {
}
div.article {
margin-left: 1em;
margin: 0 1em 1em 1em;
}
div.article h3 {
font-size: 1.3em;
margin:0;
color: #3C3CA1;
}
div.article a {
text-decoration: none;
color: inherit;
}
div.article img{
max-width: 100%;
height: auto;
margin-right:1em;
margin-top:0.25em;
}
div.article:hover {
opacity: 0.9;
}
div.article:active {
opacity: 0.8;
}
#text {
text-align: justify;
hyphens: auto;
@@ -139,7 +170,7 @@ div.article h3 {
text-align: left;
}
#text img {
#text img, #text svg {
max-width: 100%;
height: auto;
}
+4 -6
View File
@@ -1,17 +1,15 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>GitBlog.md - <%= article.title %></title>
<link rel="stylesheet" type="text/css" href="/prism.css">
<link rel="stylesheet" type="text/css" href="/style.css">
<%- include('head'); %>
<title><%= info.title %> - <%= article.title %></title>
</head>
<body>
<main class="article">
<main class="article" id="top">
<div class="header">
<a class="link-home" href="/">↑</a>
<h1><%= article.title %></h1>
<span class="time"><span>Published on</span> <%= article.year + '-' + article.month + '-' + article.day %></span>
<span class="time"><span><%= article.draft ? 'Drafted on' : 'Published on' %></span>&nbsp;&nbsp;<%= article.year + '-' + ('0' + article.month).slice(-2) + '-' + ('0' + article.day).slice(-2) %></span>
</div>
<div id="text"><%- article.content %></div>
<br>
+187 -71
View File
@@ -3,6 +3,7 @@ const app = express();
const fs = require('fs');
const path = require('path');
const pjson = require('../package.json');
const rateLimit = require('express-rate-limit');
app.enable('trust proxy');
@@ -26,8 +27,57 @@ const cons = {
};
module.exports = (config) => {
/**
* Fetch articles from the data folder and send success as a response
* @param success
* @param error
*/
let reload;
/**
* Render the page with the view engine and catch errors
* @param req
* @param res
* @param vPath - path of the view
* @param data - data to pass to the view
* @param code - code to send along the page
*/
let render;
/**
* Show an error with the correct page
* @param req
* @param res
* @param code - error code
*/
let showError;
const fw = require('./file_walker')(config);
const renderer = require('./renderer')(config);
const hc = require('./hit_counter')(config,
() => {
console.log(cons.ok, 'redis connected');
},
(err) => {
if (err.code !== 'ECONNREFUSED') {
console.log(cons.warn, 'redis error: ' + err);
}
},
);
const botDetector = require('./bot_detector')(config);
botDetector.load((status, err) => {
switch (status) {
case botDetector.status.FETCH_OK:
console.log(cons.ok, 'fetched robots list');
break;
case botDetector.status.FETCH_ERROR:
console.error(cons.error, 'error fetching robots list : ' + err);
break;
case botDetector.status.READ_OK:
console.log(cons.ok, `read robots list: ${botDetector.count}`);
break;
case botDetector.status.READ_ERROR:
console.error(cons.error, 'error reading robots list : ' + err);
break;
}
});
// set view engine from configuration
app.set('view engine', config['view_engine']);
@@ -36,70 +86,85 @@ module.exports = (config) => {
const articles = {};
let lastRSS = '';
let host = config['host'];
/**
* Fetch articles from the data folder and send success as a response
* @param success
* @param error
*/
const reload = (success, error) => {
reload = (success, error) => {
fw.fetchArticles((err, dict) => {
if (err) {
console.error(cons.error, 'error loading articles : ' + err);
return error ? error() : null;
}
error();
} else {
Object.keys(articles).forEach((key) => delete articles[key]);
Object.keys(dict).forEach((key) => articles[key] = dict[key]);
const nb = Object.keys(articles).length;
if (nb > 0)
console.log(cons.ok, `loaded ${nb} article${nb > 1 ? 's' : ''}`);
else
console.log(cons.warn, `no articles loaded, check your configuration`);
const dnb = Object.values(articles).filter(a => a.draft).length;
if (nb > 0) {
console.log(cons.ok, `loaded ${nb} article${nb > 1 ? 's' : ''} (${dnb} drafted)`);
} else {
console.log(cons.warn, 'no articles loaded, check your configuration');
}
lastRSS = '';
success();
}
});
};
if (config['test'])
if (config['test']) {
app.reload = reload;
}
/**
* Render the page with the view engine and catch errors
* @param res
* @param vPath - path of the view
* @param data - data to pass to the view
* @param code - code to send along the page
*/
const render = (res, vPath, data, code = 200) => {
render = (req, res, vPath, data, code = 200) => {
data.info = {
version: pjson.version
title: config['home']['title'],
description: config['home']['description'],
host: host,
version: pjson.version,
request: req,
config: config,
};
res.render(vPath, data, (err, html) => {
if (err) {
if (err && vPath !== path.join(config['data_dir'], config['home']['error'])) {
console.log(cons.error, `failed to render page ${vPath} : ${err}`);
showError(req, res, 500);
} else if (err) {
res.sendStatus(500);
console.log(cons.error, `failed to render ${vPath} : ${err}`);
} else
console.log(cons.error, `failed to render error page : ${err}`);
} else {
res.status(code).send(html);
}
});
};
/**
* Show an error with the correct page
* @param resPath - the page of the original error
* @param code - error code
* @param res
*/
const showError = (resPath, code, res) => {
showError = (req, res, code) => {
const errorPath = path.join(config['data_dir'], config['home']['error']);
fs.access(errorPath, fs.constants.R_OK, (err) => {
if (err)
if (err) {
res.sendStatus(code);
else
render(res, errorPath, {error: code, path: resPath}, code);
} else {
render(req, res, errorPath, { error: code }, code);
}
});
};
app.use((req, res, next) => {
if (!host) {
host = 'http://' + req.headers.host;
console.log(cons.ok, 'Currently hosted on ' + host);
}
next();
});
//rate limit for safer server
const limiter = rateLimit({
windowMs: 15 * 60 * 1000, // 15 minutes
max: config['rate_limit'],
});
app.use(limiter);
//detect robots
app.use(botDetector.handle);
//log request at result end
app.use((req, res, next) => {
if (config['access_log']) {
@@ -107,7 +172,7 @@ module.exports = (config) => {
res.end = (chunk, encoding) => {
fs.appendFile(config['access_log'],
`${res.statusCode} ${req.method} ${req.url} ${new Date().toUTCString()} ${req.ips.join(' ') || req.ip}\n`,
{encoding: 'UTF-8'}, () => {
{ encoding: 'UTF-8' }, () => {
res.end = end;
res.end(chunk, encoding);
});
@@ -120,61 +185,99 @@ module.exports = (config) => {
app.get('/', (req, res) => {
const homePath = path.join(config['data_dir'], config['home']['index']);
fs.access(homePath, fs.constants.R_OK, (err) => {
if (err)
showError(req.path, 404, res);
else
render(res, homePath, {articles: Object.values(articles).sort((a, b) => ('' + b.path).localeCompare(a.path))});
if (err) {
showError(req, res, 404);
} else {
hc.count(req, '/', req.isRobot, () => {
render(req, res, homePath,
{
articles: Object.values(articles)
.filter(d => !d.draft)
.sort((a, b) => ('' + b.path).localeCompare(a.path)),
});
});
}
});
});
app.get('/stats', (req, res) => {
if (config['modules']['hit_counter']) {
if (req.query['all']) {
const keys = Object.keys(articles).filter(key => !articles[key].draft);
keys.unshift('/');
const read = (i, outputData) => {
if (i >= keys.length) {
res.json(outputData);
} else {
hc.read(keys[i], (data) => {
outputData.push(data);
read(i + 1, outputData);
});
}
};
read(0, []);
} else {
hc.read('/', (data) => {
res.json(data);
});
}
} else {
showError(req, res, 404);
}
});
//RSS endpoint
app.get(config['rss']['endpoint'], (req, res) => {
if (config['modules']['rss']) {
if (!lastRSS) {
const feed = new Rss({
'title': config['rss']['title'],
'description': config['rss']['description'],
'feed_url': 'http://' + req.headers.host + req.url,
'site_url': 'http://' + req.headers.host
title: config['rss']['title'],
description: config['rss']['description'],
feed_url: host + req.url,
site_url: host,
});
Object.values(articles)
.slice(0, config['rss']['length'])
.forEach((article) => {
feed.item({
title: article.title,
url: 'http://' + req.headers.host + article.url,
date: article.date
url: host + article.url,
date: article.date,
});
});
lastRSS = feed.xml();
}
res.type('rss').send(lastRSS);
res.type(req.headers['user-agent'].match(/Mozilla/) ? 'text/xml' : 'rss').send(lastRSS);
} else {
showError(req.path, 404, res);
showError(req, res, 404);
}
});
//webhook endpoint
app.post(config['webhook']['endpoint'], (req, res) => {
if (config['modules']['webhook']) {
let valid = true;
if (config['webhook']['signature_header'] && config['webhook']['secret']) {
const payload = JSON.stringify(req.body) || '';
const hmac = crypto.createHmac('sha1', config['webhook']['secret']);
const digest = 'sha1=' + hmac.update(payload).digest('hex');
const checksum = req.headers[config['webhook']['signature_header']];
if (!checksum || !digest || checksum !== digest) {
return res.sendStatus(403);
res.sendStatus(403);
valid = false;
}
}
cp.exec(config['webhook']['pull_command'], {cwd: path.join(__dirname, '..', config['data_dir'])}, (err) => {
if (valid) {
cp.exec(config['webhook']['pull_command'], { cwd: path.join(__dirname, '..', config['data_dir']) }, (err) => {
if (err) {
console.log(cons.error, `command '${config['webhook']['pull_command']}' failed : ${err}`);
return res.sendStatus(500);
}
res.sendStatus(500);
} else {
reload(() => {
res.sendStatus(200);
});
}
});
}
} else {
res.sendStatus(400);
}
@@ -182,32 +285,45 @@ module.exports = (config) => {
//rewrite urls to hide articles titles : /2019/05/05/sometitle/img.png => /2019/05/05/img.png
app.use((req, res, next) => {
if (/^\/\d{4}\/\d{2}\/\d{2}\//.test(req.url))
if (/^\/\d{4}\/\d{2}\/\d{2}\//.test(req.url)) {
req.url = req.url.slice(0, 11) + req.url.slice(req.url.lastIndexOf('/'));
}
next();
});
// catch all article urls and render them
app.get('*', (req, res, next) => {
if (/^\/\d{4}\/\d{2}\/\d{2}\/$/.test(req.path)) {
if (/^\/\d{4}\/\d{2}\/\d{2}\/(stats)?$/.test(req.path)) {
const articlePath = req.path.substr(1, 10);
const article = articles[articlePath];
if (!article)
showError(req.path, 404, res);
else {
renderer.render(path.join(article.realPath, config['article']['index']), (err, html) => {
if (!article) {
showError(req, res, 404);
} else if (req.path.endsWith('stats')) {
if (config['modules']['hit_counter']) {
hc.read(articlePath, (data) => {
res.json(data);
});
} else {
showError(req, res, 404);
}
} else {
hc.count(req, articlePath, req.isRobot, () => {
renderer.render(article.realPath, (err, html) => {
if (err) {
console.log(cons.error, `failed to render article ${req.path} : ${err}`);
return showError(req.path, 500, res);
}
showError(req, res, 500);
} else {
article.content = html;
const templatePath = path.join(config['data_dir'], config['article']['template']);
fs.access(templatePath, fs.constants.R_OK, (err) => {
if (err) {
console.log(cons.error, `no template found at ${templatePath}`);
showError(req.path, 500, res);
} else
render(res, templatePath, {article: article});
showError(req, res, 500);
} else {
render(req, res, templatePath, { article: article });
}
});
}
});
});
}
@@ -217,18 +333,17 @@ module.exports = (config) => {
});
// catch all hidden file type and return 404
app.get('*', (req, res, next) => {
if (config['home']['hidden'].includes(path.extname(req.path)))
showError(req.path, 404, res);
else
next();
config['home']['hidden'].forEach(pathMatcher => {
app.get(pathMatcher, (req, res) => {
showError(req, res, 404);
});
});
// serve all static files via get
app.get('*', express.static(path.join(__dirname, '..', config['data_dir'])));
// catch express.static errors (mostly not found) by displaying 404
app.get('*', (req, res) => {
showError(req.path, 404, res);
showError(req, res, 404);
});
// catch all other methods and return 400
@@ -239,11 +354,12 @@ module.exports = (config) => {
//log all server errors
app.use((err, req, res, next) => {
console.log(cons.error, `error when handling ${req.method} ${req.path} request : ${err}`);
if (!config['error_log'])
if (!config['error_log']) {
next(err);
}
fs.appendFile(config['error_log'],
`500 ${req.method} ${req.url} ${new Date().toUTCString()} ${req.ips.join(' ') || req.ip}\n${err.stack}\n`,
{encoding: 'UTF-8'}, () => {
{ encoding: 'UTF-8' }, () => {
next(err);
});
});
+66
View File
@@ -0,0 +1,66 @@
const https = require('https');
const fs = require('fs');
module.exports = (config) => {
const _this = {
status: {
FETCH_OK: 1,
FETCH_ERROR: 2,
READ_OK: 3,
READ_ERROR: 4,
},
count: [],
regex: null,
};
const fetchList = (cb) => {
https.get(config['robots']['list_url'], (res) => {
if (res.statusCode !== 200) {
cb(res.statusCode);
} else {
const file = fs.createWriteStream(config['robots']['list_file']);
res.pipe(file);
file.on('finish', () => {
file.close(cb);
});
}
}).on('error', (err) => {
cb(err.message);
});
};
const readFile = (cb) => {
fs.readFile(config['robots']['list_file'], { encoding: 'utf-8' }, (err, data) => {
if (err) {
cb(err, undefined);
} else {
try {
cb(undefined, JSON.parse(data));
} catch (err) {
cb(err, undefined);
}
}
});
};
_this.load = (cb) => {
fetchList((err) => {
cb(err ? _this.status.FETCH_ERROR : _this.status.FETCH_OK, err);
readFile((err, data) => {
if (!err) {
_this.count = data.length;
_this.regex = new RegExp('(' + data.filter(v => v['pattern']).map(v => v['pattern'])
.join('|') + ')');
}
cb(err ? _this.status.READ_ERROR : _this.status.READ_OK, err);
});
});
};
_this.handle = (req, res, next) => {
req.isRobot = !!((req.headers['user-agent'] || '').match(_this.regex));
next();
};
return _this;
};
+22 -3
View File
@@ -1,7 +1,9 @@
{
"node_port": 3000,
"host": "",
"data_dir": "data",
"view_engine": "ejs",
"rate_limit": 100,
"access_log": "access.log",
"error_log": "error.log",
"modules": {
@@ -9,17 +11,23 @@
"webhook": true,
"prism": true,
"mathjax": true,
"plantuml": true
"plantuml": true,
"fa-diagrams": true,
"hit_counter": true
},
"home": {
"title": "GitBlog.md",
"description": "A static blog using Markdown pulled from your git repository",
"index": "index.ejs",
"error": "error.ejs",
"hidden": [
".ejs"
"*.ejs",
"/.git*"
]
},
"article": {
"index": "index.md",
"draft": "draft.md",
"template": "template.ejs",
"thumbnail_tag": "thumbnail",
"default_title": "Untitled",
@@ -35,7 +43,7 @@
"endpoint": "/webhook",
"secret": "",
"signature_header": "",
"pull_command": "git pull"
"pull_command": "git pull origin master"
},
"showdown": {
"parseImgDimensions": true,
@@ -51,5 +59,16 @@
},
"plantuml": {
"output_format": "svg"
},
"hit_counter": {
"unique_visitor_timeout": 7200000
},
"robots": {
"list_url": "https://raw.githubusercontent.com/atmire/COUNTER-Robots/master/COUNTER_Robots_list.json",
"list_file": "robots_list.json"
},
"redis": {
"host": "localhost",
"port": 6379
}
}
+1 -1
View File
@@ -25,7 +25,7 @@ const merge = (ref, src) => {
module.exports = () => {
try {
let configData = fs.readFileSync('config.json', {encoding: 'UTF-8'});
let configData = fs.readFileSync('config.json', { encoding: 'UTF-8' });
let config = JSON.parse(configData);
return merge(refConfig, config);
} catch (error) {
+43 -26
View File
@@ -1,7 +1,7 @@
const fs = require('fs');
const path = require('path');
const joinUrl = (...paths) => path.join(...paths).replace(/\\/g,'/');
const joinUrl = (...paths) => path.join(...paths).replace(/\\/g, '/');
/**
* Get all files path inside a given folder path
@@ -11,26 +11,32 @@ const joinUrl = (...paths) => path.join(...paths).replace(/\\/g,'/');
const getFileTree = (dir, cb) => {
let list = [];
let remaining = 0;
fs.readdir(dir, {withFileTypes: true}, (err, items) => {
if (err)
return cb(err);
fs.readdir(dir, { withFileTypes: true }, (err, items) => {
if (err) {
cb(err);
} else {
items.forEach((item) => {
if (item.isDirectory()) {
remaining++;
getFileTree(path.join(dir, item.name), (err, out) => {
if (err)
return cb(err);
if (err) {
cb(err);
} else {
list.push(...out);
remaining--;
if (remaining === 0)
if (remaining === 0) {
cb(null, list);
}
}
});
} else {
list.push(path.join(dir, item.name));
}
});
if (remaining === 0)
if (remaining === 0) {
cb(null, list);
}
}
});
};
@@ -41,10 +47,10 @@ const getFileTree = (dir, cb) => {
* @param cb
*/
const readIndexFile = (path, thumbnailTag, cb) => {
fs.readFile(path, {encoding: 'UTF-8'}, (err, data) => {
if (err)
return cb(err);
fs.readFile(path, { encoding: 'UTF-8' }, (err, data) => {
if (err) {
cb(err);
} else {
let info = {};
const regRes1 = data.match(/(^|[^#])#([^#\r\n]*)\r?\n?$/m);
@@ -55,6 +61,7 @@ const readIndexFile = (path, thumbnailTag, cb) => {
info.thumbnail = regRes2 ? regRes2[1].trim() : undefined;
cb(null, info);
}
});
};
@@ -68,42 +75,52 @@ module.exports = (config) => {
*/
fetchArticles: (cb) => {
getFileTree(config['data_dir'], (err, fileList) => {
if (err)
return cb(err);
if (err) {
cb(err);
} else {
const paths = fileList
.map((p) => p.substr(config['data_dir'].length+1).split(path.sep))
.filter((p) => p.length === 4 && p[3] === config['article']['index'] &&
.map((p) => p.substr(config['data_dir'].length + 1).split(path.sep))
.filter((p) => p.length === 4 && (p[3] === config['article']['index'] || p[3] === config['article']['draft']) &&
/^\d{4}$/.test(p[0]) && /^\d{2}$/.test(p[1]) && /^\d{2}$/.test(p[2]));
if (paths.length === 0)
if (paths.length === 0) {
cb(null, {});
}
const articles = {};
let remaining = 0;
paths.forEach((p) => {
const article = {
path: joinUrl(p[0], p[1], p[2]),
realPath: path.join(config['data_dir'], p[0], p[1], p[2]),
draft: p[3] === config['article']['draft'],
realPath: path.join(config['data_dir'], p[0], p[1], p[2], p[3]),
year: parseInt(p[0]),
month: parseInt(p[1]),
day: parseInt(p[2])
day: parseInt(p[2]),
};
article.date = new Date(article.year, article.month, article.day);
article.date.setUTCHours(0);
remaining++;
readIndexFile(path.join(article.realPath, config['article']['index']), config['article']['thumbnail_tag'], (err, info) => {
if (err)
return cb(err);
readIndexFile(article.realPath, config['article']['thumbnail_tag'], (err, info) => {
if (err) {
cb(err);
} else {
article.title = info.title || config['article']['default_title'];
article.thumbnail = info.thumbnail ? joinUrl(article.path, info.thumbnail) : config['article']['default_thumbnail'];
article.escapedTitle = article.title.toLowerCase().replace(/[^\w]/gm, ' ').trim().replace(/ /gm, '_');
article.escapedTitle = article.title.toLowerCase().replace(/[^\w]/gm, ' ')
.trim()
.replace(/ /gm, '_');
article.url = '/' + joinUrl(article.path, article.escapedTitle) + '/';
if (!articles[article.path] || !article.draft) {
articles[article.path] = article;
}
remaining--;
if (remaining === 0)
if (remaining === 0) {
cb(null, articles);
}
}
});
});
});
}
});
},
};
};
+66
View File
@@ -0,0 +1,66 @@
const redis = require('redis');
module.exports = (config, onConnect, onError) => {
const client = config['modules']['hit_counter'] ? redis.createClient(config['redis']) : { connected: false, on: () => { /* ignore */ } };
client.on('connect', onConnect);
client.on('error', onError);
const visitors = {};
const count = (req, path, disable, cb) => {
if (!client.connected || disable) {
cb();
} else {
const ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress;
visitors[path] = (visitors[path] || {});
const now = Date.now();
const isNewVisitor = (now - (visitors[path][ip] || 0)) > config['hit_counter']['unique_visitor_timeout'];
visitors[path][ip] = now;
client
.multi()
.hincrby(path, 'h', 1)
.hincrby(path, 'v', isNewVisitor ? 1 : 0)
.exec(cb);
}
};
const cleanVisitors = (path) => {
visitors[path] = (visitors[path] || {});
const now = Date.now();
let count = 0;
for (let ip in visitors[path]) {
if ((now - visitors[path][ip]) > config['hit_counter']['unique_visitor_timeout']) {
delete visitors[path][ip];
} else {
count++;
}
}
return count;
};
const read = (path, cb) => {
if (!client.connected) {
cb({
path: path,
hits: 0,
total_visitors: 0,
current_visitors: cleanVisitors(path),
});
} else {
client.hgetall(path, (_, value) => {
cb({
path: path,
hits: value ? parseInt(value.h) || 0 : 0,
total_visitors: value ? parseInt(value.v) || 0 : 0,
current_visitors: cleanVisitors(path),
});
});
}
};
return {
count: count,
read: read,
};
};
+6 -4
View File
@@ -4,10 +4,11 @@ const ncp = require('ncp').ncp;
const copy = (src, dest) => {
ncp(src, dest, function (err) {
if (err)
if (err) {
console.error(err);
else
} else {
console.log(`copied ${src} to ${dest}`);
}
});
};
@@ -23,8 +24,9 @@ if (!fs.existsSync('data')) {
const datetime = new Date();
const dir = path.join('data', datetime.getFullYear().toString(), pad0(datetime.getMonth() + 1), pad0(datetime.getDate()));
if (!fs.existsSync(dir))
fs.mkdirSync(dir, {recursive: true});
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
}
copy(path.join('sample_data', 'article'), dir);
}
+155 -27
View File
@@ -5,18 +5,70 @@ const showdown = require('showdown');
module.exports = (config) => {
const converter = new showdown.Converter(config['showdown']);
/**
* get parts outside of codes/scripts
* @param {string} data
* @returns {{index:number, end:number, text:string}[]} parts
*/
const getParts = (data) => {
let parts = [];
let match;
let i = 0;
while ((match = /```/m.exec(data.slice(i)))) {
parts.push({
index: i,
text: data.slice(i, i + match.index),
});
i += match.index + match[0].length;
}
if (i < data.length) {
parts.push({
index: i,
text: data.slice(i, data.length),
});
}
parts = parts.filter((p, i) => i % 2 === 0); //filter out code parts
// detect scripts outside of code
parts.forEach((p, pi) => {
let i = 0;
const subParts = [];
while ((match = /(<script>((?:(?!<\/script>)[\s\S])*)<\/script>)/gm.exec(p.text.slice(i)))) {
subParts.push({
index: p.index + i,
text: p.text.slice(i, i + match.index),
});
i += match.index + match[0].length;
}
if (i < p.text.length) {
subParts.push({
index: p.index + i,
text: p.text.slice(i, p.text.length),
});
}
parts.splice(pi, 1, ...subParts);
});
parts.forEach(part => part.end = part.index + part.text.length);
return parts;
};
const renderShowDown = (data, cb) => {
const html = converter.makeHtml(data);
cb(html);
};
let Prism;
if (config['modules']['prism'])
if (config['modules']['prism']) {
Prism = require('node-prismjs');
}
const renderPrism = (data, cb) => {
if (!config['modules']['prism'])
return cb(data);
if (!config['modules']['prism']) {
cb(data);
} else {
const codeRegex = /```([\w-]+)\r?\n((?:(?!```)[\s\S])*)\r?\n```/m;
let match;
while ((match = codeRegex.exec(data))) {
@@ -26,6 +78,7 @@ module.exports = (config) => {
data = data.slice(0, match.index) + `<pre><code class="${lang} language-${lang}">` + block + '</code></pre>' + data.slice(match.index + match[0].length);
}
cb(data);
}
};
if (config['modules']['plantuml']) {
@@ -33,18 +86,25 @@ module.exports = (config) => {
}
const renderPlantUML = (data, cb) => {
if (!config['modules']['plantuml'])
return cb(data);
/* global encode64 */
if (!config['modules']['plantuml']) {
cb(data);
} else {
const parts = getParts(data);
const umlRegex = /@startuml\r?\n((?:(?!@enduml)[\s\S])*)\r?\n@enduml/m;
let match;
while ((match = umlRegex.exec(data))) {
parts.forEach(part => {
while ((match = umlRegex.exec(part.text))) {
const code = match[1].trim();
const s = unescape(encodeURIComponent(code)); // jshint ignore:line
const s = unescape(encodeURIComponent(code));
const compressed = global['zip_deflate'](s);
const url = `http://www.plantuml.com/plantuml/${config['plantuml']['output_format']}/${encode64(compressed)}`;// jshint ignore:line
data = data.slice(0, match.index) + `<img alt="generated PlantUML diagram" src="${url}">` + data.slice(match.index + match[0].length);
const url = `http://www.plantuml.com/plantuml/${config['plantuml']['output_format']}/${encode64(compressed)}`;
part.text = part.text.slice(0, match.index) + `<img alt="generated PlantUML diagram" src="${url}">` + part.text.slice(match.index + match[0].length);
}
data = data.slice(0, part.index) + part.text + data.slice(part.end);
});
cb(data);
}
};
let mjAPI;
@@ -53,28 +113,40 @@ module.exports = (config) => {
mjAPI.config({
MathJax: {
tex2jax: {
inlineMath: [['$', '$']],
displayMath: [['$$', '$$']]
}
}
inlineMath: [
[
'$',
'$',
],
],
displayMath: [
[
'$$',
'$$',
],
],
},
},
});
}
const renderMathJax = (data, cb) => {
if (!config['modules']['mathjax'])
return cb(data);
if (!config['modules']['mathjax']) {
cb(data);
} else {
const parts = getParts(data);
const doMJ = (match, format) => {
const doMJ = (match, format, i) => {
const eq = match[1].trim();
const output = config['mathjax']['output_format'];
const mjConf = {
math: eq,
format: format,
speakText: config['mathjax']['speak_text']
speakText: config['mathjax']['speak_text'],
};
mjConf[output] = true;
mjAPI.typeset(mjConf, (res) => {
data = data.slice(0, match.index) + res[output] + data.slice(match.index + match[0].length);
data = data.slice(0, parts[i].index + match.index) + res[output] + data.slice(parts[i].index + match.index + match[0].length);
renderMathJax(data, (data2) => {
cb(data2);
});
@@ -84,29 +156,83 @@ module.exports = (config) => {
const eqRegex = /\$\$((?:(?!\$\$)[\s\S])*)\$\$/m;
const inlineEqRegex = /\$([^$\n]*)\$/;
let found = false;
for (let i = 0; i < parts.length; i++) {
let match;
if ((match = eqRegex.exec(data))) {
doMJ(match, 'TeX');
} else if ((match = inlineEqRegex.exec(data))) {
doMJ(match, 'inline-TeX');
if ((match = eqRegex.exec(parts[i].text))) {
doMJ(match, 'TeX', i);
found = true;
break;
} else if ((match = inlineEqRegex.exec(parts[i].text))) {
doMJ(match, 'inline-TeX', i);
found = true;
break;
}
}
if (!found) {
cb(data);
}
}
};
let faDiagrams;
let toml;
if (config['modules']['fa-diagrams']) {
faDiagrams = require('fa-diagrams');
toml = require('@iarna/toml');
}
const renderFaDiagrams = (data, cb) => {
if (!config['modules']['fa-diagrams']) {
cb(data);
} else {
const parts = getParts(data);
const diagramsRegex = /@startfad\r?\n((?:(?!@endfad)[\s\S])*)\r?\n@endfad/m;
let match;
parts.forEach(part => {
while ((match = diagramsRegex.exec(part.text))) {
const code = match[1].trim();
let output;
try {
const diagData = toml.parse(code);
const findLineBreaks = (data) => {
Object.keys(data).forEach(key => {
if (typeof data[key] === 'object') {
findLineBreaks(data[key]);
} else if (typeof data[key] === 'string') {
data[key] = data[key].replace(/\\n/gm, '\n');
}
});
};
findLineBreaks(diagData);
output = faDiagrams.compute(diagData);
} catch (err) {
output = `<b style="color:red">${err.toString()}</b>`;
}
part.text = part.text.slice(0, match.index) + output + part.text.slice(match.index + match[0].length);
}
data = data.slice(0, part.index) + part.text + data.slice(part.end);
});
cb(data);
}
};
return {
getParts: config['test'] ? getParts : undefined,
renderShowDown: config['test'] ? renderShowDown : undefined,
renderPrism: config['test'] ? renderPrism : undefined,
renderPlantUML: config['test'] ? renderPlantUML : undefined,
renderMathJax: config['test'] ? renderMathJax : undefined,
renderFaDiagrams: config['test'] ? renderFaDiagrams : undefined,
render: (file, cb) => {
fs.readFile(file, {encoding: 'UTF-8'}, (err, data) => {
if (err)
return cb(err);
renderPrism(data, (data) => {
fs.readFile(file, { encoding: 'UTF-8' }, (err, data) => {
if (err) {
cb(err);
} else {
renderPlantUML(data, (data) => {
renderFaDiagrams(data, (data) => {
renderMathJax(data, (data) => {
renderPrism(data, (data) => {
renderShowDown(data, (html) => {
cb(null, html);
});
@@ -115,6 +241,8 @@ module.exports = (config) => {
});
});
}
});
},
};
};
+1 -1
View File
@@ -5,6 +5,6 @@ const fs = require('fs');
* @param scriptPath
*/
module.exports = (scriptPath) => {
eval.call(global, fs.readFileSync(scriptPath, {encoding: 'UTF-8'}));
eval.call(global, fs.readFileSync(scriptPath, { encoding: 'UTF-8' }));
};
+287 -84
View File
@@ -1,4 +1,3 @@
/* jshint -W117 */
const request = require('supertest');
const fs = require('fs');
const path = require('path');
@@ -16,20 +15,21 @@ config['data_dir'] = dataDir;
config['webhook']['endpoint'] = '/webhooktest';
config['rss']['endpoint'] = '/rsstest';
config['rss']['length'] = 2;
config['home']['index'] = testIndex;
config['home']['error'] = testError;
config['article']['template'] = testTemplate;
config['modules']['hit_counter'] = false;
const app = require('../src/app')(config);
beforeEach((done, fail) => {
config['home']['index'] = testIndex;
config['data_dir'] = dataDir;
config['article']['index'] = 'index.md';
config['home']['hidden'] = ['.ejs', '.test'];
config['access_log'] = '';
config['error_log'] = '';
config['modules']['rss'] = true;
config['modules']['webhook'] = true;
config['modules']['hit_counter'] = false;
utils.deleteFolderSync(dataDir);
fs.mkdirSync(dataDir);
@@ -50,37 +50,42 @@ describe('Test reload', () => {
});
describe('Test request logging', () => {
test('test no log', (done) => {
request(app).get('/rsstest').then(() => {
test('no log', (done) => {
request(app).get('/rsstest')
.then(() => {
expect(fs.existsSync(path.join(dataDir, 'access.log'))).toBe(false);
done();
});
});
test('test get 200', (done) => {
test('get 200', (done) => {
config['access_log'] = path.join(dataDir, 'access.log');
request(app).get('/rsstest').then(() => {
fs.readFile(path.join(dataDir, 'access.log'), {encoding: 'UTF-8'}, (err, data) => {
request(app).get('/rsstest')
.then(() => {
fs.readFile(path.join(dataDir, 'access.log'), { encoding: 'UTF-8' }, (err, data) => {
expect(err).toBeNull();
expect(data).toBe('200 GET /rsstest ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n');
done();
});
});
});
test('test post 400', (done) => {
test('post 400', (done) => {
config['access_log'] = path.join(dataDir, 'access.log');
request(app).post('/rsstest').then(() => {
fs.readFile(path.join(dataDir, 'access.log'), {encoding: 'UTF-8'}, (err, data) => {
request(app).post('/rsstest')
.then(() => {
fs.readFile(path.join(dataDir, 'access.log'), { encoding: 'UTF-8' }, (err, data) => {
expect(err).toBeNull();
expect(data).toBe('400 POST /rsstest ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n');
done();
});
});
});
test('test 2 requests', (done) => {
test('2 requests', (done) => {
config['access_log'] = path.join(dataDir, 'access.log');
request(app).get('/rss').then(() => {
request(app).post('/rsstest').then(() => {
fs.readFile(path.join(dataDir, 'access.log'), {encoding: 'UTF-8'}, (err, data) => {
request(app).get('/rss')
.then(() => {
request(app).post('/rsstest')
.then(() => {
fs.readFile(path.join(dataDir, 'access.log'), { encoding: 'UTF-8' }, (err, data) => {
expect(err).toBeNull();
expect(data).toBe('404 GET /rss ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n' +
'400 POST /rsstest ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n');
@@ -92,22 +97,25 @@ describe('Test request logging', () => {
});
describe('Test error logging', () => {
test('test no log', (done) => {
config['home']['hidden'] = null;
request(app).get('/somefile.txt').then(() => {
test('no log', (done) => {
config['home']['index'] = null;
request(app).get('/')
.then(() => {
expect(fs.existsSync(path.join(dataDir, 'error.log'))).toBe(false);
done();
});
});
test('test null error ', (done) => {
config['home']['hidden'] = null;
test('null error', (done) => {
config['home']['index'] = null;
config['error_log'] = path.join(dataDir, 'error.log');
request(app).get('/somefile.txt').then(() => {
fs.readFile(path.join(dataDir, 'error.log'), {encoding: 'UTF-8'}, (err, data) => {
request(app).get('/')
.then(() => {
fs.readFile(path.join(dataDir, 'error.log'), { encoding: 'UTF-8' }, (err, data) => {
expect(err).toBeNull();
const start = data.split('\n').slice(0, 2).join('\n');
const expected = '500 GET /somefile.txt ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\nTypeError: Cannot read property \'includes\' of null';
expect(start).toBe(expected);
const start = data.split('\n').slice(0, 2)
.join('\n');
const expected = '500 GET / ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\nTypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string.';
expect(start.indexOf(expected)).toBe(0);
done();
});
});
@@ -116,46 +124,73 @@ describe('Test error logging', () => {
describe('Test root path', () => {
test('404 no index no error', (done) => {
request(app).get('/').then((response) => {
request(app).get('/')
.then((response) => {
expect(response.statusCode).toBe(404);
done();
});
});
test('404 no index but error page', (done) => {
fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %> at <%= path %>');
request(app).get('/').then((response) => {
fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
request(app).get('/')
.then((response) => {
expect(response.statusCode).toBe(404);
expect(response.text).toBe('error 404 at /');
expect(response.text).toBe('error 404');
done();
});
});
test('500 render error', (done) => {
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>');
request(app).get('/').then((response) => {
request(app).get('/')
.then((response) => {
expect(response.statusCode).toBe(500);
done();
});
});
test('500 render error with page', (done) => {
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>');
fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
request(app).get('/')
.then((response) => {
expect(response.statusCode).toBe(500);
expect(response.text).toBe('error 500');
done();
});
});
test('500 render error with failing page', (done) => {
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>');
fs.writeFileSync(path.join(dataDir, testError), 'error <%= null.error %>');
request(app).get('/')
.then((response) => {
expect(response.statusCode).toBe(500);
done();
});
});
test('200 no articles', (done) => {
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= articles.length %>');
request(app).get('/').then((response) => {
request(app).get('/')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text).toBe('articles 0');
done();
});
});
test('200 2 articles', (done, fail) => {
test('200 2 articles 1 drafted', (done, fail) => {
utils.createEmptyDirs([
path.join(dataDir, '2019', '05', '05'),
path.join(dataDir, '2018', '05', '05')
path.join(dataDir, '2018', '05', '05'),
path.join(dataDir, '2017', '05', '05'),
]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, '2018', '05', '05', 'index.md')
path.join(dataDir, '2019', '05', '05', 'draft.md'),
path.join(dataDir, '2018', '05', '05', 'index.md'),
path.join(dataDir, '2018', '05', '05', 'draft.md'),
path.join(dataDir, '2017', '05', '05', 'index.md'),
]);
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= articles.length %>');
app.reload(() => {
request(app).get('/').then((response) => {
request(app).get('/')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text).toBe('articles 2');
done();
@@ -167,22 +202,36 @@ describe('Test root path', () => {
describe('Test RSS feed', () => {
test('404 rss deactivated', (done) => {
config['modules']['rss'] = false;
request(app).get('/rsstest').then((response) => {
request(app).get('/rsstest')
.then((response) => {
expect(response.statusCode).toBe(404);
done();
});
});
test('200 empty rss', (done) => {
request(app).get('/rsstest').then((response) => {
request(app).get('/rsstest')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.type).toBe('application/rss+xml');
expect(response.text.length).toBeGreaterThan(0);
expect(response.text.split('<item>').length).toBe(1);
done();
});
});
test('200 Mozilla fix', (done) => {
request(app).get('/rsstest')
.set('user-agent', 'Mozilla Firefox 64.0')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.type).toBe('text/xml');
done();
});
});
test('200 rss cache', (done) => {
request(app).get('/rsstest').then(() => {
request(app).get('/rsstest').then((response) => {
request(app).get('/rsstest')
.then(() => {
request(app).get('/rsstest')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text.length).toBeGreaterThan(0);
expect(response.text.split('<item>').length).toBe(1);
@@ -193,14 +242,15 @@ describe('Test RSS feed', () => {
test('200 2 rss items', (done, fail) => {
utils.createEmptyDirs([
path.join(dataDir, '2019', '05', '05'),
path.join(dataDir, '2018', '05', '05')
path.join(dataDir, '2018', '05', '05'),
]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, '2018', '05', '05', 'index.md')
path.join(dataDir, '2018', '05', '05', 'index.md'),
]);
app.reload(() => {
request(app).get('/rsstest').then((response) => {
request(app).get('/rsstest')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text.length).toBeGreaterThan(0);
expect(response.text.split('<item>').length).toBe(3);
@@ -212,15 +262,16 @@ describe('Test RSS feed', () => {
utils.createEmptyDirs([
path.join(dataDir, '2019', '05', '05'),
path.join(dataDir, '2018', '05', '05'),
path.join(dataDir, '2017', '05', '05')
path.join(dataDir, '2017', '05', '05'),
]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, '2018', '05', '05', 'index.md'),
path.join(dataDir, '2017', '05', '05', 'index.md')
path.join(dataDir, '2017', '05', '05', 'index.md'),
]);
app.reload(() => {
request(app).get('/rsstest').then((response) => {
request(app).get('/rsstest')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text.length).toBeGreaterThan(0);
expect(response.text.split('<item>').length).toBe(3);
@@ -233,34 +284,38 @@ describe('Test RSS feed', () => {
describe('Test webhook', () => {
test('400 webhook deactivated', (done) => {
config['modules']['webhook'] = false;
request(app).post('/webhooktest').then((response) => {
request(app).post('/webhooktest')
.then((response) => {
expect(response.statusCode).toBe(400);
done();
});
});
test('200 no secret', (done) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, testTemplate)
path.join(dataDir, testTemplate),
]);
config['webhook']['pull_command'] = 'git --help';
request(app).post('/webhooktest').then((response) => {
request(app).post('/webhooktest')
.then((response) => {
expect(response.statusCode).toBe(200);
request(app).get('/2019/05/05/').then((response) => {
request(app).get('/2019/05/05/')
.then((response) => {
expect(response.statusCode).toBe(200);
done();
});
});
});
test('500 command failed', (done) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, testTemplate)
path.join(dataDir, testTemplate),
]);
config['webhook']['pull_command'] = 'qzgfqgqz';
request(app).post('/webhooktest').then((response) => {
request(app).post('/webhooktest')
.then((response) => {
expect(response.statusCode).toBe(500);
done();
});
@@ -268,7 +323,9 @@ describe('Test webhook', () => {
test('403 wrong secret', (done) => {
config['webhook']['signature_header'] = 'testheader';
config['webhook']['secret'] = 'testvalue';
request(app).post('/webhooktest').set('testheader', 'sha1=invalid').then((response) => {
request(app).post('/webhooktest')
.set('testheader', 'sha1=invalid')
.then((response) => {
expect(response.statusCode).toBe(403);
done();
});
@@ -289,19 +346,20 @@ describe('Test webhook', () => {
describe('Test articles rendering', () => {
test('404 article not found', (done) => {
request(app).get('/2019/05/06/untitled/').then((response) => {
request(app).get('/2019/05/06/untitled/')
.then((response) => {
expect(response.statusCode).toBe(404);
done();
});
});
test('500 no index', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
test('500 fail to render', (done, fail) => {
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello');
fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>');
fs.writeFileSync(path.join(dataDir, testTemplate), '<%- articl.content %><%- `<a href="${article.url}">reload</a>` %>');
app.reload(() => {
config['article']['index'] = 'invalid.md';
request(app).get('/2019/05/05/hello/').then((response) => {
request(app).get('/2019/05/05/hello/')
.then((response) => {
expect(response.statusCode).toBe(500);
done();
});
@@ -309,10 +367,11 @@ describe('Test articles rendering', () => {
});
test('500 no template', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello');
app.reload(() => {
request(app).get('/2019/05/05/hello/').then((response) => {
request(app).get('/2019/05/05/hello/')
.then((response) => {
expect(response.statusCode).toBe(500);
done();
});
@@ -320,11 +379,26 @@ describe('Test articles rendering', () => {
});
test('200 rendered article', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello');
fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>');
app.reload(() => {
request(app).get('/2019/05/05/hello/').then((response) => {
request(app).get('/2019/05/05/hello/')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text).toBe('<h1 id="hello">Hello</h1><a href="/2019/05/05/hello/">reload</a>');
done();
});
}, fail);
});
test('200 rendered draft', (done, fail) => {
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'draft.md'), '# Hello');
fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>');
app.reload(() => {
request(app).get('/2019/05/05/hello/')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text).toBe('<h1 id="hello">Hello</h1><a href="/2019/05/05/hello/">reload</a>');
done();
@@ -333,13 +407,14 @@ describe('Test articles rendering', () => {
});
test('200 other url', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, testTemplate)
path.join(dataDir, testTemplate),
]);
app.reload(() => {
request(app).get('/2019/05/05/anything/').then((response) => {
request(app).get('/2019/05/05/anything/')
.then((response) => {
expect(response.statusCode).toBe(200);
done();
});
@@ -347,13 +422,14 @@ describe('Test articles rendering', () => {
});
test('200 other url 2', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, testTemplate)
path.join(dataDir, testTemplate),
]);
app.reload(() => {
request(app).get('/2019/05/05/').then((response) => {
request(app).get('/2019/05/05/')
.then((response) => {
expect(response.statusCode).toBe(200);
done();
});
@@ -361,32 +437,45 @@ describe('Test articles rendering', () => {
});
});
describe('Test static files', () => {
test('404 invalid file no error page', (done) => {
request(app).get('/somefile.txt').then((response) => {
request(app).get('/somefile.txt')
.then((response) => {
expect(response.statusCode).toBe(404);
done();
});
});
test('404 invalid file but error page', (done) => {
fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %> at <%= path %>');
request(app).get('/somefile.txt').then((response) => {
fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
request(app).get('/somefile.txt')
.then((response) => {
expect(response.statusCode).toBe(404);
expect(response.text).toBe('error 404 at /somefile.txt');
expect(response.text).toBe('error 404');
done();
});
});
test('404 hidden file', (done) => {
fs.writeFileSync(path.join(dataDir, 'somefile.test'), '');
request(app).get('/somefile.test').then((response) => {
utils.createEmptyDirs([ path.join(dataDir, 'tmp') ]);
fs.writeFileSync(path.join(dataDir, 'tmp', 'somefile.ejs'), '');
request(app).get('/tmp/somefile.ejs')
.then((response) => {
expect(response.statusCode).toBe(404);
done();
});
});
test('404 hidden folder', (done) => {
utils.createEmptyDirs([ path.join(dataDir, '.git') ]);
fs.writeFileSync(path.join(dataDir, '.git', 'file.txt'), '');
request(app).get('/.git/file.txt')
.then((response) => {
expect(response.statusCode).toBe(404);
done();
});
});
test('200 valid file', (done) => {
fs.writeFileSync(path.join(dataDir, 'somefile.css'), 'filecontent');
request(app).get('/somefile.css').then((response) => {
request(app).get('/somefile.css')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.type).toBe('text/css');
expect(response.text).toBe('filecontent');
@@ -394,9 +483,10 @@ describe('Test static files', () => {
});
});
test('200 valid resource of article', (done) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'somefile.txt'), 'filecontent');
request(app).get('/2019/05/05/title/somefile.txt').then((response) => {
request(app).get('/2019/05/05/title/somefile.txt')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text).toBe('filecontent');
done();
@@ -406,21 +496,134 @@ describe('Test static files', () => {
describe('Test other requests', () => {
test('400 POST', (done) => {
request(app).post('/').then((response) => {
request(app).post('/')
.then((response) => {
expect(response.statusCode).toBe(400);
done();
});
});
test('400 PUT', (done) => {
request(app).put('/').then((response) => {
request(app).put('/')
.then((response) => {
expect(response.statusCode).toBe(400);
done();
});
});
test('400 DELETE', (done) => {
request(app).delete('/').then((response) => {
request(app).delete('/')
.then((response) => {
expect(response.statusCode).toBe(400);
done();
});
});
});
describe('Test stats', () => {
test('404 index no stats', (done) => {
request(app).get('/stats')
.then((response) => {
expect(response.statusCode).toBe(404);
done();
});
});
test('200 index stats', (done) => {
config['modules']['hit_counter'] = true;
request(app).get('/stats')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.body).toEqual({
path: '/',
hits: 0,
total_visitors: 0,
current_visitors: 0,
});
done();
});
});
test('200 index stats all no article', (done) => {
config['modules']['hit_counter'] = true;
app.reload(() => {
request(app).get('/stats?all=true')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.body).toEqual([
{
path: '/',
hits: 0,
total_visitors: 0,
current_visitors: 0,
},
]);
done();
});
});
});
test('200 index stats all 2 article 1 drafted', (done) => {
config['modules']['hit_counter'] = true;
utils.createEmptyDirs([
path.join(dataDir, '2019', '05', '05'),
path.join(dataDir, '2019', '04', '05'),
]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, '2019', '04', '05', 'draft.md'),
]);
app.reload(() => {
request(app).get('/stats?all=true')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.body).toEqual([
{
path: '/',
hits: 0,
total_visitors: 0,
current_visitors: 0,
},
{
path: '2019/05/05',
hits: 0,
total_visitors: 0,
current_visitors: 0,
},
]);
done();
});
});
});
test('404 article no stats', (done) => {
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, testTemplate),
]);
app.reload(() => {
request(app).get('/2019/05/05/hello/stats')
.then((response) => {
expect(response.statusCode).toBe(404);
done();
});
});
});
test('200 article stats', (done) => {
config['modules']['hit_counter'] = true;
utils.createEmptyDirs([ path.join(dataDir, '2019', '05', '05') ]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, testTemplate),
]);
app.reload(() => {
request(app).get('/2019/05/05/anything/stats')
.then((response) => {
expect(response.statusCode).toBe(200);
expect(response.body).toEqual({
path: '2019/05/05',
hits: 0,
total_visitors: 0,
current_visitors: 0,
});
done();
});
});
});
});
+116
View File
@@ -0,0 +1,116 @@
const fs = require('fs');
const utils = require('./test_utils');
const dataDir = 'test_data';
const config = {
robots: {
list_url: '',
list_file: `${dataDir}/robots_list.json`,
},
};
beforeAll(() => {
utils.deleteFolderSync(dataDir);
fs.mkdirSync(dataDir);
});
afterAll(() => {
if (fs.existsSync(dataDir)) {
utils.deleteFolderSync(dataDir);
}
});
const botDetector = require('../src/bot_detector')(config);
describe('load()', () => {
test('success', (done) => {
config.robots = {
list_url: 'https://raw.githubusercontent.com/atmire/COUNTER-Robots/master/COUNTER_Robots_list.json',
list_file: `${dataDir}/robots_list_success.json`,
};
let count = 0;
botDetector.load((status, err) => {
expect(err).not.toBeDefined();
expect(status).toBe(count === 0 ? botDetector.status.FETCH_OK : botDetector.status.READ_OK);
if (count > 0) {
done();
}
count++;
});
});
test('fetch and file failure', (done) => {
let count = 0;
config.robots = {
list_url: 'https://blog.klemek.fr/invalid.json',
list_file: `${dataDir}/robots_list_fail_1.json`,
};
botDetector.load((status) => {
expect(status).toBe(count === 0 ? botDetector.status.FETCH_ERROR : botDetector.status.READ_ERROR);
if (count > 0) {
done();
}
count++;
});
});
test('fetch failure and file ok', (done) => {
let count = 0;
config.robots = {
list_url: 'https://blog.klemek.fr/invalid.json',
list_file: `${dataDir}/robots_list_fail_2.json`,
};
fs.writeFile(config.robots.list_file, '[]\n', { encoding: 'utf-8' }, () => {
botDetector.load((status) => {
expect(status).toBe(count === 0 ? botDetector.status.FETCH_ERROR : botDetector.status.READ_OK);
if (count > 0) {
done();
}
count++;
});
});
});
});
describe('handle()', () => {
beforeAll((done) => {
config.robots = {
list_url: 'https://blog.klemek.fr/invalid.json',
list_file: `${dataDir}/robots_list_fake.json`,
};
fs.writeFile(config.robots.list_file, '[{"pattern":"bot"}]\n', { encoding: 'utf-8' }, () => {
botDetector.load((status) => {
if (status !== botDetector.status.FETCH_ERROR) {
done();
}
});
});
});
test('not bot', (done) => {
const req = {
headers: {
'user-agent': 'my user agent',
},
};
botDetector.handle(req, null, () => {
expect(req.isRobot).toBeFalsy();
done();
});
});
test('bot', (done) => {
const req = {
headers: {
'user-agent': 'bot',
},
};
botDetector.handle(req, null, () => {
expect(req.isRobot).toBeTruthy();
done();
});
});
});
+14 -8
View File
@@ -1,4 +1,3 @@
/* jshint -W117 */
const fs = require('fs');
const path = require('path');
@@ -9,7 +8,6 @@ beforeAll(() => {
if (fs.existsSync(configFile)) {
fs.renameSync(configFile, tmpConfigFile);
}
expect(fs.existsSync(configFile)).toBeFalsy();
});
afterAll(() => {
@@ -21,8 +19,9 @@ afterAll(() => {
});
test('no config', () => {
if (fs.existsSync(configFile))
if (fs.existsSync(configFile)) {
fs.unlinkSync(configFile);
}
expect(fs.existsSync(configFile)).toBeFalsy();
const config = require('../src/config')();
expect(config).toBeDefined();
@@ -31,11 +30,12 @@ test('no config', () => {
});
test('example config', () => {
if (fs.existsSync(configFile))
if (fs.existsSync(configFile)) {
fs.unlinkSync(configFile);
}
fs.copyFileSync(path.join('src', 'config.default.json'), configFile);
const data = fs.readFileSync(configFile, {encoding: 'UTF-8'});
fs.writeFileSync(configFile, data.replace('3000', '3333'), {encoding: 'UTF-8'});
const data = fs.readFileSync(configFile, { encoding: 'UTF-8' });
fs.writeFileSync(configFile, data.replace('3000', '3333'), { encoding: 'UTF-8' });
const config = require('../src/config')();
expect(config).toBeDefined();
expect(config['node_port']).toBe(3333);
@@ -70,12 +70,18 @@ test('array parsing', () => {
fs.writeFileSync(configFile, '{"home":{"hidden":["item1","item2"]}}');
const config = require('../src/config')();
expect(config).toBeDefined();
expect(config['home']['hidden']).toEqual(['item1', 'item2']);
expect(config['home']['hidden']).toEqual([
'item1',
'item2',
]);
});
test('array fix', () => {
fs.writeFileSync(configFile, '{"home":{"hidden":{}}}');
const config = require('../src/config')();
expect(config).toBeDefined();
expect(config['home']['hidden']).toEqual(['.ejs']);
expect(config['home']['hidden']).toEqual([
'*.ejs',
'/.git*',
]);
});
+90 -26
View File
@@ -1,4 +1,3 @@
/* jshint -W117 */
const fs = require('fs');
const path = require('path');
const utils = require('./test_utils');
@@ -6,17 +5,18 @@ const utils = require('./test_utils');
const dataDir = 'test_data';
const testIndex = 'testindex.md';
const joinUrl = (...paths) => path.join(...paths).replace(/\\/g,'/');
const joinUrl = (...paths) => path.join(...paths).replace(/\\/g, '/');
const config = {
'test': true,
'data_dir': dataDir,
'article': {
'index': testIndex,
'default_title': 'Untitled',
'default_thumbnail': 'default.png',
'thumbnail_tag': 'thumbnail'
}
test: true,
data_dir: dataDir,
article: {
index: testIndex,
draft: 'draft.md',
default_title: 'Untitled',
default_thumbnail: 'default.png',
thumbnail_tag: 'thumbnail',
},
};
const fw = require('../src/file_walker')(config);
@@ -46,7 +46,7 @@ describe('Test function fileTree', () => {
utils.createEmptyDirs([
path.join(dataDir, 'test', 'test'),
path.join(dataDir, 'test', 'test2'),
path.join(dataDir, 'test2')
path.join(dataDir, 'test2'),
]);
fw.fileTree(dataDir, (err, list) => {
expect(err).toBeNull();
@@ -58,7 +58,7 @@ describe('Test function fileTree', () => {
test('simple files', (done) => {
const fileList = [
path.join(dataDir, 'f1.txt'),
path.join(dataDir, 'f2.txt')
path.join(dataDir, 'f2.txt'),
];
utils.createEmptyFiles(fileList);
fw.fileTree(dataDir, (err, list) => {
@@ -72,13 +72,13 @@ describe('Test function fileTree', () => {
test('nested files', (done) => {
utils.createEmptyDirs([
path.join(dataDir, 'test', 'test'),
path.join(dataDir, 'test2')
path.join(dataDir, 'test2'),
]);
const fileList = [
path.join(dataDir, 'f1.txt'),
path.join(dataDir, 'test', 'f2.txt'),
path.join(dataDir, 'test', 'test', 'f3.txt'),
path.join(dataDir, 'test2', 'f4.txt')
path.join(dataDir, 'test2', 'f4.txt'),
];
utils.createEmptyFiles(fileList);
fw.fileTree(dataDir, (err, list) => {
@@ -120,7 +120,7 @@ describe('Test index article reading', () => {
expect(err).toBeNull();
expect(info).toEqual({
title: 'This is an awesome title !?¤',
thumbnail: './thumbnail.jpg'
thumbnail: './thumbnail.jpg',
});
done();
});
@@ -136,7 +136,7 @@ describe('Test index article reading', () => {
expect(err).toBeNull();
expect(info).toEqual({
title: undefined,
thumbnail: './thumbnail.jpg'
thumbnail: './thumbnail.jpg',
});
done();
});
@@ -148,7 +148,7 @@ describe('Test index article reading', () => {
expect(err).toBeNull();
expect(info).toEqual({
title: 'title',
thumbnail: undefined
thumbnail: undefined,
});
done();
});
@@ -164,7 +164,7 @@ describe('Test index article reading', () => {
expect(err).toBeNull();
expect(info).toEqual({
title: 'This is an awesome title !?¤',
thumbnail: undefined
thumbnail: undefined,
});
done();
});
@@ -181,7 +181,7 @@ describe('Test index article reading', () => {
expect(err).toBeNull();
expect(info).toEqual({
title: 'This is an awesome title !?¤',
thumbnail: './thumbnail.jpg'
thumbnail: './thumbnail.jpg',
});
done();
});
@@ -208,12 +208,12 @@ describe('Test article fetching', () => {
test('misplaced index file', (done) => {
utils.createEmptyDirs([
path.join(dataDir, 'test', 'test'),
path.join(dataDir, '2019', '05', '05')
path.join(dataDir, '2019', '05', '05'),
]);
utils.createEmptyFiles([
path.join(dataDir, testIndex),
path.join(dataDir, 'test', 'test', testIndex),
path.join(dataDir, '2019', '05', testIndex)
path.join(dataDir, '2019', '05', testIndex),
]);
fw.fetchArticles((err, dict) => {
expect(err).toBeNull();
@@ -225,8 +225,8 @@ describe('Test article fetching', () => {
test('empty index file', (done) => {
const dir = path.join(dataDir, '2019', '05', '05');
const file = path.join(dir, testIndex);
utils.createEmptyDirs([dir]);
utils.createEmptyFiles([file]);
utils.createEmptyDirs([ dir ]);
utils.createEmptyFiles([ file ]);
const date = new Date(2019, 5, 5);
date.setUTCHours(0);
fw.fetchArticles((err, dict) => {
@@ -235,9 +235,10 @@ describe('Test article fetching', () => {
expect(Object.keys(dict).length).toBe(1);
expect(dict[joinUrl('2019', '05', '05')]).toEqual({
path: joinUrl('2019', '05', '05'),
realPath: dir,
realPath: file,
year: 2019,
month: 5,
draft: false,
day: 5,
date: date,
title: 'Untitled',
@@ -251,7 +252,7 @@ describe('Test article fetching', () => {
test('correct index file', (done) => {
const dir = path.join(dataDir, '2019', '05', '05');
const file = path.join(dir, testIndex);
utils.createEmptyDirs([dir]);
utils.createEmptyDirs([ dir ]);
fs.writeFileSync(file, `
# Title with : info !
![thumbnail](./thumbnail.jpg)
@@ -265,10 +266,11 @@ describe('Test article fetching', () => {
expect(Object.keys(dict).length).toBe(1);
expect(dict[joinUrl('2019', '05', '05')]).toEqual({
path: joinUrl('2019', '05', '05'),
realPath: dir,
realPath: file,
year: 2019,
month: 5,
day: 5,
draft: false,
date: date,
title: 'Title with : info !',
thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'),
@@ -278,5 +280,67 @@ describe('Test article fetching', () => {
done();
});
});
test('correct draft file', (done) => {
const dir = path.join(dataDir, '2019', '05', '05');
const file = path.join(dir, 'draft.md');
utils.createEmptyDirs([ dir ]);
fs.writeFileSync(file, `
# Title with : info !
![thumbnail](./thumbnail.jpg)
this is some text
`);
const date = new Date(2019, 5, 5);
date.setUTCHours(0);
fw.fetchArticles((err, dict) => {
expect(err).toBeNull();
expect(dict).toBeDefined();
expect(Object.keys(dict).length).toBe(1);
expect(dict[joinUrl('2019', '05', '05')]).toEqual({
path: joinUrl('2019', '05', '05'),
realPath: file,
year: 2019,
month: 5,
day: 5,
draft: true,
date: date,
title: 'Title with : info !',
thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'),
escapedTitle: 'title_with___info',
url: '/' + joinUrl('2019', '05', '05', 'title_with___info') + '/',
});
done();
});
});
test('index file override draft', (done) => {
const dir = path.join(dataDir, '2019', '05', '05');
const file = path.join(dir, testIndex);
const file2 = path.join(dir, 'draft.md');
utils.createEmptyDirs([ dir ]);
utils.createEmptyFiles([
file,
file2,
]);
const date = new Date(2019, 5, 5);
date.setUTCHours(0);
fw.fetchArticles((err, dict) => {
expect(err).toBeNull();
expect(dict).toBeDefined();
expect(Object.keys(dict).length).toBe(1);
expect(dict[joinUrl('2019', '05', '05')]).toEqual({
path: joinUrl('2019', '05', '05'),
realPath: file,
year: 2019,
month: 5,
draft: false,
day: 5,
date: date,
title: 'Untitled',
thumbnail: 'default.png',
escapedTitle: 'untitled',
url: '/' + joinUrl('2019', '05', '05', 'untitled') + '/',
});
done();
});
});
});
+257
View File
@@ -0,0 +1,257 @@
const mockClient = {
options: {},
connected: true,
on: () => { /* ignore */ },
};
jest.mock('redis', () => {
return {
createClient: (options) => {
mockClient.options = options;
return mockClient;
},
};
});
const config = {
test: true,
modules: {
hit_counter: true,
},
redis: {
host: 'test-host',
port: 'test-port',
},
hit_counter: {
unique_visitor_timeout: -1,
},
};
const hc = require('../src/hit_counter')(config, () => { /* ignore */ }, () => { /* ignore */ });
afterAll(() => {
jest.resetModules();
});
test('options passed to redis', () => {
expect(mockClient.options).toEqual(config['redis']);
});
beforeEach(() => {
mockClient.hgetall = (_, cb) => {
cb();
};
mockClient.multi = () => mockClient;
mockClient.hincrby = () => mockClient;
mockClient.exec = (cb) => {
cb();
};
config['hit_counter']['unique_visitor_timeout'] = -1;
});
describe('read()', () => {
test('normal', (done) => {
mockClient.hgetall = (path, cb) => {
expect(path).toBe('/test/path/');
cb(undefined, { h: 12, v: 34 });
};
hc.read('/test/path/', (data) => {
expect(data).toBeDefined();
expect(data.hits).toBe(12);
expect(data.total_visitors).toBe(34);
expect(data.current_visitors).toBe(0);
done();
});
});
test('with error', (done) => {
mockClient.hgetall = (path, cb) => {
expect(path).toBe('/test/path/');
cb('error', undefined);
};
hc.read('/test/path/', (data) => {
expect(data).toBeDefined();
expect(data.hits).toBe(0);
expect(data.total_visitors).toBe(0);
expect(data.current_visitors).toBe(0);
done();
});
});
test('with error 2', (done) => {
mockClient.hgetall = (path, cb) => {
expect(path).toBe('/test/path/');
cb(undefined, {});
};
hc.read('/test/path/', (data) => {
expect(data).toBeDefined();
expect(data.hits).toBe(0);
expect(data.total_visitors).toBe(0);
expect(data.current_visitors).toBe(0);
done();
});
});
test('1 visitor', (done) => {
config['hit_counter']['unique_visitor_timeout'] = 1000;
hc.count({
headers: {},
connection: { remoteAddress: 'test1' },
}, '/test/path/5', false, () => {
hc.read('/test/path/5', (data) => {
expect(data).toBeDefined();
expect(data.current_visitors).toBe(1);
done();
});
});
});
test('cleaned old visitor', (done) => {
hc.count({
headers: {},
connection: { remoteAddress: 'test1' },
}, '/test/path/5', false, () => {
hc.read('/test/path/5', (data) => {
expect(data).toBeDefined();
expect(data.current_visitors).toBe(0);
done();
});
});
});
});
describe('count()', () => {
test('simple visit', (done) => {
let multiCalled = false;
let execCalled = false;
let hincrbyCalls = [];
mockClient.multi = () => {
multiCalled = true;
return mockClient;
};
mockClient.hincrby = (hash, key, value) => {
hincrbyCalls.push([
hash,
key,
value,
]);
return mockClient;
};
mockClient.exec = (cb) => {
execCalled = true;
cb();
};
hc.count({
headers: {},
connection: { remoteAddress: 'test1' },
}, '/test/path/1', false, () => {
expect(multiCalled).toBeTruthy();
expect(hincrbyCalls).toEqual([
[
'/test/path/1',
'h',
1,
],
[
'/test/path/1',
'v',
1,
],
]);
expect(execCalled).toBeTruthy();
done();
});
});
test('re-visit after long time', (done) => {
let hincrbyCalls = [];
mockClient.hincrby = (hash, key, value) => {
hincrbyCalls.push([
hash,
key,
value,
]);
return mockClient;
};
hc.count({
headers: {},
connection: { remoteAddress: 'test2' },
}, '/test/path/2', false, () => {
hc.count({
headers: {},
connection: { remoteAddress: 'test2' },
}, '/test/path/2', false, () => {
expect(hincrbyCalls).toEqual([
[
'/test/path/2',
'h',
1,
],
[
'/test/path/2',
'v',
1,
],
[
'/test/path/2',
'h',
1,
],
[
'/test/path/2',
'v',
1,
],
]);
done();
});
});
});
test('re-visit after short time', (done) => {
config['hit_counter']['unique_visitor_timeout'] = 10000;
let hincrbyCalls = [];
mockClient.hincrby = (hash, key, value) => {
hincrbyCalls.push([
hash,
key,
value,
]);
return mockClient;
};
hc.count({
headers: {},
connection: { remoteAddress: 'test3' },
}, '/test/path/3', false, () => {
hc.count({
headers: {},
connection: { remoteAddress: 'test3' },
}, '/test/path/3', false, () => {
expect(hincrbyCalls).toEqual([
[
'/test/path/3',
'h',
1,
],
[
'/test/path/3',
'v',
1,
],
[
'/test/path/3',
'h',
1,
],
[
'/test/path/3',
'v',
0,
],
]);
done();
});
});
});
});
+113 -29
View File
@@ -1,4 +1,3 @@
/* jshint -W117 */
const fs = require('fs');
const path = require('path');
const utils = require('./test_utils');
@@ -7,23 +6,24 @@ const dataDir = 'test_data';
const file = path.join(dataDir, 'test.md');
const config = {
'test': true,
'modules': {
test: true,
modules: {
'prism': true,
'mathjax': true,
'plantuml': true
'plantuml': true,
'fa-diagrams': true,
},
'showdown': {
'simplifiedAutoLink': true,
'smartIndentationFix': true
showdown: {
simplifiedAutoLink: true,
smartIndentationFix: true,
},
'mathjax': {
'output_format': 'html',
'speak_text': false
mathjax: {
output_format: 'html',
speak_text: false,
},
plantuml: {
output_format: 'svg',
},
'plantuml': {
'output_format': 'svg'
}
};
const renderer = require('../src/renderer')(config);
@@ -32,6 +32,7 @@ beforeEach(() => {
config['modules']['prism'] = true;
config['modules']['mathjax'] = true;
config['modules']['plantuml'] = true;
config['modules']['fa-diagrams'] = true;
utils.deleteFolderSync(dataDir);
fs.mkdirSync(dataDir);
});
@@ -42,6 +43,45 @@ afterAll(() => {
}
});
describe('get parts', () => {
test('normal', () => {
const data = 'Hello\nthere\ngeneral\nkenobi';
const parts = renderer.getParts(data);
expect(parts.map(p => p.text)).toEqual([ 'Hello\nthere\ngeneral\nkenobi' ]);
});
test('lot of stuff', () => {
const data = 'Hello\nthere\n```code```\ngeneral<script>script</script>\n<script>script2</script>\n```<script>script3</script>```kenobi';
const parts = renderer.getParts(data);
expect(parts).toEqual([
{
index: 0,
end: 12,
text: 'Hello\nthere\n',
},
{
index: 22,
end: 30,
text: '\ngeneral',
},
{
index: 53,
end: 54,
text: '\n',
},
{
index: 78,
end: 79,
text: '\n',
},
{
index: 109,
end: 115,
text: 'kenobi',
},
]);
});
});
describe('Test Showdown', () => {
test('normal', (done) => {
renderer.renderShowDown('# Hello', (html) => {
@@ -112,6 +152,13 @@ describe('Test PlantUML', () => {
});
});
test('plantuml ignored in code', (done) => {
renderer.renderPlantUML('code:\n```@startuml\nBob -> Alice : hello\n@enduml```\n ```@startuml``` @enduml', (data) => {
expect(data).toBe('code:\n```@startuml\nBob -> Alice : hello\n@enduml```\n ```@startuml``` @enduml');
done();
});
});
test('plantuml multiple uml', (done) => {
renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml\n@startuml\nBob -> Alice : hello\n@enduml', (data) => {
expect(data).toBe('<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">\n<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">');
@@ -131,9 +178,9 @@ describe('Test MathJax', () => {
});
test('full eq', (done) => {
renderer.renderMathJax('$$\n\nA\n\n$$', (data) => {
expect(data).toBe('<span class=\"mjx-chtml MJXc-display\" style=\"text-align: center;\">' +
'<span class=\"mjx-math\"><span class=\"mjx-mrow\"><span class=\"mjx-mi\">' +
'<span class=\"mjx-char MJXc-TeX-math-I\" style=\"padding-top: 0.519em; padding-bottom: 0.298em;\">' +
expect(data).toBe('<span class="mjx-chtml MJXc-display" style="text-align: center;">' +
'<span class="mjx-math"><span class="mjx-mrow"><span class="mjx-mi">' +
'<span class="mjx-char MJXc-TeX-math-I" style="padding-top: 0.519em; padding-bottom: 0.298em;">' +
'A' +
'</span></span></span></span></span>');
done();
@@ -142,9 +189,9 @@ describe('Test MathJax', () => {
test('inline eq', (done) => {
renderer.renderMathJax('start $a$ end', (data) => {
expect(data).toBe('start ' +
'<span class=\"mjx-chtml\">' +
'<span class=\"mjx-math\"><span class=\"mjx-mrow\"><span class=\"mjx-mi\">' +
'<span class=\"mjx-char MJXc-TeX-math-I\" style=\"padding-top: 0.225em; padding-bottom: 0.298em;\">' +
'<span class="mjx-chtml">' +
'<span class="mjx-math"><span class="mjx-mrow"><span class="mjx-mi">' +
'<span class="mjx-char MJXc-TeX-math-I" style="padding-top: 0.225em; padding-bottom: 0.298em;">' +
'a' +
'</span></span></span></span></span>' +
' end');
@@ -157,24 +204,30 @@ describe('Test MathJax', () => {
done();
});
});
test('no eq in code / script', (done) => {
renderer.renderMathJax('this code is ```start $a$ end $$hello$$``` beautiful <script>$A$</script>\n```$no eq$```', (data) => {
expect(data).toBe('this code is ```start $a$ end $$hello$$``` beautiful <script>$A$</script>\n```$no eq$```');
done();
});
});
test('multiple eq', (done) => {
renderer.renderMathJax('$$\n\nA\n\n$$\nstart $a$ end\n$$\n\nA\n\n$$', (data) => {
expect(data).toBe('' +
'<span class=\"mjx-chtml MJXc-display\" style=\"text-align: center;\">' +
'<span class=\"mjx-math\"><span class=\"mjx-mrow\"><span class=\"mjx-mi\">' +
'<span class=\"mjx-char MJXc-TeX-math-I\" style=\"padding-top: 0.519em; padding-bottom: 0.298em;\">' +
'<span class="mjx-chtml MJXc-display" style="text-align: center;">' +
'<span class="mjx-math"><span class="mjx-mrow"><span class="mjx-mi">' +
'<span class="mjx-char MJXc-TeX-math-I" style="padding-top: 0.519em; padding-bottom: 0.298em;">' +
'A' +
'</span></span></span></span></span>\n' +
'start ' +
'<span class=\"mjx-chtml\">' +
'<span class=\"mjx-math\"><span class=\"mjx-mrow\"><span class=\"mjx-mi\">' +
'<span class=\"mjx-char MJXc-TeX-math-I\" style=\"padding-top: 0.225em; padding-bottom: 0.298em;\">' +
'<span class="mjx-chtml">' +
'<span class="mjx-math"><span class="mjx-mrow"><span class="mjx-mi">' +
'<span class="mjx-char MJXc-TeX-math-I" style="padding-top: 0.225em; padding-bottom: 0.298em;">' +
'a' +
'</span></span></span></span></span>' +
' end\n' +
'<span class=\"mjx-chtml MJXc-display\" style=\"text-align: center;\">' +
'<span class=\"mjx-math\"><span class=\"mjx-mrow\"><span class=\"mjx-mi\">' +
'<span class=\"mjx-char MJXc-TeX-math-I\" style=\"padding-top: 0.519em; padding-bottom: 0.298em;\">' +
'<span class="mjx-chtml MJXc-display" style="text-align: center;">' +
'<span class="mjx-math"><span class="mjx-mrow"><span class="mjx-mi">' +
'<span class="mjx-char MJXc-TeX-math-I" style="padding-top: 0.519em; padding-bottom: 0.298em;">' +
'A' +
'</span></span></span></span></span>');
done();
@@ -182,6 +235,37 @@ describe('Test MathJax', () => {
});
});
describe('Test fa-diagrams', () => {
test('no fa-diagrams', (done) => {
config['modules']['fa-diagrams'] = false;
renderer.renderFaDiagrams('@startfad\noptions.rendering.color=\'red\'\n@endfad', (data) => {
expect(data).toBe('@startfad\noptions.rendering.color=\'red\'\n@endfad');
done();
});
});
test('no fa-diagrams in code', (done) => {
renderer.renderFaDiagrams('code:\n```\n@startfad\noptions.rendering.color=\'red\'\n@endfad\n```', (data) => {
expect(data).toBe('code:\n```\n@startfad\noptions.rendering.color=\'red\'\n@endfad\n```');
done();
});
});
test('valid fa-diagrams', (done) => {
renderer.renderFaDiagrams('before\n@startfad\noptions.rendering.color=\'red\'\n@endfad\nafter', (data) => {
expect(data).toBe('before\n<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 0 0" width="0" height="0" font-family="Arial" font-size="15" fill="red" stroke-width="0"></svg>\nafter');
done();
});
});
test('invalid toml', (done) => {
renderer.renderFaDiagrams('before\n@startfad\noptions.rendering.color=red\n@endfad\nafter', (data) => {
expect(data).toBe('before\n<b style="color:red">TomlError: Unexpected character, expecting string, number, datetime, boolean, inline array or inline table at row 1, col 26, pos 25:\n' +
'1> options.rendering.color=red\n' +
' ^\n' +
'\n</b>\nafter');
done();
});
});
});
describe('Test render', () => {
test('invalid file', (done) => {
renderer.render('invalid file', (err, html) => {
@@ -192,7 +276,7 @@ describe('Test render', () => {
});
test('normal file', (done) => {
fs.writeFileSync(file, `# Hello`);
fs.writeFileSync(file, '# Hello');
renderer.render(file, (err, html) => {
expect(err).toBeNull();
expect(html).toBe('<h1 id="hello">Hello</h1>');
-1
View File
@@ -1,4 +1,3 @@
/* jshint -W117 */
const fs = require('fs');
const path = require('path');
const utils = require('./test_utils');
+7 -5
View File
@@ -2,17 +2,19 @@ const fs = require('fs');
const path = require('path');
const deleteFolderSync = (dir) => {
if (!fs.existsSync(dir))
if (!fs.existsSync(dir)) {
return;
}
let items;
const deleteItem = (item) => {
if (item.isDirectory())
if (item.isDirectory()) {
deleteFolderSync(path.join(dir, item.name));
else
} else {
fs.unlinkSync(path.join(dir, item.name));
}
};
do {
items = fs.readdirSync(dir, {withFileTypes: true});
items = fs.readdirSync(dir, { withFileTypes: true });
try {
items.forEach(deleteItem);
} catch (e) {
@@ -24,6 +26,6 @@ const deleteFolderSync = (dir) => {
module.exports = {
deleteFolderSync: deleteFolderSync,
createEmptyDirs: (list) => list.forEach((path) => fs.mkdirSync(path, {recursive: true})),
createEmptyDirs: (list) => list.forEach((path) => fs.mkdirSync(path, { recursive: true })),
createEmptyFiles: (list) => list.forEach((file) => fs.writeFileSync(file, '')),
};
BIN
View File
Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 20 KiB

+2
View File
@@ -10,6 +10,7 @@ node nodejs {
}
package data {
[template.ejs]
package "2019/06/18" {
component index [
index.md
@@ -22,6 +23,7 @@ package data {
web -down-> TCP : 1. /2019/06/18/title
express -down-> index : 2. fetch
index -up-> showdown : 3. markdown
template.ejs -up-> express : 4
showdown -left-> express : 4. html
express -up-> web : 5. html