feat: initial setup

patternfly · Sep 12, 2024 · de8d356 · de8d356
commit de8d356
Show file tree

Hide file tree

Showing 42 changed files with 13,526 additions and 0 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,35 @@
+# Javascript builds
+node_modules
+dist
+tsc_out
+.out
+.changelog
+.DS_Store
+coverage
+.cache
+.tmp
+.eslintcache
+generated
+
+# package managers
+yarn-error.log
+lerna-debug.log
+
+# IDEs and editors
+.idea
+.project
+.classpath
+.c9
+*.launch
+.settings
+*.sublime-workspace
+.history
+.vscode
+.yo-rc.json
+
+# IDE - VSCode
+.vscode
+# For vim
+*.swp
+
+public
diff --git a/.eslintrc-md.json b/.eslintrc-md.json
@@ -0,0 +1,34 @@
+{
+  "plugins": ["markdown", "react"],
+  "parserOptions": {
+    "ecmaVersion": 9,
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "settings": {
+    "react": {
+      "version": "18"
+    }
+  },
+  "overrides": [
+    {
+      "files": ["**/*.md"],
+      "processor": "markdown/markdown"
+    },
+    {
+      "files": ["**/*.md/*.js", "**/*.md/*.jsx", "**/*.md/*.ts", "**/*.md/*.tsx"],
+      "rules": {
+        "eol-last": 2,
+        "spaced-comment": 2,
+        "no-unused-vars": 0,
+        "no-this-before-super": 2,
+        "react/jsx-uses-react": "error",
+        "react/jsx-uses-vars": "error",
+        "react/no-unknown-property": 2,
+        "react/jsx-no-undef": 2
+      }
+    }
+  ]
+}
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,98 @@
+{
+  "env": {
+    "browser": true,
+    "node": true,
+    "es6": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:react-hooks/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "overrides": [
+    {
+      "files": ["**/patternfly-docs/pages/*"],
+      "rules": {
+        "arrow-body-style": "off"
+      }
+    }
+  ],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
+  },
+  "plugins": ["react", "react-hooks", "@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/adjacent-overload-signatures": "error",
+    "@typescript-eslint/array-type": "error",
+    "@typescript-eslint/consistent-type-assertions": "error",
+    "@typescript-eslint/consistent-type-definitions": "error",
+    "@typescript-eslint/no-misused-new": "error",
+    "@typescript-eslint/no-namespace": "error",
+    "@typescript-eslint/no-require-imports": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "^_"
+      }
+    ],
+    "@typescript-eslint/prefer-for-of": "error",
+    "@typescript-eslint/prefer-function-type": "error",
+    "@typescript-eslint/prefer-namespace-keyword": "error",
+    "@typescript-eslint/unified-signatures": "error",
+    "@typescript-eslint/no-var-requires": "off",
+    "arrow-body-style": "error",
+    "camelcase": [
+      "error",
+      {
+        "ignoreDestructuring": true
+      }
+    ],
+    "constructor-super": "error",
+    "curly": "error",
+    "dot-notation": "error",
+    "eqeqeq": ["error", "smart"],
+    "guard-for-in": "error",
+    "max-classes-per-file": ["error", 1],
+    "no-nested-ternary": "error",
+    "no-bitwise": "error",
+    "no-caller": "error",
+    "no-cond-assign": "error",
+    "no-console": "error",
+    "no-debugger": "error",
+    "no-empty": "error",
+    "no-eval": "error",
+    "no-new-wrappers": "error",
+    "no-undef-init": "error",
+    "no-unsafe-finally": "error",
+    "no-unused-expressions": [
+      "error",
+      {
+        "allowTernary": true,
+        "allowShortCircuit": true
+      }
+    ],
+    "no-unused-labels": "error",
+    "no-var": "error",
+    "object-shorthand": "error",
+    "one-var": ["error", "never"],
+    "prefer-const": "error",
+    "radix": ["error", "as-needed"],
+    "react/prop-types": 0,
+    "react/display-name": 0,
+    "react-hooks/exhaustive-deps": "warn",
+    "react/no-unescaped-entities": ["error", { "forbid": [">", "}"] }],
+    "spaced-comment": "error",
+    "use-isnan": "error"
+  }
+}
diff --git a/.github/workflows/build-lint-test.yml b/.github/workflows/build-lint-test.yml
@@ -0,0 +1,159 @@
+name: build-lint-test
+on:
+  workflow_call:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      GH_PR_NUM: ${{ github.event.number }}
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          if [[ ! -z "${GH_PR_NUM}" ]]; then 
+            echo "Checking out PR"
+            git fetch origin pull/$GH_PR_NUM/head:tmp
+            git checkout tmp
+          fi
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - uses: actions/cache@v4
+        id: yarn-cache
+        name: Cache npm deps
+        with:
+          path: |
+           node_modules
+           **/node_modules
+          key: ${{ runner.os }}-yarn-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('yarn.lock') }}
+      - run: yarn install --frozen-lockfile
+        if: steps.yarn-cache.outputs.cache-hit != 'true'
+      - uses: actions/cache@v4
+        id: dist
+        name: Cache dist
+        with:
+          path: |
+            packages/*/dist
+          key: ${{ runner.os }}-dist-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('yarn.lock', 'package.json', 'packages/*/*', '!packages/*/dist', '!packages/*/node_modules') }}
+      - name: Build dist
+        run: yarn build
+        if: steps.dist.outputs.cache-hit != 'true'
+  lint:
+    runs-on: ubuntu-latest
+    env:
+      GH_PR_NUM: ${{ github.event.number }}
+    needs: build
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          if [[ ! -z "${GH_PR_NUM}" ]]; then 
+            echo "Checking out PR"
+            git fetch origin pull/$GH_PR_NUM/head:tmp
+            git checkout tmp
+          fi
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - uses: actions/cache@v4
+        id: yarn-cache
+        name: Cache npm deps
+        with:
+          path: |
+           node_modules
+           **/node_modules
+          key: ${{ runner.os }}-yarn-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('yarn.lock') }}
+      - run: yarn install --frozen-lockfile
+        if: steps.yarn-cache.outputs.cache-hit != 'true'
+      - uses: actions/cache@v4
+        id: lint-cache
+        name: Load lint cache
+        with:
+          path: '.eslintcache'
+          key: ${{ runner.os }}-lint-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('yarn.lock') }}
+      - name: ESLint
+        run: yarn lint:js
+      - name: MDLint
+        run: yarn lint:md
+  test_jest:
+    runs-on: ubuntu-latest
+    env:
+      GH_PR_NUM: ${{ github.event.number }}
+    needs: build
+    steps:
+      - uses: actions/checkout@v4
+      # Yes, we really want to checkout the PR
+      - run: |
+          if [[ ! -z "${GH_PR_NUM}" ]]; then 
+            echo "Checking out PR"
+            git fetch origin pull/$GH_PR_NUM/head:tmp
+            git checkout tmp
+          fi
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - uses: actions/cache@v4
+        id: yarn-cache
+        name: Cache npm deps
+        with:
+          path: |
+           node_modules
+           **/node_modules
+           ~/.cache/Cypress
+          key: ${{ runner.os }}-yarn-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('yarn.lock') }}
+      - run: yarn install --frozen-lockfile
+        if: steps.yarn-cache.outputs.cache-hit != 'true'
+      - uses: actions/cache@v4
+        id: dist
+        name: Cache dist
+        with:
+          path: |
+            packages/*/dist
+            packages/react-styles/css
+          key: ${{ runner.os }}-dist-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('yarn.lock', 'package.json', 'packages/*/*', '!packages/*/dist', '!packages/*/node_modules') }}
+      - name: Build dist
+        run: yarn build
+        if: steps.dist.outputs.cache-hit != 'true'
+      - name: PF6 Jest Tests
+        run: yarn test --maxWorkers=2
+  test_a11y:
+    runs-on: ubuntu-latest
+    env:
+      GH_PR_NUM: ${{ github.event.number }}
+    needs: build
+    steps:
+      - uses: actions/checkout@v4
+      # Yes, we really want to checkout the PR
+      - run: |
+          if [[ ! -z "${GH_PR_NUM}" ]]; then 
+            echo "Checking out PR"
+            git fetch origin pull/$GH_PR_NUM/head:tmp
+            git checkout tmp
+          fi
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - uses: actions/cache@v4
+        id: yarn-cache
+        name: Cache npm deps
+        with:
+          path: |
+           node_modules
+           **/node_modules
+           ~/.cache/Cypress
+          key: ${{ runner.os }}-yarn-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('yarn.lock') }}
+      - run: yarn install --frozen-lockfile
+        if: steps.yarn-cache.outputs.cache-hit != 'true'
+      - uses: actions/cache@v4
+        id: dist
+        name: Cache dist
+        with:
+          path: |
+            packages/*/dist
+            packages/react-styles/css
+          key: ${{ runner.os }}-dist-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('yarn.lock', 'package.json', 'packages/*/*', '!packages/*/dist', '!packages/*/node_modules') }}
+      - name: Build dist
+        run: yarn build
+        if: steps.dist.outputs.cache-hit != 'true'
+      - name: Build docs
+        run: yarn build:docs
+      - name: A11y tests
+        run: yarn serve:docs & yarn test:a11y
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,55 @@
+name: build
+on:
+  workflow_call:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      GH_PR_NUM: ${{ github.event.number }}
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          if [[ ! -z "${GH_PR_NUM}" ]]; then 
+            echo "Checking out PR"
+            git fetch origin pull/$GH_PR_NUM/head:tmp
+            git checkout tmp
+          fi
+      - uses: actions/cache@v4
+        id: setup-cache
+        name: Cache setup
+        with:
+          path: |
+            README.md
+            package.json
+            .tmplr.yml
+            packages/*/package.json
+            packages/*/patternfly-docs/content/**
+            packages/*/patternfly-docs/generated/**
+          key: ${{ runner.os }}-setup-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('package.json', 'packages/module/package.json') }}
+      - name: Run build script
+        run: ./devSetup.sh
+        shell: bash
+        if: steps.setup-cache.outputs.cache-hit != 'true'
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - uses: actions/cache@v4
+        id: yarn-cache
+        name: Cache npm deps
+        with:
+          path: |
+           node_modules
+           **/node_modules
+          key: ${{ runner.os }}-yarn-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('yarn.lock') }}
+      - run: yarn install --frozen-lockfile
+        if: steps.yarn-cache.outputs.cache-hit != 'true'
+      - uses: actions/cache@v4
+        id: dist
+        name: Cache dist
+        with:
+          path: |
+            packages/*/dist
+          key: ${{ runner.os }}-dist-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('yarn.lock', 'package.json', 'packages/*/*', '!packages/*/dist', '!packages/*/node_modules') }}
+      - name: Build dist
+        run: yarn build
+        if: steps.dist.outputs.cache-hit != 'true'
diff --git a/.github/workflows/check-pr.yml b/.github/workflows/check-pr.yml
@@ -0,0 +1,8 @@
+name: check-pr
+on:
+  pull_request:
+    branches:
+      - main
+jobs:
+  call-build-lint-test-workflow:
+    uses: ./.github/workflows/build-lint-test.yml