{"id":23173986,"url":"https://github.com/zebradevs/web-components-code-quality","last_synced_at":"2025-04-05T00:26:11.955Z","repository":{"id":266823230,"uuid":"899056159","full_name":"ZebraDevs/web-components-code-quality","owner":"ZebraDevs","description":"This action is designed to format and test Web Component repositories on pull requests. It helps ensure that your code meets the required quality standards.","archived":false,"fork":false,"pushed_at":"2025-04-03T16:22:17.000Z","size":15117,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T17:24:31.444Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ZebraDevs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-05T14:41:50.000Z","updated_at":"2025-01-15T14:46:52.000Z","dependencies_parsed_at":"2024-12-06T11:23:02.376Z","dependency_job_id":"14bcb7a2-9ab4-4c3e-bce9-e94208929e19","html_url":"https://github.com/ZebraDevs/web-components-code-quality","commit_stats":null,"previous_names":["zebradevs/web-components-code-quality"],"tags_count":27,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZebraDevs%2Fweb-components-code-quality","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZebraDevs%2Fweb-components-code-quality/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZebraDevs%2Fweb-components-code-quality/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZebraDevs%2Fweb-components-code-quality/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ZebraDevs","download_url":"https://codeload.github.com/ZebraDevs/web-components-code-quality/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247268382,"owners_count":20911124,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-18T05:18:51.145Z","updated_at":"2025-04-05T00:26:11.950Z","avatar_url":"https://github.com/ZebraDevs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# web-components-code-quality\n\nThis action is designed to format and test Web Component repositories on pull requests. It helps ensure that your code meets the required quality standards.\n\n### Dependencies\n\n- custom-elements-manifest\n- eslint\n- lit-analyzer\n- prettier\n- playwright\n- web-test-runner\n- @web/test-runner-junit-reporter\n- typedoc\n\n### Usage\n\nFollow the instructions below to integrate this action into your workflow.\n\n```yml\nname: CI - Pull Request\n\non:\n  pull_request:\n    branches:\n      - main\n\npermissions:\n  contents: write\n  issues: write\n\njobs:\n  code-quality:\n    runs-on: ubuntu-latest\n\n    steps:\n      - name: Checkout Branch\n        uses: actions/checkout@v4\n\n      - name: Setup Node.js\n        uses: actions/setup-node@v4\n        with:\n          node-version-file: .node-version\n          cache: npm\n\n      - name: Install dependencies\n        run: npm ci\n\n      - name: Code Quality\n        uses: ZebraDevs/web-components-code-quality@v1\n        with:\n          token: ${{ secrets.GITHUB_TOKEN }}\n          working-directory: .\n          web-components-src: src/**/*.ts\n          test-src: src/test/**/*.test.ts\n          test-results-path: ./test-results.xml\n          coverage-path: coverage/lcov.info\n          run-static-analysis: true\n          run-code-formatting: true\n          run-tests: true\n          run-coverage: true\n          create-comment: true\n          coverage-pass-score: 80\n```\n\n### Config\n\nEnsure a report for web test runner.\n\nweb-test-runner.config.js\n\n```js\n///.....\nimport { defaultReporter } from \"@web/test-runner\";\nimport { junitReporter } from \"@web/test-runner-junit-reporter\";\n\nexport default {\n  ///.....\n  reporters: [\n    defaultReporter({ reportTestResults: false, reportTestProgress: true }),\n    junitReporter({\n      outputPath: \"src/test/test-results.xml\",\n      reportLogs: true,\n    }),\n  ],\n};\n```\n\n## Inputs\n\n| Name                | Description                                                         | Required | Default                  |\n| ------------------- | ------------------------------------------------------------------- | -------- | ------------------------ |\n| token               | Token used for pushing fixes and commenting on PRs.                 | true     |                          |\n| working-directory   | Working directory to run the action in                              | false    | \".\"                      |\n| web-components-src  | The path to the directory containing the web components source code | false    | \"src/\\*_/_.{ts,tsx}\"     |\n| test-src            | The path to the directory containing the test source code           | false    | \"src/test/\\*_/_.test.ts\" |\n| test-results-path   | The path to the test results file                                   | false    | \"./test-results.xml\"     |\n| coverage-path       | The path to the coverage file                                       | false    | \"coverage/lcov.info\"     |\n| run-static-analysis | Whether to run static analysis                                      | false    | true                     |\n| run-code-formatting | Whether to run code formatting                                      | false    | true                     |\n| run-tests           | Whether tests should be run.                                        | false    | true                     |\n| run-coverage        | Whether to run coverage                                             | false    | true                     |\n| create-comment      | Whether to create a comment on the PR                               | false    | true                     |\n| coverage-pass-score | The minimum coverage score required to pass                         | false    | \"80\"                     |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzebradevs%2Fweb-components-code-quality","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzebradevs%2Fweb-components-code-quality","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzebradevs%2Fweb-components-code-quality/lists"}