feat: build custom documentation website with next.js

.eslintignore

@@ -5,3 +5,5 @@ dist/cjs/**
 dist/esm/**
 errors.log
 .eslintrc.js
+packages/**
+apps/**

.eslintrc.js

@@ -1,106 +1,4 @@
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
-  extends: [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    "plugin:import/recommended",
-    "plugin:import/typescript",
-    "prettier",
-  ],
-  parser: "@typescript-eslint/parser",
-  plugins: ["@typescript-eslint", "import"],
-  parserOptions: {
-    project: ["./tsconfig.json", "./packages/**/tsconfig.json"],
-    // eslint-disable-next-line no-undef
-    tsconfigRootDir: __dirname,
-    sourceType: "module",
-    ecmaVersion: 2022,
-  },
-  settings: {
-    "import/parsers": {
-      "@typescript-eslint/parser": [".ts", ".tsx"],
-    },
-    "import/resolver": {
-      typescript: {
-        project: ["./tsconfig.json", "./packages/**/tsconfig.json"],
-      },
-      node: true,
-    },
-  },
-  root: true,
-  rules: {
-    "no-restricted-globals": [
-      "error",
-      "closed",
-      "event",
-      "fdescribe",
-      "name",
-      "length",
-      "location",
-      "parent",
-      "top",
-    ],
-    "no-empty-pattern": "off",
-    "no-inner-declarations": "off",
-    "no-console": "off",
-    "no-debugger": "error",
-    "no-alert": "error",
-    "no-useless-escape": "error",
-    "@typescript-eslint/require-await": "error",
-    "@typescript-eslint/no-misused-promises": "error",
-    "@typescript-eslint/naming-convention": [
-      "error",
-      {
-        selector: ["variableLike"],
-        format: ["UPPER_CASE", "StrictPascalCase", "strictCamelCase"],
-        leadingUnderscore: "allow",
-      },
-      {
-        selector: ["typeLike"],
-        format: ["StrictPascalCase"],
-      },
-    ],
-    "@typescript-eslint/consistent-type-imports": [
-      "error",
-      {
-        fixStyle: "inline-type-imports",
-      },
-    ],
-    "import/default": "error",
-    "import/no-self-import": "error",
-    "import/no-cycle": [
-      "error",
-      {
-        maxDepth: 10,
-        ignoreExternal: true,
-      },
-    ],
-    "@typescript-eslint/no-unused-vars": "error",
-    "@typescript-eslint/ban-types": "error",
-    "@typescript-eslint/ban-ts-comment": "error",
-    "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
-    "@typescript-eslint/no-inferrable-types": "error",
-    "@typescript-eslint/no-unnecessary-type-assertion": "error",
-    "@typescript-eslint/restrict-plus-operands": "error",
-    "no-multi-assign": "error",
-    "max-statements-per-line": [
-      "error",
-      {
-        max: 1,
-      },
-    ],
-    "no-case-declarations": "error",
-    "no-extra-boolean-cast": "error",
-    "prefer-const": "error",
-    "no-constant-condition": "error",
-    "@typescript-eslint/no-unsafe-return": "off",
-    "@typescript-eslint/no-explicit-any": "warn",
-    "@typescript-eslint/no-unsafe-argument": "off",
-    "import/no-named-as-default-member": "warn",
-    "import/no-named-as-default": "warn",
-    "@typescript-eslint/no-unsafe-assignment": "off",
-    "@typescript-eslint/restrict-template-expressions": "error",
-    "@typescript-eslint/no-unsafe-call": "off",
-    "@typescript-eslint/no-unsafe-member-access": "off",
-  },
+  extends: ["@wapijs/eslint-config/config.node.js"],
 };

.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discord server
+    url: https://discord.gg/PytnZqWpeQ
+    about: Please visit our Discord server for questions and support requests.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+**Please describe the changes this PR makes and why it should be merged:**
+
+**Status and versioning classification:**

.github/workflows/documentation-build.yaml

@@ -0,0 +1,96 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - "master"
+    paths:
+      - "packages/wapi.js/**"
+    tags:
+      - "**"
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: "The branch, tag or SHA to checkout"
+        required: true
+      ref_type:
+        type: choice
+        description: "Branch or tag"
+        options:
+          - branch
+          - tag
+        required: true
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    environment: Production
+    name: Build & upload documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: User Node.js LTS
+        uses: actions/setup-node@v2
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.2.4
+        with:
+          run_install: false
+
+      - name: Install Dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build
+        run: pnpm run build
+
+      - name: Generate docs
+        run: pnpm run doc:gen
+
+      - name: Checkout docs repository
+        uses: actions/checkout@v3
+        with:
+          repository: "sarthakjdev/wapijs-docs-json"
+          token: ${{ secrets.WAPIJS_DOCS_ACCESS_TOKEN }}
+          path: "out"
+
+      - name: Extract package and semver from tag
+        if: ${{ github.ref_type == 'tag' }}
+        id: extract-tag
+        uses: ./format-tag
+        with:
+          tag: ${{ github.ref_name }}
+
+      - name: Move docs to correct directory
+        if: ${{ github.ref_type == 'tag' }}
+        env:
+          PACKAGE: ${{ steps.extract-tag.outputs.package }}
+          SEMVER: ${{ steps.extract-tag.outputs.semver }}
+        run: |
+          mkdir -p "out/wapi.js"
+          mv "packages/wapi.js/docs/docs.json" "out/wapi.js/${SEMVER}.json"
+
+      - name: Move docs to correct directory
+        if: ${{ github.ref_type == 'branch' }}
+        run: |
+          input_string="$GITHUB_REF_NAME"
+          if [[ "$input_string" == *"/"* ]]; then
+              documentation_file_name=$(echo "$input_string" | cut -d'/' -f2)
+              echo "Extracted: $documentation_file_name"
+          else
+              documentation_file_name="$GITHUB_REF_NAME"
+              echo "No slash in the string, nothing to extract."
+          fi
+          mkdir -p "out/wapi.js" 
+          mv "packages/wapi.js/docs/docs.json" "out/wapi.js/${documentation_file_name}.json"
+
+      - name: Commit and push
+        run: |
+          cd out
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+          git add .
+          git commit -m "Docs build for ${GITHUB_REF_TYPE} ${GITHUB_REF_NAME}: ${GITHUB_SHA}" || true
+          git push

.github/workflows/format-tag.ts

@@ -0,0 +1,18 @@
+export function formatTag(tag: string) {
+    const parsed = /(?:^@.*\/(?<package>.*)@v?)?(?<semver>\d+.\d+.\d+)-?.*/.exec(tag);
+    const parsedPackage = /(?<package>.*)@v?-?.*/.exec(tag);
+
+    if (parsed?.groups) {
+        const isSubpackage = typeof parsed.groups.package === 'string';
+        const pkg = isSubpackage ? parsed.groups.package : parsedPackage?.groups?.package ?? 'wapi.js';
+        const semver = parsed.groups.semver;
+
+        return {
+            isSubpackage,
+            package: pkg,
+            semver,
+        };
+    }
+
+    return null;
+}

.github/workflows/release.yaml

@@ -1,84 +1,37 @@
-name: Build
-
+name: Publish Release
 on:
   release:
-
+    types: [released]
 jobs:
-  lint:
-    timeout-minutes: 10
+  npm-publish:
+    name: npm publish
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: User Node.js LTS
-        uses: actions/setup-node@v2
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v2.2.4
-        with:
-          run_install: false
-
-      - name: Install Dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Lint
-        run: pnpm run lint
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-      - name: Linter Failed
-        if: ${{ failure() }}
-        uses: actions/github-script@v5
+      - name: Install node.js v18
+        uses: actions/setup-node@v3
         with:
-          script: |
-            const { pullRequestData: data } = await github.rest.repos.listPullRequestsAssociatedWithCommit({
-                    owner: context.repo.owner,
-                    repo: context.repo.repo,
-                    commit_sha: context.payload.after
-                })
-
-              if(pullRequestData[0]){
-                 await github.rest.issues.createComment({
-                      issue_number: pullRequestData[0].number,
-                      owner: context.repo.owner,
-                      repo: context.repo.repo,
-                      body: `### 🚨  Linter failed`
-                  })
-              } else {
-                  throw new Error('Pull request data not found')
-              }
-  build:
-    runs-on: ubuntu-latest
-    needs: [lint]
-    timeout-minutes: 15
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
 
-      - name: Install Dependencies
-        run: pnpm install --frozen-lockfile
+      - name: Install dependencies
+        uses: pnpm i --prod --frozen-lockfile --ignore-scripts
 
-      - name: Build the packages
-        run: pnpm build
+      - name: Build dependencies
+        run: pnpm run build
 
-      - name: Build Failed
-        if: ${{ failure() }}
-        uses: actions/github-script@v6
+      - name: Extract package and semver from tag
+        id: extract-tag
+        uses: ./format-tag
         with:
-          script: |
-            const { data: pullRequestData } = await github.rest.repos.listPullRequestsAssociatedWithCommit({
-                  owner: context.repo.owner,
-                  repo: context.repo.repo,
-                  commit_sha: context.payload.after
-              })
+          tag: ${{ github.ref_name }}
 
-            if(pullRequestData[0]){
-               await github.rest.issues.createComment({
-                    issue_number: pullRequestData[0].number,
-                    owner: context.repo.owner,
-                    repo: context.repo.repo,
-                    body: `#### ❌ Build failed:
-            `
-                })
-            } else {
-              throw new Error('Pull request data not found')
-            }
+      - name: Publish package
+        run: |
+          pnpm --filter=${{ steps.extract-tag.outputs.subpackage == 'true' && '@wapijs/' || '' }}${{ steps.extract-tag.outputs.package }} publish --provenance --no-git-checks
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }}