readable-verilog-generator
VerifiedUse when creating, writing, reviewing, annotating, repairing, refactoring, or validating readable Verilog RTL, including synthesizable Verilog-2001 .v files, existing-RTL analysis, semantic comment annotation, testbench scaffold planning, ASIC-quality review, local or remote Vivado/xsim validation, evidence-backed repair, and workflow trace diagnosis.
assets/verilog_formatter_config/defaults.json
View on GitHub{
"paths": {
"workspace_root": ".",
"input": ".",
"output": "./out/formatted",
"backup_dir": "./out/backups",
"report_dir": "./reports/verilog-formatter"
},
"execution": {
"mode": "format",
"target_kind": "auto",
"recurse": true,
"in_place": false,
"dry_run": true,
"fail_on_missing_input": true,
"include_extensions": [
".v"
],
"workspace_scan_exclude_dir_names": [
".git",
"__pycache__",
".pytest_cache",
"dist",
"out",
"ref"
],
"workspace_scan_exclude_subpaths": [
"tests/verilog-formatter/baselines"
]
},
"formatter": {
"indent_style": "tab",
"indent_size": 1,
"preserve_comments": true,
"sort_ports": true,
"sort_params": true,
"space_around_operator": true,
"space_after_comma": true,
"auto_fix_prefix": true,
"trailing_comment_style": "column",
"trailing_comment_column": 49,
"backend": "builtin",
"backend_command": []
},
"checks": {
"enable": true,
"diff": false,
"naming": true,
"prefix": true,
"region_layout": true
},
"backup": {
"enabled": false,
"suffix": ".bak"
},
"reporting": {
"emit_summary": true,
"summary_format": "json",
"write_resolved_config": true
},
"text_io": {
"encoding_policy": "preserve",
"eol_policy": "preserve",
"bom_policy": "preserve",
"final_newline_policy": "preserve",
"format_include_fragments": false
},
"rewrite_policy": {
"mode": "preserve"
},
"compat": {
"legacy_yaml_import": false,
"legacy_phase_pipeline": false,
"shell_wrappers": false,
"example_compat": false
},
"header": {
"company_en": "Erie",
"company_cn": "Erie",
"engineer_en": "Erie",
"engineer_cn": "Erie",
"copyright_owner_en": "Erie",
"copyright_owner_cn": "Erie",
"developer_en": "Erie",
"developer_cn": "Erie",
"reviser_en": "Erie",
"reviser_cn": "Erie",
"description_template": "description/{module_name}_Design.pdf",
"simulations_template": "testbench/vivado/2021.1/{module_name}",
"default_version": "V1.0",
"allow_auto_version_bump": false,
"history_mode": "preserve",
"layout": {
"english": {
"separator": "////////////////////////////////////English///////////////////////////////////////",
"company_prefix": "// Company: ",
"engineer_prefix": "// Engineer: ",
"blank_after_identity": "//",
"create_date_prefix": "// Create Date: ",
"design_name_prefix": "// Design Name: ",
"module_name_prefix": "// Module Name: ",
"description_prefix": "// Description: ",
"simulations_prefix": "// Simulations: ",
"blank_before_references": "//",
"references_prefix": "// Referrences: ",
"references_table_header": "File Format File Name",
"dependencies_prefix": "// Dependencies: ",
"dependencies_table_header": "Module Name Version",
"section_blank": "//",
"version_prefix": "// Version: ",
"revision_date_prefix": "// Revision Date: ",
"history_title": "// History:",
"history_header": "// Time Version Revised by Contents"
},
"chinese": {
"separator": "///////////////////////////////////Chinese////////////////////////////////////////",
"company_prefix": "// 版权归属: ",
"engineer_prefix": "// 开发人员: ",
"blank_after_identity": "//",
"create_date_prefix": "// 创建日期: ",
"design_name_prefix": "// 设计名称: ",
"module_name_prefix": "// 模块名称: ",
"description_prefix": "// 模块说明: ",
"simulations_prefix": "// 仿真工程: ",
"blank_before_references": "//",
"references_prefix": "// 参考资料: ",
"references_table_header": "文件格式 文件名称",
"dependencies_prefix": "// 依赖文件: ",
"dependencies_table_header": "模块名称 版本",
"section_blank": "//",
"version_prefix": "// 当前版本: ",
"revision_date_prefix": "// 修订日期: ",
"history_title": "// 修订历史:",
"history_header": "// 时间 版本 修订人 修订内容"
}
}
},
"naming": {
"input_prefix": "i_",
"output_prefix": "o_",
"inout_prefix": "io_",
"parameter_prefix": "C_",
"state_prefix": "ST_",
"register_prefix": "reg_",
"counter_prefix": "cnt_",
"state_signal_prefix": "state_",
"encoder_prefix": "enc_",
"decoder_prefix": "dec_",
"flag_prefix": "flag_",
"internal_output_suffix": "_o",
"dedupe_prefixes": true,
"preserve_port_names": [],
"preserve_port_patterns": []
},
"reset_clock": {
"require_active_low_reset": true,
"default_clock": "i_clk",
"default_reset": "i_rstn"
},
"structure": {
"enforce_region_order": true,
"place_instances_last": true,
"region_order": [
"config_param",
"state_param",
"instance_signal",
"counter_signal",
"state_signal",
"register_signal",
"flag_signal",
"encoder_signal",
"decoder_signal",
"other_signal",
"output_internal",
"other_assign",
"output_assign",
"output_always",
"state_machine",
"state_task",
"main_task",
"generate_block",
"initial_block",
"instance_block",
"parameter_check"
]
},
"always_rules": {
"single_reg_per_always": true,
"auto_split": true
},
"wire_assign_rules": {
"forbid_inline_wire_assign": true,
"rewrite_inline_wire_assign": true
},
"state_machine": {
"enforce_three_segment": true,
"state_param_prefix": "ST_"
},
"strict_mode": {
"enabled": true,
"fail_on_unsupported_syntax": true,
"fail_on_missing_clock_reset": true
}
}
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| planning-and-task-breakdownaddyosmani/agent-skillsBreaks work into ordered tasks. Use when you have a spec or clear requirements and need to break work into implementable tasks. Use when a task feels too large to start, when you need to estimate scope, or when parallel work is possible. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| screenpipethedotmack/claude-memSearch screen and audio history recorded by Screenpipe and optionally save selected context into claude-mem. Use when the user asks to recall desktop activity, a meeting, or something seen in another app through Screenpipe. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |
| contact-widgetnexu-io/open-designSelf-contained floating chat widget with welcome screen, social links, meeting button, and message input. Single HTML file, zero dependencies. | Stars: 108k | Updated | Claude CodeCodex | Verified | Install |
| meeting-notesnexu-io/open-designMeeting notes page — title bar with attendees, agenda checklist, decisions block, action items table with owners + dates, and a "next meeting" footer. Use when the brief mentions "meeting notes", "minutes", "1:1 notes", "all-hands recap", or "会议纪要". | Stars: 108k | Updated | Claude CodeCodex | Verified | Install |