janus-idp / janus-idp.github.io

Other
13 stars 27 forks source link

chore(meta): fix lint staged issues #312

Closed BethGriggs closed 4 days ago

BethGriggs commented 1 week ago

What does this PR do / why we need it

Existing lint-staged has issues due to the directory in which it is running, which can result in the following error locally:

docusaurus-plugin-tailwind:lint: 
docusaurus-plugin-tailwind:lint: > docusaurus-plugin-tailwind@0.0.0 lint /Users/bgriggs/backstage/janus-idp.github.io/packages/docusaurus-plugin-tailwind
docusaurus-plugin-tailwind:lint: > eslint . --ext .js,.jsx,.ts,.tsx "--fix" "/Users/bgriggs/backstage/janus-idp.github.io/packages/ui/components/banner/banner.tsx"
docusaurus-plugin-tailwind:lint: 
docusaurus-plugin-tailwind:lint: Warning: React version was set to "detect" in eslint-plugin-react settings, but the "react" package is not installed. Assuming latest React version for linting.
docusaurus-plugin-tailwind:lint: 
docusaurus-plugin-tailwind:lint: /Users/bgriggs/backstage/janus-idp.github.io/packages/ui/components/banner/banner.tsx
docusaurus-plugin-tailwind:lint:   0:0  error  Parsing error: ESLint was configured to run on `/Users/bgriggs/backstage/janus-idp.github.io/packages/ui/components/banner/banner.tsx` using `parserOptions.project`: /users/bgriggs/backstage/janus-idp.github.io/packages/docusaurus-plugin-tailwind/tsconfig.json
docusaurus-plugin-tailwind:lint: However, that TSConfig does not include this file. Either:
docusaurus-plugin-tailwind:lint: - Change ESLint's list of included files to not include this file
docusaurus-plugin-tailwind:lint: - Change that TSConfig to include this file
docusaurus-plugin-tailwind:lint: - Create a new TSConfig that includes this file and include it in your parserOptions.project
docusaurus-plugin-tailwind:lint: See the typescript-eslint docs for more info: https://typescript-eslint.io/linting/troubleshooting#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file
docusaurus-plugin-tailwind:lint: 
docusaurus-plugin-tailwind:lint: ✖ 1 problem (1 error, 0 warnings)
docusaurus-plugin-tailwind:lint: 
docusaurus-plugin-tailwind:lint:  ELIFECYCLE  Command failed with exit code 1.

Note that it's trying to lint packages/ui/components/banner/banner.tsx from within the docusaurus-plugin-tailwind directory. This PR fixes this by adding explicit steps to run the eslint command from the appropriate directories.

04kash commented 4 days ago

/approve

04kash commented 4 days ago

/lgtm

openshift-ci[bot] commented 4 days ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 04kash

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/janus-idp/janus-idp.github.io/blob/main/OWNERS)~~ [04kash] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment