Rename library to use "addons" everywhere (#74)

Closes #4

Author: humitos

.readthedocs.yaml

@@ -19,13 +19,13 @@ build:
     - mkdir --parents $READTHEDOCS_OUTPUT/html/examples
 
     # Copy our client into the output
-    - cp --verbose dist/readthedocs-client.js $READTHEDOCS_OUTPUT/html/examples
+    - cp --verbose dist/readthedocs-addons.js $READTHEDOCS_OUTPUT/html/examples
 
     # Copy all the example sites (Sphinx and Pelican) into the output
     - cp --recursive --verbose public/* $READTHEDOCS_OUTPUT/html/examples/
 
     # Copy a JSON file that acts as the response of the API
-    - cp --verbose public/_/readthedocs-config.json $READTHEDOCS_OUTPUT/html/examples
+    - cp --verbose public/_/readthedocs-addons.json $READTHEDOCS_OUTPUT/html/examples
 
     # Show all the files served by Read the Docs
     - find $READTHEDOCS_OUTPUT/html

dist/readthedocs-client.js renamed to dist/readthedocs-addons.js

@@ -1,2 +1,2 @@
-sed -i -e 's|</head>|<script src="../readthedocs-client.js"></script></head>|g' $READTHEDOCS_OUTPUT/html/examples/pelican/index.html
-sed -i -e 's|</head>|<script src="../readthedocs-client.js"></script></head>|g' $READTHEDOCS_OUTPUT/html/examples/sphinx/index.html
+sed -i -e 's|</head>|<script src="../readthedocs-addons.js"></script></head>|g' $READTHEDOCS_OUTPUT/html/examples/pelican/index.html
+sed -i -e 's|</head>|<script src="../readthedocs-addons.js"></script></head>|g' $READTHEDOCS_OUTPUT/html/examples/sphinx/index.html

dist/readthedocs-addons.js.map

@@ -1,5 +1,5 @@
-🦸 JavaScript Client: ``readthedocs-superpowers.js``
-====================================================
+🦸 JavaScript Client: ``readthedocs-addons.js``
+===============================================
 
 JavaScript client injected into documentation pages served at Read the Docs.
 This client allows projects to quickly integrate with all the nice features that Read the Docs offers.

dist/readthedocs-client.js.map

@@ -5,5 +5,5 @@ This directory contains different doctool examples.
 Each of the sub-directories have to be built with the specific doctool
 and its output has to be saved into `public/<sub-directory>` so it can be tested.
 
-_There is no need to inject the `readthedocs-client.js` script into the HTML files.
+_There is no need to inject the `readthedocs-addons.js` script into the HTML files.
 This will be done automatically by the dev server, emulating what CloudFlare will do for us._

docs/.inject-js.sh

@@ -1,7 +1,7 @@
 Example
 =======
 
-Example page to show all ``readthedocs-client.js`` integrations.
+Example page to show all ``readthedocs-addons.js`` integrations.
 
 hoverxref
 ---------

docs/index.rst

@@ -1,8 +1,8 @@
 {
-  "name": "readthedocs-client",
+  "name": "@readthedocs/addons",
   "version": "0.1.0",
-  "description": "Read the Docs client embeded into documentation pages",
-  "main": "dist/readthedocs-client.js",
+  "description": "Read the Docs Addons to embed into documentation pages",
+  "main": "dist/readthedocs-addons.js",
   "scripts": {
     "build": "webpack --mode=production --progress",
     "clean": "rm -rfv dist/*; exit 0",

examples/README.md

@@ -5,7 +5,7 @@
       "slug": "example",
       "language": "en",
       "repository": {
-        "url": "https://github.com/readthedocs/readthedocs-client",
+        "url": "https://github.com/readthedocs/addons",
         "type": "git"
       },
       "programming_language": "words"
@@ -33,14 +33,14 @@
   "addons": {
     "search": {
       "enabled": true,
-      "project": "readthedocs-client",
+      "project": "addons",
       "version": "latest",
       "api_endpoint": "/_/api/v3/search/",
       "filters": [
-        ["Search only in this project", "project:readthedocs-client/latest"],
-        ["Search subprojects", "subprojects:readthedocs-client/latest"]
+        ["Search only in this project", "project:addons/latest"],
+        ["Search subprojects", "subprojects:addons/latest"]
       ],
-      "default_filter": "subprojects:readthedocs-client/latest"
+      "default_filter": "subprojects:addons/latest"
     },
     "analytics": {
       "enabled": true,

examples/sphinx/index.rst

@@ -72,7 +72,7 @@
 
   <section id="example">
 <h1>Example<a class="headerlink" href="#example" title="Permalink to this heading"></a></h1>
-<p>Example page to show all <code class="docutils literal notranslate"><span class="pre">readthedocs-client.js</span></code> integrations.</p>
+<p>Example page to show all <code class="docutils literal notranslate"><span class="pre">readthedocs-addons.js</span></code> integrations.</p>
 <section id="hoverxref">
 <h2>hoverxref<a class="headerlink" href="#hoverxref" title="Permalink to this heading"></a></h2>
 <p>Hover on the following link to see a tooltip: <a class="reference internal" href="page.html"><span class="doc">Page</span></a></p>

package-lock.json

@@ -6,14 +6,14 @@ import { CLIENT_VERSION } from "./utils";
  */
 export function getReadTheDocsConfig() {
   let url =
-    "/_/readthedocs-config/?" +
+    "/_/addons/?" +
     new URLSearchParams({
       url: window.location.href,
     });
 
   // Retrieve a static JSON file when working in development mode
   if (window.location.href.startsWith("http://localhost")) {
-    url = "/_/readthedocs-config.json";
+    url = "/_/readthedocs-addons.json";
   }
 
   return fetch(url, {

package.json

@@ -3,7 +3,7 @@
     "project": {
         "slug": "example",
         "language": "en",
-        "repository_url": "https://github.com/humitos/readthedocs-client",
+        "repository_url": "https://github.com/readthedocs/addons",
         "programming_language": "words"
     },
     "version": {

public/_/readthedocs-config.json renamed to public/_/readthedocs-addons.json

@@ -5,7 +5,7 @@ const webpack = require("webpack");
 
 // Emulates what CloudFlare will do for us
 // https://github.com/webpack/webpack-dev-server/issues/4508
-var injectReadTheDocsClient = interceptor(function (req, res) {
+var injectReadTheDocsAddons = interceptor(function (req, res) {
   return {
     // Only HTML responses will be intercepted
     isInterceptable: function () {
@@ -15,7 +15,7 @@ var injectReadTheDocsClient = interceptor(function (req, res) {
       send(
         body.replace(
           "</head>",
-          '<script src="/readthedocs-client.js"></script></head>'
+          '<script src="/readthedocs-addons.js"></script></head>'
         )
       );
     },
@@ -28,7 +28,7 @@ module.exports = (env, argv) => {
 
   return {
     entry: {
-      "readthedocs-client": ["./src/init.js"],
+      "readthedocs-addons": ["./src/init.js"],
     },
     output: {
       filename: "[name].js?[fullhash]",
@@ -107,9 +107,9 @@ module.exports = (env, argv) => {
         // you want to hit.
         // https://docs.readthedocs.io/en/latest/development/install.html
         //
-        // There is also a file at `public/_/readthedocs-config.json` that you can modify
+        // There is also a file at `public/_/readthedocs-addons.json` that you can modify
         // to work locally without a development instance.
-        // "/_/readthedocs-config.json": {
+        // "/_/readthedocs-addons.json": {
         //     target: "http://test-builds.devthedocs.org",
         //     headers: {
         //         host: "test-builds.devthedocs.org",
@@ -123,8 +123,8 @@ module.exports = (env, argv) => {
         );
 
         middlewares.splice(index, 0, {
-          name: "readthedocs-client",
-          middleware: injectReadTheDocsClient,
+          name: "readthedocs-addons",
+          middleware: injectReadTheDocsAddons,
         });
         return middlewares;
       },