init

Author: MrAMS

.bazelrc

@@ -0,0 +1,4 @@
+build --incompatible_disallow_empty_glob=true
+
+# Keep user overrides at the end.
+try-import %workspace%/user.bazelrc

.bazelversion

@@ -0,0 +1 @@
+7.5.0

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/bcr_helper.yml

@@ -0,0 +1,60 @@
+name: BCR Helper
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+
+jobs:
+  update-release-with-bcr-info:
+    name: Pack, Calc Hash & Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Package & Calculate Hash
+        id: calc
+        run: |
+          REPO_NAME="${{ github.event.repository.name }}"
+          TAG_NAME="${{ github.ref_name }}"
+          PURE_VERSION="${TAG_NAME#v}"
+          ASSET_NAME="${REPO_NAME}-${PURE_VERSION}.tar.gz"
+          DOWNLOAD_URL="https://github.com/${{ github.repository }}/releases/download/${TAG_NAME}/${ASSET_NAME}"
+          PREFIX_DIR="${REPO_NAME}-${PURE_VERSION}"
+
+          git archive --format=tar.gz --prefix="${PREFIX_DIR}/" -o "$ASSET_NAME" "$TAG_NAME"
+
+          HASH_VALUE=$(openssl dgst -sha256 -binary "$ASSET_NAME" | openssl base64 -A)
+          SRI_HASH="sha256-$HASH_VALUE"
+
+          JSON_CONTENT=$(jq -n \
+            --arg integrity "$SRI_HASH" \
+            --arg strip_prefix "$PREFIX_DIR" \
+            --arg url "$DOWNLOAD_URL" \
+            '{integrity: $integrity, strip_prefix: $strip_prefix, url: $url}')
+
+          {
+            echo "## BCR Submission Data"
+            echo
+            echo '```json'
+            echo "$JSON_CONTENT" | jq .
+            echo '```'
+          } > release_body.md
+
+          echo "ASSET_NAME=$ASSET_NAME" >> "$GITHUB_ENV"
+
+      - name: Create/Update Release with Asset
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: Release ${{ github.ref_name }}
+          body_path: release_body.md
+          draft: false
+          prerelease: false
+          files: ${{ env.ASSET_NAME }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    paths-ignore:
+      - "**.md"
+      - "LICENSE"
+  pull_request:
+
+jobs:
+  test:
+    name: Build and Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Bazel
+        uses: bazel-contrib/setup-bazel@0.15.0
+        with:
+          bazelisk-version: "1.x"
+          bazelisk-cache: true
+          repository-cache: true
+
+      - name: Build all targets
+        run: bazel build //...
+
+      - name: Run smoke tests
+        run: |
+          bazel test //tests/smoke:verilog_concat_test --test_output=errors
+          bazel test //tests/smoke:simple_adder_test --test_output=errors
+
+      - name: Run Chisel version compatibility checks
+        run: tests/version_compat/check_chisel_versions.sh

.github/workflows/lint.yml

@@ -0,0 +1,20 @@
+name: Lint
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  buildifier:
+    runs-on: ubuntu-22.04
+    env:
+      BUILDIFIER_VERSION: v8.2.1
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: |
+          sudo wget https://github.com/bazelbuild/buildtools/releases/download/${{ env.BUILDIFIER_VERSION }}/buildifier-linux-amd64 -O /usr/local/bin/buildifier
+          sudo chmod +x /usr/local/bin/buildifier
+
+      - run: buildifier -lint=warn -mode=check -warnings=all -r .

.gitignore

@@ -0,0 +1,4 @@
+bazel-*
+user.bazelrc
+MODULE.bazel.lock
+.metals/

AGENT.md

@@ -0,0 +1,44 @@
+# AGENT文档
+
+## 用户指令
+
+你的任务是将`/home/yqj/proj/arch/BonbonPIM2/rules/generate.bzl`中的`chisel_binary`,`chisel_library`和`chisel_test`，以及`@bazel-orfs//:verilog.bzl`中的`verilog_single_file_library`这些工具函数，还有关于Scala和Chisel依赖管理，封装成名为`rules_chisel`的BCR包，使得用户可以通过类似下面的方式方便地使用chisel：
+```starlark
+# 一个可能的使用样例，你可以优化
+# User's MODULE.bazel
+bazel_dep(name = "rules_chisel", version = "0.1.0")
+
+# Optional: Configure Chisel/Scala versions
+chisel = use_extension("@rules_chisel//chisel:extensions.bzl", "chisel")
+chisel.toolchain(
+    chisel_version = "7.2.0",      # Default: latest stable
+    scala_version = "2.13.17",     # Default: 2.13.17
+)
+use_repo(chisel, "chisel_maven")
+```
+
+你需要仿照`/home/yqj/proj/buildtools/bazel_rules_verilator`，建立完善的BCR包工程，包括：简洁清晰的README、最小测试工程、GitHub CI以及BCR包相关元信息。
+
+请你记得在下面的AGENT 日志用中文记录你的进展以便我审阅。
+
+## AGENT 日志
+- 已完成初始方案设计：以 `rules_chisel` BCR 包形式封装 `chisel_binary`、`chisel_library`、`chisel_test` 和 `verilog_single_file_library`。
+- 结合你的建议（Scala 可由用户自行管理），当前实现将 **Scala toolchain 注册**保留给用户在 `MODULE.bazel` 自管；`rules_chisel` 负责提供 Chisel/ScalaTest Maven 依赖扩展。
+- 已新增 `chisel/extensions.bzl`：提供 `chisel.toolchain(...)` 扩展，默认生成 `@chisel_maven`，并支持版本参数（`chisel_version`、`scala_version` 等）。
+- 已新增 `chisel/defs.bzl` 与 `verilog/defs.bzl`：实现/导出所需规则，并给 `chisel_test` 内置 Verilator 运行时包装。
+- 已建立最小测试工程 `tests/smoke`：覆盖 Chisel library/binary/test 与 Verilog 单文件拼接规则。
+- 已补齐工程化内容：`MODULE.bazel`、`BUILD.bazel`、`README.md`、`.github/workflows/{ci,lint,bcr_helper}.yml`、基础 Bazel 配置文件。
+- 下一步：执行本地 `bazel build //...` 与 smoke tests 自检，并根据结果修正细节。
+- 自检完成：
+  - `bazel build //...` 通过。
+  - `bazel test //tests/smoke:verilog_concat_test //tests/smoke:simple_adder_test --test_output=errors` 通过。
+- 修正记录：
+  - 处理了 `chisel_test` 包装规则命名、模板字符串转义、示例 Scala API 兼容性（改为更稳妥的 smoke binary 示例）等问题。
+  - 处理了 bzlmod 下 `maven_install` 生成仓库可见性问题，补充 `rules_shell` / `rules_java` 依赖。
+  - 将 `scalactic` 作为独立 Maven 工件移除，避免解析失败；`scalatest` 维持可用。
+- 根据评审意见修正文档表达：
+  - README 已明确 Scala toolchain 配置是 **必须由用户自行管理**（非 optional）。
+  - README 已增加 `chisel_test` 对 Verilator 依赖的说明（含 `bazel_dep(name = "verilator", ...)` 示例和注意事项）。
+- 继续按评审建议修正文档：README 已要求用户在 `chisel.toolchain(...)` 中显式指定 `firtool_resolver_version`，并注明其与 `chisel_version` 强绑定，同时给出官方版本对照文档链接（https://www.chisel-lang.org/docs/appendix/versioning）。
+- 同步更新仓库内 `MODULE.bazel` 示例，显式填写了 `chisel_version` / `scala_version` / `firtool_resolver_version`，避免隐式默认值造成误用。
+- 按新要求继续修订 README：已单独补充 Verilator 依赖说明，并明确该依赖是 **仅 `chisel_test` 需要**（`chisel_binary`/`chisel_library`/`verilog_single_file_library` 不要求该依赖）。

BUILD.bazel

@@ -0,0 +1,29 @@
+# Copyright 2026
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+load("@rules_license//rules:license.bzl", "license")
+
+package(
+    default_applicable_licenses = [":package_license"],
+    default_visibility = ["//visibility:private"],
+)
+
+license(
+    name = "package_license",
+    package_name = "rules_chisel",
+)
+
+licenses(["notice"])
+
+exports_files(["LICENSE"])