{"id":20981967,"url":"https://github.com/lowrisc/misc-linters","last_synced_at":"2025-05-14T16:31:00.438Z","repository":{"id":40424631,"uuid":"214175493","full_name":"lowRISC/misc-linters","owner":"lowRISC","description":"Some Internal Linter Scripts","archived":false,"fork":false,"pushed_at":"2025-02-17T17:06:32.000Z","size":75,"stargazers_count":1,"open_issues_count":5,"forks_count":13,"subscribers_count":50,"default_branch":"master","last_synced_at":"2025-04-02T20:38:24.307Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lowRISC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2019-10-10T12:21:06.000Z","updated_at":"2025-02-17T17:05:42.000Z","dependencies_parsed_at":"2024-07-22T11:54:46.856Z","dependency_job_id":"501d7960-a83f-4ed3-aaee-0bd806f03675","html_url":"https://github.com/lowRISC/misc-linters","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowRISC%2Fmisc-linters","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowRISC%2Fmisc-linters/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowRISC%2Fmisc-linters/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowRISC%2Fmisc-linters/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lowRISC","download_url":"https://codeload.github.com/lowRISC/misc-linters/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254182792,"owners_count":22028363,"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-11-19T05:42:03.751Z","updated_at":"2025-05-14T16:30:59.732Z","avatar_url":"https://github.com/lowRISC.png","language":"Python","readme":"# lowRISC's Miscellaneous Linters\n\n## About the project\n\nThese are linters and checkers, usually for source code, which we have written\nfor various lowRISC projects.\n\nThey include\n* `licence-checker/licence-checker.py` which will ensure source code in your\n  repository contains correctly formatted licence headers. This is designed to\n  be reused: it is configured with `licence-checker.hjson`.\n\n## Using the linters\n\nThis repository provides Bazel rules for generating linting jobs. First, add\nthis repository to your `WORKSPACE` (with a name like `lowrisc_lint`). Then,\nin `WORKSPACE` add\n\n```bazel\nload(\"@lowrisc_lint//rules:deps.bzl\", \"lowrisc_misc_linters_dependencies\")\nlowrisc_misc_linters_dependencies()\nload(\"@lowrisc_lint//rules:pip.bzl\", \"lowrisc_misc_linters_pip_dependencies\")\nlowrisc_misc_linters_pip_dependencies()\nload(\"@lowrisc_misc_linters_pip//:requirements.bzl\", \"install_deps\")\ninstall_deps()\n```\n\nIf using `bzlmod`, instead add the following to `MODULE.bazel`:\n\n```bazel\nbazel_dep(name = \"lowrisc_misc_linters\")\ngit_override(\n    module_name = \"lowrisc_misc_linters\",\n    remote = \"https://github.com/lowRISC/misc-linters\",\n    commit = \"\u003ccommit hash\u003e\",\n)\n```\n\nand then in a BUILD file, like the root:\n\n```bazel\nload(\"@lowrisc_lint//rules:rules.bzl\", \"licence_check\")\n\nlicence_check(\n    name = \"licence-check\",\n    licence = '''\n    Copyright lowRISC contributors.\n    Licensed under the Apache License, Version 2.0, see LICENSE for details.\n    SPDX-License-Identifier: Apache-2.0\n    ''',\n    exclude_patterns = [\".style.yapf\"],\n)\n```\n\nThis will generate a rule that will check licence headers, callable as\n`bazel run //:licence-check`.\n\n## How to contribute\n\nHave a look at [CONTRIBUTING](./CONTRIBUTING.md) for guidelines on how to\ncontribute code to this repository.\n\n## Licensing\n\nUnless otherwise noted, everything in this repository is covered by the Apache\nLicense, Version 2.0 (see [LICENSE](./LICENSE) for full text).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flowrisc%2Fmisc-linters","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flowrisc%2Fmisc-linters","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flowrisc%2Fmisc-linters/lists"}