Add prettier and CI

Quick addition to add prettier and a CI doing:
  1. style checking through prettier
  1. type checking through typescript
  1. linting through eslint

This is to prevent issues and to facilitate development.

Author: peaBerberian

.github/workflows/checks.yml

@@ -0,0 +1,45 @@
+name: README Tests
+
+on:
+  push:
+    branches: [stable, dev, legacy-v3]
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  format_check:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+
+      - run: npm ci
+      - run: npm run fmt
+
+  typechecking_and_linting:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - run: npm ci
+      - run: npm run check:types && npm run lint

.prettierrc

@@ -1,3 +1,4 @@
 {
+  "printWidth": 80,
   "proseWrap": "always"
 }

CHANGELOG.md

@@ -2,82 +2,82 @@
 
 ## Other
 
--   Stop transforming various tokens (like `(c)` for the copyright logo or `...` for the ellipsis)
+- Stop transforming various tokens (like `(c)` for the copyright logo or `...`
+  for the ellipsis)
 
 # v0.4.0 (2024-01-29)
 
 ## Breaking Changes
 
--   Total overhaul of CLI tool options and of the JavaScript API
--   Update anchor syntax rule to make it more compatibe to GitHub's and GitLab's
-    own generator
--   In local configurations, remove otherVersionsLink in profit of version.link
+- Total overhaul of CLI tool options and of the JavaScript API
+- Update anchor syntax rule to make it more compatibe to GitHub's and GitLab's
+  own generator
+- In local configurations, remove otherVersionsLink in profit of version.link
 
 ## Features
 
--   Check validity of anchor links and display verbose warning when not
-    available
--   Add `defaultOpen` property to page groups in local configurations
--   Add `clean` JS and CLI option
--   Authorize http(s) url in media resources
+- Check validity of anchor links and display verbose warning when not available
+- Add `defaultOpen` property to page groups in local configurations
+- Add `clean` JS and CLI option
+- Authorize http(s) url in media resources
 
 ## Bug fixes
 
--   Pages: Avoid hiding header when content is not scrollable
--   Fix false positives in table of contents generation
--   Make search also work for text without the right header hierarchy
+- Pages: Avoid hiding header when content is not scrollable
+- Fix false positives in table of contents generation
+- Make search also work for text without the right header hierarchy
 
 ## Other
 
--   Forbid copy of local media resources not inside the root directory for
-    security
--   Pages: content is now centered and has a higher minimal width
--   Pages: don't underline the version number if there's no link
--   Add documentation pages for README
--   Stop generating XHTML as output
+- Forbid copy of local media resources not inside the root directory for
+  security
+- Pages: content is now centered and has a higher minimal width
+- Pages: don't underline the version number if there's no link
+- Add documentation pages for README
+- Stop generating XHTML as output
 
 # v0.3.0 (2023-11-22)
 
 ## Other
 
--   Rename project to README, and move it under a canalplus scope on npm to
-    facilitate inside contributions
+- Rename project to README, and move it under a canalplus scope on npm to
+  facilitate inside contributions
 
 # v0.2.3 (2023-04-21)
 
 ## Bug fixes
 
--   Fix multiple quick smooth navigation between inner links
+- Fix multiple quick smooth navigation between inner links
 
 # v0.2.2 (2023-04-20)
 
 ## Bug fixes
 
--   Fix documentation page's script soft navigation
+- Fix documentation page's script soft navigation
 
 # v0.2.1 (2023-04-19)
 
 ## Bug fixes
 
--   Fix header links when navigating in sub directories
+- Fix header links when navigating in sub directories
 
 # v0.2.0 (2023-04-15)
 
 ## Features
 
--   Rewrote in TypeScript with now type declarations
--   NodeJS API (as an import and no more as a script)
+- Rewrote in TypeScript with now type declarations
+- NodeJS API (as an import and no more as a script)
 
 ## Bug fixes
 
--   Remove mention of "RxPlayer" in page titles
--   Various minor CSS fixes
+- Remove mention of "RxPlayer" in page titles
+- Various minor CSS fixes
 
 # v0.1.1 (2023-04-07)
 
 ## Bug fixes
 
--   Fix placement of search icon
+- Fix placement of search icon
 
 # v0.1.0 (2023-04-06)
 

README.md

@@ -38,7 +38,8 @@ at the
 and compare it to its
 [original markdown files](https://github.com/canalplus/rx-player/tree/master/doc/Getting_Started).
 
-You can also look at [README's own documentation](https://peaberberian.github.io/README/doc/Getting_Started/Home.html)
+You can also look at
+[README's own documentation](https://peaberberian.github.io/README/doc/Getting_Started/Home.html)
 and compare it to its
 [original markdown files](https://github.com/canalplus/README/tree/main/doc/Getting_Started).
 
@@ -68,7 +69,8 @@ readme.doc --version
 
 ## How to use it
 
-See our [complete documentation](https://peaberberian.github.io/README/doc/Getting_Started/Home.html)
+See our
+[complete documentation](https://peaberberian.github.io/README/doc/Getting_Started/Home.html)
 (which is itself generated with README :)!)
 
 ## Why a new documentation generator

package-lock.json

@@ -9,8 +9,10 @@
   "main": "build/index.js",
   "scripts": {
     "build": "npm run generateVersionFile && tsc",
+    "check:types": "tsc --noEmit --project .",
     "clean": "rimraf doc-build",
     "doc": "node build/index.js --clean --input doc --output doc-build -p `npm run --silent getVersion`",
+    "fmt": "prettier --write .",
     "generateVersionFile": "echo \"export default \\\"$(npm --silent run getVersion)\\\";\" > src/version.ts",
     "getVersion": "node -e \"console.log(require('./package.json').version)\"",
     "lint": "eslint src/**",
@@ -37,7 +39,7 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jsdoc": "^48.0.4",
-    "prettier": "^3.2.4",
+    "prettier": "^3.4.2",
     "typescript": "^5.3.3"
   },
   "types": "./build/index.d.ts"

package.json

@@ -74,7 +74,7 @@ export default class AnchorChecker {
   public addAnchorReference(
     inputFileWithLink: string,
     inputFileLinkDestination: string,
-    anchor: string
+    anchor: string,
   ): void {
     this._anchorsList.push({
       inputFileWithLink,
@@ -94,7 +94,7 @@ export default class AnchorChecker {
     for (const elt of this._anchorsList) {
       const validity = this.checkValidAnchor(
         elt.inputFileLinkDestination,
-        elt.anchor
+        elt.anchor,
       );
       if (validity !== AnchorValidity.Found) {
         badResults.push({ ...elt, validity });