From 53300624878cde3d1f323f9ff7fefe87ee8f0c0a Mon Sep 17 00:00:00 2001 From: Dean Eigenmann <7621705+decanus@users.noreply.github.com> Date: Thu, 21 May 2020 06:20:44 +0200 Subject: [PATCH] adds link checks (#131) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Oskar Thorén --- .remarkrc | 1 + package-lock.json | 109 +++++++++++++++++++++++++++++++++++++++++++ package.json | 3 +- specs/waku/waku-0.md | 7 ++- specs/waku/waku-1.md | 7 ++- 5 files changed, 118 insertions(+), 9 deletions(-) diff --git a/.remarkrc b/.remarkrc index a21303b5..8974cf93 100644 --- a/.remarkrc +++ b/.remarkrc @@ -1,6 +1,7 @@ { "presets": ["lint-recommended", "lint-consistent"], "plugins": { + "validate-links": {"repository": false}, "remark-lint": { "unordered-list-marker-style": "consistent", "list-item-bullet-indent": true, diff --git a/package-lock.json b/package-lock.json index 44843bbe..c7b7ac1f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -435,6 +435,11 @@ } } }, + "emoji-regex": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-6.1.1.tgz", + "integrity": "sha1-xs0OwbBkLio8Z6ETfvxeeW2k+I4=" + }, "error-ex": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", @@ -1126,6 +1131,14 @@ "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz", "integrity": "sha1-3BXKHGcjh8p2vTesCjlbogQqLCg=" }, + "github-slugger": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-1.3.0.tgz", + "integrity": "sha512-gwJScWVNhFYSRDvURk/8yhcFBee6aFjye2a7Lhb2bUyRulpIoek9p0I9Kt7PT67d/nUlZbFu8L9RLiA0woQN8Q==", + "requires": { + "emoji-regex": ">=6.0.0 <=6.1.1" + } + }, "glob": { "version": "7.1.6", "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", @@ -1202,6 +1215,14 @@ } } }, + "hosted-git-info": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-3.0.4.tgz", + "integrity": "sha512-4oT62d2jwSDBbLLFLZE+1vPuQ1h8p9wjrJ8Mqx5TjsyWmBMV5B13eJqn8pvluqubLf3cJPTfiYCIwNwDNmzScQ==", + "requires": { + "lru-cache": "^5.1.1" + } + }, "ignore": { "version": "3.3.10", "resolved": "https://registry.npmjs.org/ignore/-/ignore-3.3.10.tgz", @@ -1467,6 +1488,11 @@ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==" }, + "levenshtein-edit-distance": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/levenshtein-edit-distance/-/levenshtein-edit-distance-1.0.0.tgz", + "integrity": "sha1-iVuvR4zOi1waDSfkXXwdl4pmHkk=" + }, "load-plugin": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/load-plugin/-/load-plugin-2.3.1.tgz", @@ -1481,6 +1507,14 @@ "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-2.0.4.tgz", "integrity": "sha512-vM6rUVCVUJJt33bnmHiZEvr7wPT78ztX7rojL+LW51bHtLh6HTjx84LA5W4+oa6aKEJA7jJu5LR6vQRBpA5DVg==" }, + "lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "requires": { + "yallist": "^3.0.2" + } + }, "map-cache": { "version": "0.2.2", "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz", @@ -1745,6 +1779,14 @@ "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==" }, + "propose": { + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/propose/-/propose-0.0.5.tgz", + "integrity": "sha1-SKBl2ex9TIZn9AULFcSi2F28pWs=", + "requires": { + "levenshtein-edit-distance": "^1.0.0" + } + }, "rc": { "version": "1.2.8", "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", @@ -2060,6 +2102,68 @@ "xtend": "^4.0.1" } }, + "remark-validate-links": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/remark-validate-links/-/remark-validate-links-10.0.0.tgz", + "integrity": "sha512-BLVKPCoF8BLZCgJyDNw8rEL9++ohx+lpc6eZl7GNmHxJi3SR5tA7JYNcEVmcDj7M6Kl04wmc6BaeJ1FYNQDaIQ==", + "requires": { + "github-slugger": "^1.0.0", + "hosted-git-info": "^3.0.0", + "mdast-util-to-string": "^1.0.0", + "propose": "0.0.5", + "to-vfile": "^6.0.0", + "trough": "^1.0.0", + "unist-util-visit": "^2.0.0", + "xtend": "^4.0.0" + }, + "dependencies": { + "to-vfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/to-vfile/-/to-vfile-6.1.0.tgz", + "integrity": "sha512-BxX8EkCxOAZe+D/ToHdDsJcVI4HqQfmw0tCkp31zf3dNP/XWIAjU4CmeuSwsSoOzOTqHPOL0KUzyZqJplkD0Qw==", + "requires": { + "is-buffer": "^2.0.0", + "vfile": "^4.0.0" + } + }, + "unist-util-is": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-4.0.2.tgz", + "integrity": "sha512-Ofx8uf6haexJwI1gxWMGg6I/dLnF2yE+KibhD3/diOqY2TinLcqHXCV6OI5gFVn3xQqDH+u0M625pfKwIwgBKQ==" + }, + "unist-util-visit": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-2.0.2.tgz", + "integrity": "sha512-HoHNhGnKj6y+Sq+7ASo2zpVdfdRifhTgX2KTU3B/sO/TTlZchp7E3S4vjRzDJ7L60KmrCPsQkVK3lEF3cz36XQ==", + "requires": { + "@types/unist": "^2.0.0", + "unist-util-is": "^4.0.0", + "unist-util-visit-parents": "^3.0.0" + } + }, + "unist-util-visit-parents": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-3.0.2.tgz", + "integrity": "sha512-yJEfuZtzFpQmg1OSCyS9M5NJRrln/9FbYosH3iW0MG402QbdbaB8ZESwUv9RO6nRfLAKvWcMxCwdLWOov36x/g==", + "requires": { + "@types/unist": "^2.0.0", + "unist-util-is": "^4.0.0" + } + }, + "vfile": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/vfile/-/vfile-4.1.1.tgz", + "integrity": "sha512-lRjkpyDGjVlBA7cDQhQ+gNcvB1BGaTHYuSOcY3S7OhDmBtnzX95FhtZZDecSTDm6aajFymyve6S5DN4ZHGezdQ==", + "requires": { + "@types/unist": "^2.0.0", + "is-buffer": "^2.0.0", + "replace-ext": "1.0.0", + "unist-util-stringify-position": "^2.0.0", + "vfile-message": "^2.0.0" + } + } + } + }, "remove-trailing-separator": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/remove-trailing-separator/-/remove-trailing-separator-1.1.0.tgz", @@ -2740,6 +2844,11 @@ "version": "4.0.2", "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz", "integrity": "sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ==" + }, + "yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==" } } } diff --git a/package.json b/package.json index 49847894..8c9019ea 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,8 @@ "dependencies": { "remark-cli": "^6.0.1", "remark-lint": "^6.0.2", - "remark-preset-lint-recommended": "^3.0.2" + "remark-preset-lint-recommended": "^3.0.2", + "remark-validate-links": "^10.0.0" }, "scripts": { "lint": "remark ." diff --git a/specs/waku/waku-0.md b/specs/waku/waku-0.md index ad07ecad..a4a7fbe2 100644 --- a/specs/waku/waku-0.md +++ b/specs/waku/waku-0.md @@ -27,7 +27,7 @@ redirect_from: - [Accounting for resources (experimental)](#accounting-for-resources-experimental) - [Backwards Compatibility](#backwards-compatibility) - [Waku-Whisper bridging](#waku-whisper-bridging) -- [Forwards Compatibility](#forwards-compatibility) +- [Forward Compatibility](#forward-compatibility) - [Appendix A: Security considerations](#appendix-a-security-considerations) - [Scalability and UX](#scalability-and-ux) - [Privacy](#privacy) @@ -44,8 +44,7 @@ redirect_from: - [Version 0.3](#version-03) - [Version 0.2](#version-02) - [Version 0.1](#version-01) - - [Differences between shh/6 waku/0](#differences-between-shh6-waku0) -- [Acknowledgments](#acknowledgments) + - [Differences between shh/6 waku/0](#differences-between-shh6-and-waku0) - [Copyright](#copyright) - [Footnotes](#footnotes) @@ -442,7 +441,7 @@ It is desirable to have a strategy for maintaining forward compatibility between ## Appendix A: Security considerations -There are several security considerations to take into account when running Waku. Chief among them are: scalability, DDoS-resistance and privacy. These also vary depending on what capabilities are used. The security considerations for extra capabilities such as [mailservers](./wms.md#security-considerations) can be found in their respective specifications. +There are several security considerations to take into account when running Waku. Chief among them are: scalability, DDoS-resistance and privacy. These also vary depending on what capabilities are used. The security considerations for extra capabilities such as [mailservers](./mailserver.md#security-considerations) can be found in their respective specifications. ### Scalability and UX diff --git a/specs/waku/waku-1.md b/specs/waku/waku-1.md index fcb4c3bf..d7c43f7f 100644 --- a/specs/waku/waku-1.md +++ b/specs/waku/waku-1.md @@ -27,7 +27,7 @@ redirect_from: - [Accounting for resources (experimental)](#accounting-for-resources-experimental) - [Backwards Compatibility](#backwards-compatibility) - [Waku-Whisper bridging](#waku-whisper-bridging) -- [Forwards Compatibility](#forwards-compatibility) +- [Forward Compatibility](#forward-compatibility) - [Appendix A: Security considerations](#appendix-a-security-considerations) - [Scalability and UX](#scalability-and-ux) - [Privacy](#privacy) @@ -45,8 +45,7 @@ redirect_from: - [Version 0.3](#version-03) - [Version 0.2](#version-02) - [Version 0.1](#version-01) - - [Differences between shh/6 waku/1](#differences-between-shh6-waku1) -- [Acknowledgments](#acknowledgments) + - [Differences between shh/6 waku/1](#differences-between-shh6-and-waku1) - [Copyright](#copyright) - [Footnotes](#footnotes) @@ -456,7 +455,7 @@ It is desirable to have a strategy for maintaining forward compatibility between ## Appendix A: Security considerations -There are several security considerations to take into account when running Waku. Chief among them are: scalability, DDoS-resistance and privacy. These also vary depending on what capabilities are used. The security considerations for extra capabilities such as [mailservers](./wms.md#security-considerations) can be found in their respective specifications. +There are several security considerations to take into account when running Waku. Chief among them are: scalability, DDoS-resistance and privacy. These also vary depending on what capabilities are used. The security considerations for extra capabilities such as [mailservers](./mailserver.md#security-considerations) can be found in their respective specifications. ### Scalability and UX