├── .gitignore ├── __tests__ ├── .eslintrc.json └── get-url.js ├── .eslintrc.json ├── .editorconfig ├── lib ├── specgo-error.js ├── cli.js └── specgo.js ├── .github └── workflows │ └── test.yml ├── README.md ├── package.json └── LICENSE.txt /.gitignore: -------------------------------------------------------------------------------- 1 | /node_modules/ 2 | -------------------------------------------------------------------------------- /__tests__/.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../.eslintrc.json", 3 | "env": { 4 | "jest": true 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "extends": "@domenic", 4 | "env": { 5 | "node": true 6 | }, 7 | "rules": { 8 | "no-console": "off" 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | end_of_line = lf 5 | insert_final_newline = true 6 | trim_trailing_whitespace = true 7 | charset = utf-8 8 | indent_style = space 9 | indent_size = 2 10 | -------------------------------------------------------------------------------- /lib/specgo-error.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | // An error class used to identify errors from this program as opposed to ones bubbling from elsewhere. 4 | module.exports = class SpecgoError extends Error {}; 5 | module.exports.prototype.name = "SpecgoError"; 6 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Node.js CI 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | test: 7 | runs-on: ubuntu-latest 8 | 9 | steps: 10 | - uses: actions/checkout@v2 11 | - uses: actions/setup-node@v2 12 | with: 13 | node-version: 14 14 | - run: npm ci 15 | - run: npm run lint 16 | - run: npm test 17 | -------------------------------------------------------------------------------- /lib/cli.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | "use strict"; 3 | 4 | const open = require("open"); 5 | const { getURL } = require("./specgo.js"); 6 | 7 | main().catch(e => { 8 | if (e.name === "SpecgoError") { 9 | console.error(e.message); 10 | } else { 11 | console.error(e.stack); 12 | } 13 | 14 | process.exit(1); 15 | }); 16 | 17 | async function main() { 18 | const url = await getURL(process.argv[2]); 19 | await open(url); 20 | } 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Specgo 2 | 3 | Specgo is a command-line utility for opening web specifications (such as those from the WHATWG, W3C, or IETF) in your web browser. 4 | 5 | Once you install it, using 6 | 7 | ```bash 8 | npm install -g specgo 9 | ``` 10 | 11 | you can use it like so: 12 | 13 | ```bash 14 | specgo html # opens https://html.spec.whatwg.org/multipage/ 15 | 16 | specgo mix # opens https://w3c.github.io/webappsec-mixed-content/ 17 | specgo mixed-content # ditto 18 | 19 | specgo rfc7234 # opens https://httpwg.org/specs/rfc7234.html 20 | ``` 21 | 22 | ## Acknowledgments 23 | 24 | This tool is largely a frontend to [Specref](https://www.specref.org/), by [@tobie](https://github.com/tobie). 25 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "specgo", 3 | "description": "A command-line tool for opening web specifications", 4 | "keywords": [ 5 | "spec", 6 | "standard", 7 | "w3c", 8 | "whatwg", 9 | "ietf" 10 | ], 11 | "version": "1.0.0", 12 | "author": "Domenic Denicola (https://domenic.me/)", 13 | "license": "Apache-2.0", 14 | "repository": "domenic/specgo", 15 | "main": "lib/specgo.js", 16 | "bin": { 17 | "specgo": "lib/cli.js" 18 | }, 19 | "files": [ 20 | "lib/" 21 | ], 22 | "scripts": { 23 | "lint": "eslint", 24 | "test": "jest" 25 | }, 26 | "dependencies": { 27 | "node-fetch": "^2.6.1", 28 | "open": "^7.4.1" 29 | }, 30 | "devDependencies": { 31 | "@domenic/eslint-config": "^1.0.0", 32 | "eslint": "^7.20.0", 33 | "jest": "^26.6.3" 34 | }, 35 | "jest": { 36 | "testEnvironment": "node" 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /lib/specgo.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | const fetch = require("node-fetch"); 3 | const SpecgoError = require("./specgo-error.js"); 4 | 5 | exports.getURL = async input => { 6 | if (input.includes(",")) { 7 | throw new SpecgoError("Spec name is invalid (it contains a comma)"); 8 | } 9 | 10 | const res = await fetch(`https://api.specref.org/bibrefs?refs=${input}`); 11 | if (!res.ok) { 12 | throw new SpecgoError("Received a non-OK status code from the Specref API"); 13 | } 14 | 15 | const body = await res.json(); 16 | 17 | const keys = Object.keys(body); 18 | if (keys.length === 0) { 19 | throw new SpecgoError(`No spec with name "${input}" found in the Specref database.`); 20 | } 21 | 22 | // Assume the first is correct. The others always seem to be different casings. 23 | const spec = body[keys[0]]; 24 | 25 | if (spec.aliasOf) { 26 | return exports.getURL(spec.aliasOf); 27 | } 28 | 29 | return spec.edDraft ?? spec.href; 30 | }; 31 | -------------------------------------------------------------------------------- /__tests__/get-url.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | const { getURL } = require("../lib/specgo.js"); 4 | const SpecgoError = require("../lib/specgo-error.js"); 5 | 6 | // TODO: we should stub out fetch() with saved results and make these proper unit tests. 7 | // Then we can do two integration tests (which test cli.js with mocked open() but real fetch()). 8 | 9 | describe("Basics", () => { 10 | testURL("html", "https://html.spec.whatwg.org/multipage/"); 11 | testURL("mixed-content", "https://w3c.github.io/webappsec-mixed-content/"); 12 | testURL("rfc7234", "https://httpwg.org/specs/rfc7234.html"); 13 | }); 14 | 15 | describe("Aliases", () => { 16 | testURL("whatwg-html", "https://html.spec.whatwg.org/multipage/"); 17 | testURL("mix", "https://w3c.github.io/webappsec-mixed-content/"); 18 | }); 19 | 20 | describe("Casing doesn't matter", () => { 21 | testURL("HTML", "https://html.spec.whatwg.org/multipage/"); 22 | testURL("HtMl", "https://html.spec.whatwg.org/multipage/"); 23 | testURL("MiX", "https://w3c.github.io/webappsec-mixed-content/"); 24 | testURL("MIXED-content", "https://w3c.github.io/webappsec-mixed-content/"); 25 | testURL("RFC7234", "https://httpwg.org/specs/rfc7234.html"); 26 | }); 27 | 28 | describe("Failure cases", () => { 29 | testURLFailure("html,mix"); 30 | testURLFailure("asdf"); 31 | }); 32 | 33 | function testURL(input, expectedURL) { 34 | test(input, async () => { 35 | expect(await getURL(input)).toEqual(expectedURL); 36 | }); 37 | } 38 | 39 | function testURLFailure(input) { 40 | test(input, () => { 41 | return expect(getURL(input)).rejects.toThrow(SpecgoError); 42 | }); 43 | } 44 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------