Giter VIP home page Giter VIP logo

Comments (3)

HaakonSvane avatar HaakonSvane commented on May 23, 2024 2

Thanks @Tiketti! Perhaps I should have been more clear on what I meant. Looking at the linting code for Prettier, it seems that all commands are run using npm. This is not too big of a deal for me personally, but I guess it wouldn't hurt to run the commands with the repo package manager instead.

What IS problematic for me is that the action runs these two linters (eslint and prettier) directly.
For monorepos, it is common to use a build system to handle caching. This requires setting up proxy commands like:

{
  "scripts": {
    "lint": "turbo run lint", 
  }
}

which handles caching of script outputs to reduce redundant command usage. The current lint-action behaviour does not allow for any custom commands like these. I suggest including a custom command argument that lets you specify what command to run in the repo. For example:

# ...
- name: Run linters
   uses: wearerequired/lint-action@v2
   with:
     eslint: true
     prettier: true
     # example commands
     eslint_command: "yarn lint"
     prettier_command: "yarn format" 

Or alternatively just let the linter arguments also accept a command instead of just a boolean value (don't know if GH actions allow for this):

# ...
- name: Run linters
   uses: wearerequired/lint-action@v2
   with:
     eslint: "yarn lint"
     prettier: "yarn format"

from lint-action.

Tiketti avatar Tiketti commented on May 23, 2024

While I agree that it would be great to have examples in documentation for pnpm, too, I just modified the sample workflow a bit to for that use case. I hope you find it useful:

# ... the basic set up here

jobs:
  run-linters:
    name: Run linters
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - uses: pnpm/action-setup@v2
        with:
          version: 8

      - name: Use Node.js 20
        uses: actions/setup-node@v3
        with:
          node-version: 20
          cache: 'pnpm'

      - name: Install dependencies
        run: pnpm install

      - name: Run linters
        uses: wearerequired/lint-action@v2
        with:
          eslint: true
          prettier: true
          eslint_extensions: ts,tsx

from lint-action.

github-actions avatar github-actions commented on May 23, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

from lint-action.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.