Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Install the alpha branch of frontend build

    • npm install @edx/frontend-build@alpha

  • Add a tsconfig.json file to the top-level of your app

    • Code Block
      languagejson
      {
        "extends": "@edx/typescript-config",
        "compilerOptions": {
          "rootDir": ".",
          "outDir": "dist",
          "baseUrl": "./src",
          "paths": {
            "*": ["*"]
          }
        },
        "include": ["src/**/*"],
        "exclude": ["dist", "node_modules"]
      }
  • Update commitlint job (.github/workflows/commitlint.yml) to remove the tsconfig when running

    • See issue https://github.com/conventional-changelog/commitlint/issues/3256

    • Code Block
      languageyaml
      # Run commitlint on the commit messages in a pull request.
      
      name: Lint Commit Messages
      
      on:
        - pull_request
      
      jobs:
        commitlint:
          runs-on: ubuntu-20.04
          steps:
            - name: Check out repository
              uses: actions/checkout@v3
              with:
                fetch-depth: 0
            - name: remove tsconfig.json # see issue https://github.com/conventional-changelog/commitlint/issues/3256
              run: |
                rm -f tsconfig.json
            - name: Check commits
              uses: wagoid/commitlint-github-action@v5

...