ci(docs): linting and formatting (#1403)

* ci: eslint and prettier

* fix: eslint issues

* fix: prettier issues

* ci: add workflow

* ci: fix doc check

* ci: update linter configs

* docs: formatting fixes

.github/workflows/command_doc_check.yml

@@ -22,5 +22,25 @@ jobs:
           go-version: 1.21
       - name: Generate command docs
         run: go run ./scripts/gen-doc-yaml.go
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "16"
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        working-directory: ./docs
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: Install dependencies
+        run: npm ci
+        working-directory: ./docs
+      - name: prettier
+        run: npm run prettier:fix
+        working-directory: ./docs
+      - name: Pick up any new files
+        run: git add .
       - name: Check no uncommited changes
         run: git diff --exit-code

.github/workflows/e2e_test.yml

@@ -8,6 +8,8 @@ on:
       - opened
       - synchronize
       - reopened
+    paths-ignore:
+      - 'docs/**'
 permissions:
   contents: read
 jobs:

.github/workflows/lint.yml

@@ -5,6 +5,8 @@ on:
       - opened
       - synchronize
       - reopened
+    paths-ignore:
+      - 'docs/**'
 permissions:
   contents: read
 jobs:

.github/workflows/lint_docs.yml

@@ -0,0 +1,38 @@
+name: Lint Docs
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+    paths:
+      - 'docs/**'
+permissions:
+  contents: read
+jobs:
+  lint:
+    defaults:
+      run:
+        working-directory: docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "16"
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: Install dependencies
+        run: npm ci
+      - name: eslint
+        run: npm run lint
+      - name: prettier
+        run: npm run prettier
+

.github/workflows/test.yml

@@ -8,6 +8,8 @@ on:
       - opened
       - synchronize
       - reopened
+    paths-ignore:
+      - 'docs/**'
 permissions:
   contents: read
 jobs:

docs/.eleventy.js

@@ -23,7 +23,7 @@ const mdSetup = markdownIt({ html: true })
 mdSetup.renderer.rules.code_inline = (tokens, idx, { langPrefix = "" }) => {
   const token = tokens[idx]
   return `<code class="${langPrefix}">${mdSetup.utils.escapeHtml(
-    token.content
+    token.content,
   )}</code>`
 }
 
@@ -66,7 +66,7 @@ module.exports = function (eleventyConfig) {
   eleventyConfig.addShortcode("yamlExample", function (exampleName) {
     const example = fs.readFileSync(
       `./_data/examples/${exampleName}.yaml`,
-      "utf8"
+      "utf8",
     )
     return "```yaml\n" + example + "\n```"
   })
@@ -122,7 +122,8 @@ module.exports = function (eleventyConfig) {
   })
   eleventyConfig.addFilter("deduplicate", (arr) => {
     const result = arr.filter(
-      (value, index, self) => index === self.findIndex((t) => t.id === value.id)
+      (value, index, self) =>
+        index === self.findIndex((t) => t.id === value.id),
     )
     return result
   })
@@ -218,7 +219,7 @@ module.exports = function (eleventyConfig) {
       return `<div class="elv-callout${
         level ? ` elv-callout-${level}` : ""
       }">${labelHtml}${contentHtml}</div>`
-    }
+    },
   )
 
   return {

docs/.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  env: {
+    browser: true,
+    commonjs: true,
+    es2021: true,
+    node: true,
+  },
+  extends: ["standard", "prettier"],
+  parserOptions: {
+    ecmaVersion: "latest",
+  },
+}

docs/404.md

@@ -12,4 +12,4 @@ Sorry, but we couldn't find the page you were looking for.
 - Want to get started right away? Head over to the [quick start guide](/quickstart/).
 - Bearer CLI detects [all sorts of data types](/reference/datatypes/) and has [built-in rules](/reference/rules/) to check for data security risks.
 
-If you're looking for help using Bearer CLI, you can [create a new issue on GitHub]({{meta.links.issues}}) or join our [discord community]({{meta.links.discord}}).
+If you're looking for help using Bearer CLI, you can [create a new issue on GitHub]({{meta.links.issues}}) or join our [discord community]({{meta.links.discord}}).

docs/_data/bearer.yaml

@@ -1,13 +1,13 @@
 name: bearer
 options:
-    - name: help
-      shorthand: h
-      default_value: "false"
-      usage: help for bearer
+  - name: help
+    shorthand: h
+    default_value: "false"
+    usage: help for bearer
 see_also:
-    - bearer completion - Generate the autocompletion script for the your shell.
-    - bearer ignore - Manage ignored fingerprints
-    - bearer init - Generates a default config to `bearer.yml`
-    - bearer scan - Scan a directory or file
-    - bearer version - Print the version
-aliases: 
+  - bearer completion - Generate the autocompletion script for the your shell.
+  - bearer ignore - Manage ignored fingerprints
+  - bearer init - Generates a default config to `bearer.yml`
+  - bearer scan - Scan a directory or file
+  - bearer version - Print the version
+aliases:

docs/_data/bearerAction.js

@@ -1,20 +1,20 @@
-const EleventyFetch = require("@11ty/eleventy-fetch");
-const yaml = require("js-yaml");
+const EleventyFetch = require("@11ty/eleventy-fetch")
+const yaml = require("js-yaml")
 module.exports = async function () {
-  let action;
+  let action
   try {
     const response = await EleventyFetch(
       "https://raw.githubusercontent.com/Bearer/bearer-action/main/action.yml",
       {
         duration: "60m",
         type: "text",
-      }
-    );
-    action = yaml.load(response);
+      },
+    )
+    action = yaml.load(response)
   } catch (err) {
-    console.log("Could not fetch release");
+    console.log("Could not fetch release")
   }
   return {
     ...action,
-  };
-};
+  }
+}

docs/_data/bearer_completion.yaml

@@ -2,10 +2,10 @@ name: bearer completion
 synopsis: Generate the autocompletion script for the your shell.
 usage: bearer completion [command]
 options:
-    - name: help
-      shorthand: h
-      default_value: "false"
-      usage: help for completion
+  - name: help
+    shorthand: h
+    default_value: "false"
+    usage: help for completion
 see_also:
-    - 'bearer - '
-aliases: 
+  - "bearer - "
+aliases:

docs/_data/bearer_ignore_add.yaml

@@ -2,54 +2,54 @@ name: bearer ignore add
 synopsis: Add an ignored fingerprint
 usage: bearer ignore add <fingerprint> [flags]
 options:
-    - name: api-key
-      usage: Use your Bearer API Key to send the report to Bearer.
-    - name: author
-      shorthand: a
-      usage: |
-        Add author information to this ignored finding. (default output of "git config user.name")
-    - name: comment
-      usage: Add a comment to this ignored finding.
-    - name: config-file
-      default_value: bearer.yml
-      usage: Load configuration from the specified path.
-    - name: debug
-      default_value: "false"
-      usage: Enable debug logs. Equivalent to --log-level=debug
-    - name: debug-profile
-      default_value: "false"
-      usage: Generate profiling data for debugging
-    - name: disable-version-check
-      default_value: "false"
-      usage: Disable Bearer version checking
-    - name: false-positive
-      default_value: "false"
-      usage: Mark an this ignored finding as false positive.
-    - name: force
-      default_value: "false"
-      usage: Overwrite an existing ignored finding.
-    - name: help
-      shorthand: h
-      default_value: "false"
-      usage: help for add
-    - name: host
-      default_value: my.bearer.sh
-      usage: Specify the Host for sending the report.
-    - name: ignore-file
-      default_value: bearer.ignore
-      usage: Load ignore file from the specified path.
-    - name: ignore-git
-      default_value: "false"
-      usage: Ignore Git listing
-    - name: log-level
-      default_value: info
-      usage: Set log level (error, info, debug, trace)
-    - name: no-color
-      default_value: "false"
-      usage: Disable color in output
+  - name: api-key
+    usage: Use your Bearer API Key to send the report to Bearer.
+  - name: author
+    shorthand: a
+    usage: |
+      Add author information to this ignored finding. (default output of "git config user.name")
+  - name: comment
+    usage: Add a comment to this ignored finding.
+  - name: config-file
+    default_value: bearer.yml
+    usage: Load configuration from the specified path.
+  - name: debug
+    default_value: "false"
+    usage: Enable debug logs. Equivalent to --log-level=debug
+  - name: debug-profile
+    default_value: "false"
+    usage: Generate profiling data for debugging
+  - name: disable-version-check
+    default_value: "false"
+    usage: Disable Bearer version checking
+  - name: false-positive
+    default_value: "false"
+    usage: Mark an this ignored finding as false positive.
+  - name: force
+    default_value: "false"
+    usage: Overwrite an existing ignored finding.
+  - name: help
+    shorthand: h
+    default_value: "false"
+    usage: help for add
+  - name: host
+    default_value: my.bearer.sh
+    usage: Specify the Host for sending the report.
+  - name: ignore-file
+    default_value: bearer.ignore
+    usage: Load ignore file from the specified path.
+  - name: ignore-git
+    default_value: "false"
+    usage: Ignore Git listing
+  - name: log-level
+    default_value: info
+    usage: Set log level (error, info, debug, trace)
+  - name: no-color
+    default_value: "false"
+    usage: Disable color in output
 example: |-
-    # Add an ignored fingerprint to your ignore file
-    $ bearer ignore add <fingerprint> --author Mish --comment "Possible false positive"
+  # Add an ignored fingerprint to your ignore file
+  $ bearer ignore add <fingerprint> --author Mish --comment "Possible false positive"
 see_also:
-    - bearer ignore - Manage ignored fingerprints
-aliases: 
+  - bearer ignore - Manage ignored fingerprints
+aliases: