rx-player 3.26.1 → 3.26.2

package/jest.config.js

@@ -13,7 +13,6 @@ module.exports = {
     "!**/__tests__/**",
   ],
   globals: {
-    __DEV__: true,
     "ts-jest": {
       tsconfig: {
         target: "es2017",
@@ -36,5 +35,33 @@ module.exports = {
         ],
       },
     },
+    __FEATURES__: {
+      IS_DISABLED: 0,
+      IS_ENABLED: 1,
+
+      BIF_PARSER: 1,
+      DASH: 1,
+      DIRECTFILE: 1,
+      EME: 1,
+      HTML_SAMI: 1,
+      HTML_SRT: 1,
+      HTML_TTML: 1,
+      HTML_VTT: 1,
+      LOCAL_MANIFEST: 1,
+      METAPLAYLIST: 1,
+      NATIVE_SAMI: 1,
+      NATIVE_SRT: 1,
+      NATIVE_TTML: 1,
+      NATIVE_VTT: 1,
+      SMOOTH: 1,
+    },
+    __ENVIRONMENT__: {
+      PRODUCTION: 0,
+      DEV: 1,
+      CURRENT_ENV: 1,
+    },
+    __LOGGER_LEVEL__: {
+      CURRENT_LEVEL: "\"NONE\"",
+    },
   },
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rx-player",
   "author": "Canal+",
-  "version": "3.26.1",
+  "version": "3.26.2",
   "description": "Canal+ HTML5 Video Player",
   "main": "./dist/rx-player.js",
   "keywords": [
@@ -37,16 +37,15 @@
     "build:wasm:debug": "cd ./src/parsers/manifest/dash/wasm-parser && cargo build --target wasm32-unknown-unknown && cp target/wasm32-unknown-unknown/debug/mpd_node_parser.wasm ../../../../../dist/mpd-parser.wasm",
     "build:wasm:release": "cd ./src/parsers/manifest/dash/wasm-parser && cargo build --target wasm32-unknown-unknown --release && wasm-opt -O3 -o ../../../../../dist/mpd-parser.wasm target/wasm32-unknown-unknown/release/mpd_node_parser.wasm && cd ../../../../../ && npm run wasm-strip",
     "certificate": "./scripts/generate_certificate",
-    "check": "npm run check:types && npm run lint && npm run test:unit",
+    "check": "npm run check:types && npm run lint",
     "check:all": "npm run check:types && npm run lint && npm run lint:demo && npm run lint:tests && npm run test && npm run test:memory && node -r esm ./scripts/check_nodejs_import_compatibility.js",
     "check:appveyor": "npm run check:types && npm run lint && npm run lint:demo && npm run lint:tests && npm run test:appveyor",
-    "check:travis": "npm run check:types && npm run lint && npm run lint:demo && npm run lint:tests && npm run test:travis",
     "check:types": "tsc --noEmit --project .",
     "check:types:watch": "tsc --noEmit --watch --project .",
     "demo": "node ./scripts/generate_full_demo.js --production-mode",
     "demo:min": "node ./scripts/generate_full_demo.js --production-mode --minify",
     "demo:watch": "node ./scripts/generate_full_demo.js --watch --production-mode",
-    "doc": "rm -rf doc/generated; node ./scripts/doc-generator/index.js doc/ doc/generated",
+    "doc": "rm -rf doc/generated; node ./scripts/doc-generator/index.js doc/ doc/generated \"$(cat VERSION)\"",
     "lint": "eslint src -c .eslintrc.js",
     "lint:demo": "eslint demo/full/scripts",
     "lint:tests": "eslint tests/**/*.js",
@@ -54,6 +53,7 @@
     "prepublishOnly": "npm run build:modular",
     "standalone": "node ./scripts/run_standalone_demo.js",
     "start": "node ./scripts/start_demo_web_server.js",
+    "s": "node ./scripts/start_demo_web_server.js --fast",
     "wasm-strip": "node scripts/wasm-strip.js dist/mpd-parser.wasm",
     "test:appveyor": "npm run test:unit && npm run test:memory",
     "test:integration": "node tests/integration/run.js --bchromehl --bfirefoxhl",
@@ -63,10 +63,8 @@
     "test:integration:coverage": "node tests/integration/run.js --bchromehl --bfirefoxhl --coverage",
     "test:integration:firefox": "node tests/integration/run.js --bfirefox",
     "test:integration:firefox:watch": "node tests/integration/run.js --bfirefox --watch",
-    "test:integration:travis": "node tests/integration/run.js --bchromehl",
     "test:memory": "node tests/memory/run.js --bchromehl",
     "test:memory:chrome:watch": "node tests/memory/run.js --bchrome --watch",
-    "test:travis": "npm run test:unit && npm run test:integration:travis",
     "test:unit": "jest",
     "test:unit:coverage": "jest --coverage",
     "update-version": "npm run version --git-tag-version=false",
@@ -79,66 +77,67 @@
   "dependencies": {
     "next-tick": "1.1.0",
     "pinkie": "2.0.4",
-    "rxjs": "7.3.0"
+    "rxjs": "7.4.0"
   },
   "devDependencies": {
-    "@babel/core": "7.15.5",
-    "@babel/plugin-transform-runtime": "7.15.0",
-    "@babel/preset-env": "7.15.6",
-    "@babel/preset-react": "7.14.5",
-    "@types/chai": "4.2.21",
-    "@types/jest": "27.0.1",
+    "@babel/core": "7.16.7",
+    "@babel/plugin-transform-runtime": "7.16.7",
+    "@babel/preset-env": "7.16.7",
+    "@babel/preset-react": "7.16.7",
+    "@types/chai": "4.3.0",
+    "@types/jest": "27.4.0",
     "@types/mocha": "9.0.0",
-    "@types/node": "16.9.1",
-    "@types/sinon": "10.0.2",
-    "@typescript-eslint/eslint-plugin": "4.31.0",
-    "@typescript-eslint/eslint-plugin-tslint": "4.31.0",
-    "@typescript-eslint/parser": "4.31.0",
+    "@types/node": "17.0.7",
+    "@types/sinon": "10.0.6",
+    "@typescript-eslint/eslint-plugin": "5.8.1",
+    "@typescript-eslint/eslint-plugin-tslint": "5.8.1",
+    "@typescript-eslint/parser": "5.8.1",
     "arraybuffer-loader": "1.0.8",
-    "babel-loader": "8.2.2",
+    "babel-loader": "8.2.3",
     "chai": "4.3.4",
     "cheerio": "1.0.0-rc.10",
-    "core-js": "3.17.3",
-    "eslint": "7.32.0",
-    "eslint-plugin-import": "2.24.2",
-    "eslint-plugin-jsdoc": "36.1.0",
-    "eslint-plugin-react": "7.25.1",
+    "core-js": "3.20.2",
+    "esbuild": "0.14.10",
+    "eslint": "8.6.0",
+    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-jsdoc": "37.5.0",
+    "eslint-plugin-react": "7.28.0",
     "esm": "3.2.25",
-    "express": "4.17.1",
-    "highlight.js": "11.2.0",
+    "express": "4.17.2",
+    "highlight.js": "11.3.1",
+    "html-entities": "^2.3.2",
     "istanbul-instrumenter-loader": "3.0.1",
-    "jest": "27.2.0",
-    "karma": "6.3.4",
+    "jest": "27.4.5",
+    "karma": "6.3.9",
     "karma-chrome-launcher": "3.1.0",
     "karma-coverage-istanbul-reporter": "3.0.3",
-    "karma-firefox-launcher": "2.1.1",
+    "karma-firefox-launcher": "2.1.2",
     "karma-mocha": "2.0.1",
-    "karma-mocha-reporter": "2.2.5",
     "karma-webpack": "5.0.0",
-    "markdown-it": "12.2.0",
-    "markdown-it-emoji": "2.0.0",
-    "mocha": "9.1.1",
+    "markdown-it": "12.3.0",
+    "mocha": "9.1.3",
     "mocha-loader": "5.1.5",
     "raw-loader": "4.0.2",
     "react": "17.0.2",
     "react-dom": "17.0.2",
     "regenerator-runtime": "0.13.9",
     "rimraf": "3.0.2",
-    "sanitize-html": "2.5.0",
+    "sanitize-html": "2.6.1",
     "semver": "7.3.5",
-    "sinon": "11.1.2",
-    "terser-webpack-plugin": "5.2.4",
-    "ts-jest": "27.0.5",
-    "ts-loader": "9.2.5",
+    "sinon": "12.0.1",
+    "terser-webpack-plugin": "5.3.0",
+    "ts-jest": "27.1.2",
+    "ts-loader": "9.2.6",
     "tslint": "6.1.3",
-    "typescript": "4.4.3",
-    "webpack": "5.52.1",
-    "webpack-bundle-analyzer": "4.4.2",
-    "webpack-cli": "4.8.0"
+    "typescript": "4.5.4",
+    "webpack": "5.65.0",
+    "webpack-bundle-analyzer": "4.5.0",
+    "webpack-cli": "4.9.1"
   },
   "scripts-list": {
     "Build a demo page (e.g. to test a code change)": {
       "start": "Build the \"full\" demo (with a UI) with the non-minified RxPlayer and serve it on a local server. Re-build on file updates.",
+      "s": "Very fast version of `start` which does not perform type-checking. This script can be useful for quick testing",
       "demo": "Build the demo in demo/bundle.js",
       "demo:min": "Build the demo and minify it in demo/bundle.js",
       "demo:watch": "Build the demo in demo/bundle.js each times the files update.",
@@ -146,9 +145,10 @@
       "certificate": "Generate a certificate to be able to use HTTPS locally for the demo pages (`npm run start` and `npm run standalone` will then listen to HTTPS requests through a communicated port)"
     },
     "Type-check or lint the current code": {
-      "check": "Check the validity of the src directory by running the linter, type checker and unit tests",
+      "check": "Check the validity of the src directory by running the type checker and linter on it",
       "check:all": "Check the validity of the whole project by running linters, type checkers and every tests",
       "check:types": "Check TypeScript typings in src",
+      "check:types:watch": "Check TypeScript typings in src each time files change",
       "lint": "Lint rx-player source files",
       "lint:demo": "Lint demo source files",
       "lint:tests": "Lint integration tests source files"

package/scripts/build/constants.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright 2015 CANAL+ Group
+ *
+ * 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.
+ */
+
+/* eslint-disable @typescript-eslint/naming-convention */
+
+// Define build-time constants corresponding to the modular build.
+
+declare const enum __LOGGER_LEVEL__ {
+  CURRENT_LEVEL = "NONE",
+}
+
+declare const enum __ENVIRONMENT__ {
+  PRODUCTION = 0,
+  DEV = 1,
+  CURRENT_ENV = PRODUCTION,
+}
+
+declare const enum __FEATURES__ {
+  IS_DISABLED = 0,
+  IS_ENABLED = 1,
+
+  BIF_PARSER = IS_DISABLED,
+  DASH = IS_DISABLED,
+  DIRECTFILE = IS_DISABLED,
+  EME = IS_DISABLED,
+  HTML_SAMI = IS_DISABLED,
+  HTML_SRT = IS_DISABLED,
+  HTML_TTML = IS_DISABLED,
+  HTML_VTT = IS_DISABLED,
+  LOCAL_MANIFEST = IS_DISABLED,
+  METAPLAYLIST = IS_DISABLED,
+  NATIVE_SAMI = IS_DISABLED,
+  NATIVE_SRT = IS_DISABLED,
+  NATIVE_TTML = IS_DISABLED,
+  NATIVE_VTT = IS_DISABLED,
+  SMOOTH = IS_DISABLED,
+}

package/scripts/build/generate_build.js

@@ -41,66 +41,6 @@ const BUILD_ARTEFACTS_TO_REMOVE = [
   "logger"
 ];
 
-/**
- * In the following tuples:
- *
- *   1. the first element designates a token/constant used in the code that
- *      should be replaced.
- *
- *      Because for now, the search and replace operation is performed by sed,
- *      it needs to be a valid sed-compliant RegExp.
- *
- *      _Note: As GNU sed and BSD sed are not in accordance on the word boundary
- *      token (\b for GNU sed vs [[:<:]] and [[:>:]] for BSD sed) we just use \<
- *      and \> here (for respectively starting and ending word boundary) and
- *      replace with the right character on the corresponding sed call site._
- *
- *   2. The second element designates what it will be replaced by, as a string.
- *
- * TODO This is the ugliest part of the build process and should be better
- * integrated to TypeScript compilation (in essence, those are compile-time
- * constants).
- */
-const REPLACED_TOKENS_SED_REGXP = [
-  ["\<__DEV__\>", "false"],
-  ["\<__LOGGER_LEVEL__\>", "\"NONE\""],
-  ["\<__FEATURES__\.EME\>", "false"],
-  ["\<__FEATURES__\.SMOOTH\>", "false"],
-  ["\<__FEATURES__\.DASH\>", "false"],
-  ["\<__FEATURES__\.LOCAL_MANIFEST\>", "false"],
-  ["\<__FEATURES__\.METAPLAYLIST\>", "false"],
-  ["\<__FEATURES__\.DIRECTFILE\>", "false"],
-  ["\<__FEATURES__\.HTML_SAMI\>", "false"],
-  ["\<__FEATURES__\.HTML_SRT\>", "false"],
-  ["\<__FEATURES__\.HTML_TTML\>", "false"],
-  ["\<__FEATURES__\.HTML_VTT\>", "false"],
-  ["\<__FEATURES__\.NATIVE_SAMI\>", "false"],
-  ["\<__FEATURES__\.NATIVE_SRT\>", "false"],
-  ["\<__FEATURES__\.NATIVE_TTML\>", "false"],
-  ["\<__FEATURES__\.NATIVE_VTT\>", "false"],
-  ["\<__FEATURES__\.BIF_PARSER\>", "false"],
-  ["\<__RELATIVE_PATH__\.EME_MANAGER\>", "\"../core/eme/index.js\""],
-  ["\<__RELATIVE_PATH__\.IMAGE_BUFFER\>", "\"../core/segment_buffers/implementations/image/index.js\""],
-  ["\<__RELATIVE_PATH__\.BIF_PARSER\>", "\"../parsers/images/bif.js\""],
-  ["\<__RELATIVE_PATH__\.SMOOTH\>", "\"../transports/smooth/index.js\""],
-  ["\<__RELATIVE_PATH__\.DASH\>", "\"../transports/dash/index.js\""],
-  ["\<__RELATIVE_PATH__\.DASH_JS_PARSER\>", "\"../parsers/manifest/dash/js-parser/index.js\""],
-  ["\<__RELATIVE_PATH__\.LOCAL_MANIFEST\>", "\"../transports/local/index.js\""],
-  ["\<__RELATIVE_PATH__\.METAPLAYLIST\>", "\"../transports/dash/index.js\""],
-  ["\<__RELATIVE_PATH__\.NATIVE_TEXT_BUFFER\>", "\"../core/segment_buffers/implementations/text/native/index.js\""],
-  ["\<__RELATIVE_PATH__\.NATIVE_VTT\>", "\"../parsers/texttracks/webvtt/native.js\""],
-  ["\<__RELATIVE_PATH__\.NATIVE_SRT\>", "\"../parsers/texttracks/srt/native.js\""],
-  ["\<__RELATIVE_PATH__\.NATIVE_TTML\>", "\"../parsers/texttracks/ttml/native/index.js\""],
-  ["\<__RELATIVE_PATH__\.NATIVE_SAMI\>", "\"../parsers/texttracks/sami/native.js\""],
-  ["\<__RELATIVE_PATH__\.HTML_TEXT_BUFFER\>", "\"../core/segment_buffers/implementations/text/html/index.js\""],
-  ["\<__RELATIVE_PATH__\.HTML_VTT\>", "\"../parsers/texttracks/webvtt/html/index.js\""],
-  ["\<__RELATIVE_PATH__\.HTML_SRT\>", "\"../parsers/texttracks/srt/html.js\""],
-  ["\<__RELATIVE_PATH__\.HTML_TTML\>", "\"../parsers/texttracks/ttml/html/index.js\""],
-  ["\<__RELATIVE_PATH__\.HTML_SAMI\>", "\"../parsers/texttracks/sami/html.js\""],
-  ["\<__RELATIVE_PATH__\.DIRECTFILE\>", "\"../core/init/directfile.js\""],
-  ["\<__RELATIVE_PATH__\.MEDIA_ELEMENT_TRACK_CHOICE_MANAGER\>", "\"../core/api/media_element_track_choice_manager.ts\""],
-];
-
 generateBuild();
 
 /**
@@ -114,9 +54,6 @@ async function generateBuild() {
     console.log(" ⚙️  Compiling project with TypeScript...");
     await compile();
 
-    console.log(" ✍️  Replacing compile-time tokens...");
-    await setCompileTimeConstants();
-
     console.log(" 🚚 Moving built code to its final directory...");
     await fs.rename(TMP_BUILD_DIR, BUILD_DIR);
 
@@ -160,65 +97,6 @@ async function compile() {
     );
 }
 
-/**
- * Now the ugliest part.
- * Our TypeScript files contains multiple compile-time constants which is not
- * something that TypeScript seems to handle.
- *
- * Consequently we decided for now to rely on calling find+sed instead to
- * replace those tokens post-compilation.
- *
- * This is ugly for the following reasons:
- *
- *   1. The token replacement logic is a dumb find-and-replace with no notion of
- *      the language. Here relying on tsc's AST is preferable because we would
- *      be sur that only constants are replaced and not possibly random strings.
- *
- *      To prevent most issue, we decided to give specific names to those global
- *      constants that are highly unlikely to be retrieved in other contexts.
- *
- *   2. The user has to have both `find` and `sed` installed on his/her/its
- *      computer.
- *      Not only that, he/she/it has to run either linux or MacOS.
- *      Not only that (again), an expected implementation of sed has to be found
- *      according to the OS.
- *
- * So yeah, that's risky.
- *
- * We could develop a platform-independent solution either by:
- *   - Write a plugin to TypeScript's compiler.
- *     This is the preferred solution though its API seems to be pretty instable
- *     according to its documentation, so I'm kind of afraid here that this task
- *     (which pretty much "just works" today) is going to add much more
- *     maintenance burden.
- *
- *   - Rely on NodeJS tools. Here the quality seems to not be there from what
- *     I've seen (I found mostly very slow tools).
- *
- * For now, my current strategy is to wait until the current logic explodes
- * (e.g. causes issues on a dev's computer)!
- *
- * @returns {Promise}
- */
-async function setCompileTimeConstants() {
-  switch (os.type()) {
-    case "Darwin":
-      // MacOS:
-      // MacOS comes with the BSD version of some command line tools, which are
-      // slightly different from the Linux version. The -i argument on sed
-      // doesn't work with a zero-length extension. Thus, we declare an extension,
-      // and then delete back-up unwanted files.
-      await replaceTokensWithBsdSed();
-      break;
-    case "Linux":
-      // Linux -> let's consider that we have GNU sed here
-      await replaceTokensWithGnuSed();
-      break;
-    default:
-      throw new Error(`Cannot replace tokens: unrecognized platform "${os.type()}"`);
-  }
-}
-
 /**
  * @returns {Promise}
  */
@@ -256,72 +134,6 @@ function removeFile(fileName) {
   });
 }
 
-/**
- * @returns {Promise}
- */
-async function replaceTokensWithBsdSed() {
-  const sedExecCommand =
-    "sed -i.DELETE -E \"" +
-    REPLACED_TOKENS_SED_REGXP.reduce((acc, val, idx) => {
-      const escapedToken = val[0]
-        .replace(/\</g, "[[:<:]]") // starting word boundary
-        .replace(/\>/g, "[[:>:]]") // ending word boundary
-        .replace(/\\/g, "\\\\") // \ by \\ (double escape because in string)
-        .replace(/\//g, "\\\\/") // / by \\/ (/ is the sed separator)
-        .replace(/"/g, "\\\""); // " by \"
-      const escapedReplacement = val[1]
-        .replace(/\\/g, "\\\\")
-        .replace(/\//g, "\\\\/")
-        .replace(/"/g, "\\\"");
-      if (idx < REPLACED_TOKENS_SED_REGXP.length - 1) {
-        return acc + `s/${escapedToken}/${escapedReplacement}/g; `
-      } else {
-        return acc + `s/${escapedToken}/${escapedReplacement}/g" '{}' \\;`;
-      }
-    }, "");
-  await spawnProm(
-    `find "${TMP_BUILD_DIR}" -type f -iname '*.js' -exec ${sedExecCommand}`,
-    [],
-    (code) => new Error(`Token-replacement process exited with code ${code}`),
-  );
-  await spawnProm(
-    `find  "${TMP_BUILD_DIR}" -type f -name "*.DELETE" -delete`,
-    [],
-    (code) => new Error(`Token-replacement cleaning process exited with code ${code}`),
-  );
-}
-
-/**
- * @returns {Promise}
- */
-async function replaceTokensWithGnuSed() {
-  const sedExecCommand =
-    "sed -i -E \"" +
-    REPLACED_TOKENS_SED_REGXP.reduce((acc, val, idx) => {
-      const escapedToken = val[0]
-        .replace(/\</g, "\\b") // starting word boundary
-        .replace(/\>/g, "\\b") // ending word boundary
-        .replace(/\\/g, "\\\\") // \ by \\ (double escape because in string)
-        .replace(/\//g, "\\\\/") // / by \\/ (/ is the sed separator)
-        .replace(/"/g, "\\\""); // " by \"
-      const escapedReplacement = val[1]
-        .replace(/\\/g, "\\\\")
-        .replace(/\//g, "\\\\/")
-        .replace(/"/g, "\\\"");
-      if (idx < REPLACED_TOKENS_SED_REGXP.length - 1) {
-        return acc + `s/${escapedToken}/${escapedReplacement}/g; `
-      } else {
-        return acc + `s/${escapedToken}/${escapedReplacement}/g" '{}' \\;`;
-      }
-    }, "");
-
-  await spawnProm(
-    `find "${TMP_BUILD_DIR}" -type f -iname '*.js' -exec ${sedExecCommand}`,
-    [],
-    (code) => new Error(`Token-replacement process exited with code ${code}`),
-  );
-}
-
 /**
  * @param {string} command
  * @param {Array.<string>} args
@@ -372,7 +184,7 @@ async function replaceTokensInTemplates(fileDest) {
       await spawnProm(
         `find  "${fileDest}" -type f -name "*.DELETE" -delete`,
         [],
-        (code) => new Error(`Template cleaning process exited with code ${cleaningCode}`),
+        (code) => new Error(`Template cleaning process exited with code ${code}`),
       );
 
     case "Linux":

package/scripts/doc-generator/construct_table_of_contents.js

@@ -5,15 +5,13 @@
  * @param {string} md - The markdown content
  * @returns {string}
  */
-module.exports = function constructTableOfContents(md) {
+function constructTableOfContents(md) {
   const tocLines = [];
   const newContent = [];
   const lines = md.split(/\r\n|\n|\r/);
 
-  // Objects used to avoid duplicates
-  const generatedTitleURIs = {};
-  const generatedChapterURIs = {};
-  const generatedSubchapterURIs = {};
+  // Object used to avoid duplicates
+  const generatedAnchors = {};
 
   // The inputed markdown is read line by line.
   // When a h1, h2 or h3 is encountered in it, add a new list entry
@@ -22,18 +20,14 @@ module.exports = function constructTableOfContents(md) {
   // add `<a>` links just before the corresponding h1, h2 or h3 elements in the
   // inputed markdown.
   // All Markdown parsing done here corresponds to the CommonMark spec (v0.29)
-  // TODO this should be much more efficient and less error-prone if integrated
-  // as a markdown-it plugin.
+  // TODO this might be more efficient and less error-prone if integrated as a
+  // markdown-it plugin.
   for (let i = 0, len = lines.length; i < len; i++) {
     if (/^ *# +/.test(lines[i])) {
       const regExec = /^ *# +(.*)$/.exec(lines[i]);
       if (regExec && regExec[1]) {
         const tocLine = regExec[1].replace(/ #* *$/, "").trim();
-        let uri = "title-" + encodeURI(tocLine);
-        while (generatedTitleURIs[uri] === true) {
-          uri += "-bis";
-        }
-        generatedTitleURIs[uri] = true;
+        let uri = generateAnchorName(tocLine);
         tocLines.push(`[${tocLine}](#${uri})`);
         newContent.push(`<a name="${uri}"></a>`);
       }
@@ -41,11 +35,7 @@ module.exports = function constructTableOfContents(md) {
       const regExec = /^ *## +(.*)$/.exec(lines[i]);
       if (regExec && regExec[1]) {
         const tocLine = regExec[1].replace(/ #* *$/, "").trim();
-        let uri = "chapter-" + encodeURI(tocLine);
-        while (generatedChapterURIs[uri] === true) {
-          uri += "-bis";
-        }
-        generatedChapterURIs[uri] = true;
+        let uri = generateAnchorName(tocLine);
         tocLines.push(`  - [${tocLine}](#${uri})`);
         newContent.push(`<a name="${uri}"></a>`);
       }
@@ -53,17 +43,34 @@ module.exports = function constructTableOfContents(md) {
       const regExec = /^ *### +(.*)$/.exec(lines[i]);
       if (regExec && regExec[1]) {
         const tocLine = regExec[1].replace(/ #* *$/, "").trim();
-        let uri = "subchapter-" + encodeURI(tocLine);
-        while (generatedSubchapterURIs[uri] === true) {
-          uri += "-bis";
-        }
-        generatedSubchapterURIs[uri] = true;
+        let uri = generateAnchorName(tocLine);
         tocLines.push(`    - [${tocLine}](#${uri})`);
         newContent.push(`<a name="${uri}"></a>`);
       }
     }
     newContent.push(lines[i]);
   }
-  return { toc: tocLines.join("\n"),
-           content: newContent.join("\n") };
+  return {
+    tocMd: tocLines.join("\n"),
+    nbTocElements: tocLines.length,
+    content: newContent.join("\n"),
+  };
+
+  function generateAnchorName(title) {
+    const baseUri = encodeURI(title.toLowerCase().replace(/ /g, "_"))
+    if (generatedAnchors[baseUri] !== true) {
+      generatedAnchors[baseUri] = true;
+      return baseUri;
+    }
+    let i = 1;
+    let resultUri;
+    do {
+      resultUri = `${baseUri}_(${i})`;
+      i++;
+    } while (generatedAnchors[resultUri] === true);
+    generatedAnchors[resultUri] = true;
+    return resultUri;
+  }
 };
+
+module.exports = constructTableOfContents;

package/scripts/doc-generator/convert_MD_to_HMTL.js

@@ -1,11 +1,12 @@
 const hljs = require("highlight.js");
-const emoji = require("markdown-it-emoji");
 const md = require("markdown-it")({
-  highlight: function (str, lang) {
+  highlight(str, lang) {
     if (lang && hljs.getLanguage(lang)) {
       try {
         return hljs.highlight(str, { language: lang }).value;
-      } catch (_) {}
+      } catch (_) {
+        /* don't care for now */
+      }
     }
     return "";
   },
@@ -15,11 +16,6 @@ const md = require("markdown-it")({
   xhtmlOut: true,
 });
 
-md.use(emoji);
-md.renderer.rules.emoji = function(token, idx) {
-  return `<span class="emoji emoji_${token[idx].markup}">${token[idx].content}</span>`;
-};
-
 /**
  * Convert the Markdown document given into an HTML page.
  * @param {string} mdStr