breadkit-lint 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +5 -0
- data/LICENSE.txt +21 -0
- data/README.md +54 -0
- data/SECURITY.md +5 -0
- data/config/default.yml +36 -0
- data/docs/rules/Electrical/DanglingWire.md +9 -0
- data/docs/rules/Electrical/FloatingPin.md +9 -0
- data/docs/rules/Electrical/MissingSeriesResistor.md +11 -0
- data/docs/rules/Electrical/NetLabelConflict.md +10 -0
- data/docs/rules/Electrical/NoCommonGround.md +10 -0
- data/docs/rules/Electrical/PowerPinUnconnected.md +9 -0
- data/docs/rules/Electrical/ReversePolarity.md +10 -0
- data/docs/rules/Electrical/ShortCircuit.md +9 -0
- data/docs/rules/Electrical/ShortedComponent.md +9 -0
- data/docs/rules/Electrical/SplitRail.md +10 -0
- data/docs/rules/Electrical/SupplyVoltageRange.md +10 -0
- data/docs/rules/Intent/ConnectionMismatch.md +9 -0
- data/docs/rules/Intent/UnknownNet.md +9 -0
- data/docs/rules/Layout/DuplicateRef.md +10 -0
- data/docs/rules/Layout/HoleConflict.md +10 -0
- data/docs/rules/Layout/InvalidHole.md +9 -0
- data/docs/rules/Layout/InvalidPlacement.md +9 -0
- data/docs/rules/Layout/NoFreeHole.md +7 -0
- data/docs/rules/Layout/PinsInSameStrip.md +9 -0
- data/docs/rules/Layout/SplitNetLabel.md +3 -0
- data/docs/rules/Layout/UnknownBoard.md +3 -0
- data/docs/rules/Layout/UnknownOption.md +5 -0
- data/docs/rules/Layout/UnknownPart.md +9 -0
- data/docs/rules/Layout/UnknownPin.md +9 -0
- data/docs/rules/Layout/UnknownTransistorModel.md +5 -0
- data/docs/rules/Layout/UnplacedPin.md +3 -0
- data/docs/rules/Style/WireColor.md +9 -0
- data/exe/bklint +5 -0
- data/lib/breadkit/lint/rules/electrical.rb +371 -0
- data/lib/breadkit/lint/rules/intent.rb +59 -0
- data/lib/breadkit/lint/rules/layout.rb +33 -0
- data/lib/breadkit/lint/rules/style.rb +43 -0
- data/lib/breadkit/lint/rules/support.rb +88 -0
- data/lib/breadkit/lint/rules.rb +205 -0
- data/lib/breadkit/lint/version.rb +7 -0
- data/lib/breadkit/lint.rb +476 -0
- data/locales/en.yml +28 -0
- data/locales/ja.yml +65 -0
- data/package-lock.json +1172 -0
- data/package.json +12 -0
- data/scripts/check_bad_examples.rb +37 -0
- data/sig/breadkit/lint.rbs +68 -0
- data/site/favicon.svg +7 -0
- data/site/index.html +95 -0
- data/site/styles.css +14 -0
- metadata +111 -0
data/locales/en.yml
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
rules:
|
|
2
|
+
Layout/InvalidHole: A hole does not exist on the selected board.
|
|
3
|
+
Layout/UnknownBoard: The selected board definition is not available.
|
|
4
|
+
Layout/UnknownPart: The part definition is not available.
|
|
5
|
+
Layout/UnknownTransistorModel: The transistor model is unknown and a generic pinout is used.
|
|
6
|
+
Layout/UnknownPin: A component pin reference does not exist.
|
|
7
|
+
Layout/UnknownOption: A component option is not recognized.
|
|
8
|
+
Layout/UnplacedPin: A component pin has no board hole.
|
|
9
|
+
Layout/DuplicateRef: A component or wire identifier is repeated.
|
|
10
|
+
Layout/InvalidPlacement: A component footprint does not fit the board.
|
|
11
|
+
Layout/HoleConflict: More than one lead occupies the same hole.
|
|
12
|
+
Layout/NoFreeHole: Automatic placement could not find a free hole.
|
|
13
|
+
Layout/SplitNetLabel: A label names disconnected nets.
|
|
14
|
+
Layout/PinsInSameStrip: Two pins of one component share a conductive strip.
|
|
15
|
+
Electrical/ShortCircuit: Power constraints produce inconsistent voltages.
|
|
16
|
+
Electrical/ShortedComponent: A two-pin component is bypassed.
|
|
17
|
+
Electrical/FloatingPin: A component pin has no external connection.
|
|
18
|
+
Electrical/DanglingWire: A wire end has no other connection.
|
|
19
|
+
Electrical/SplitRail: A used segment of a split rail has no supply.
|
|
20
|
+
Electrical/MissingSeriesResistor: An LED has an unprotected path across a supply.
|
|
21
|
+
Electrical/ReversePolarity: A polarized part is connected backwards.
|
|
22
|
+
Electrical/PowerPinUnconnected: An IC power or ground pin is not connected to a supply.
|
|
23
|
+
Electrical/SupplyVoltageRange: An IC supply voltage is outside its rated range.
|
|
24
|
+
Electrical/NoCommonGround: Power supplies do not share a ground.
|
|
25
|
+
Electrical/NetLabelConflict: Different labels name one net.
|
|
26
|
+
Intent/ConnectionMismatch: Wiring differs from declared expectations.
|
|
27
|
+
Intent/UnknownNet: An expectation refers to an unknown net.
|
|
28
|
+
Style/WireColor: A wire color differs from the supply color convention.
|
data/locales/ja.yml
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
rules:
|
|
2
|
+
Layout/InvalidHole: 選択したボードに存在しない穴です。
|
|
3
|
+
Layout/UnknownBoard: 指定したボード定義が見つかりません。
|
|
4
|
+
Layout/UnknownPart: パーツ定義が見つかりません。
|
|
5
|
+
Layout/UnknownTransistorModel: トランジスタの型番が不明なため汎用ピン配置を使用します。
|
|
6
|
+
Layout/UnknownPin: 指定した部品ピンが存在しません。
|
|
7
|
+
Layout/UnknownOption: 指定した部品オプションが存在しません。
|
|
8
|
+
Layout/UnplacedPin: 部品ピンがボードの穴に配置されていません。
|
|
9
|
+
Layout/DuplicateRef: 部品記号またはワイヤ ID が重複しています。
|
|
10
|
+
Layout/InvalidPlacement: 部品の配置がボードに収まりません。
|
|
11
|
+
Layout/HoleConflict: 同じ穴に複数のリードが挿されています。
|
|
12
|
+
Layout/NoFreeHole: 自動配置できる空き穴がありません。
|
|
13
|
+
Layout/SplitNetLabel: 同じラベルが接続されていない複数のネットに付いています。
|
|
14
|
+
Layout/PinsInSameStrip: 同じ部品の複数ピンが同一ストリップに接続しています。
|
|
15
|
+
Electrical/ShortCircuit: 電源間の電位に矛盾があります。
|
|
16
|
+
Electrical/ShortedComponent: 2端子部品が迂回されています。
|
|
17
|
+
Electrical/FloatingPin: 部品ピンが外部に接続されていません。
|
|
18
|
+
Electrical/DanglingWire: ワイヤの端が他の要素に接続されていません。
|
|
19
|
+
Electrical/SplitRail: 分断された電源レールの一部に電源がありません。
|
|
20
|
+
Electrical/MissingSeriesResistor: LED に電流制限抵抗がありません。
|
|
21
|
+
Electrical/ReversePolarity: 有極性部品が逆向きに接続されています。
|
|
22
|
+
Electrical/PowerPinUnconnected: IC の電源ピンまたは GND ピンが電源につながっていません。
|
|
23
|
+
Electrical/SupplyVoltageRange: IC の電源電圧が定格範囲外です。
|
|
24
|
+
Electrical/NoCommonGround: 複数の電源で GND が共通化されていません。
|
|
25
|
+
Electrical/NetLabelConflict: 同じネットに異なる名前が付いています。
|
|
26
|
+
Intent/ConnectionMismatch: 宣言した接続と実際の配線が異なります。
|
|
27
|
+
Intent/UnknownNet: 宣言で参照したネットが見つかりません。
|
|
28
|
+
Style/WireColor: 電源レールの慣例とワイヤ色が異なります。
|
|
29
|
+
messages:
|
|
30
|
+
diagnostic_invalid_hole: "無効な穴または接続先です: %{target}"
|
|
31
|
+
diagnostic_unknown_board: "ボード定義が見つかりません。"
|
|
32
|
+
diagnostic_unknown_part: "部品定義が見つかりません: %{target}"
|
|
33
|
+
diagnostic_unknown_transistor_model: "トランジスタの型番が不明なため汎用 EBC ピン配置を使用します: %{target}"
|
|
34
|
+
diagnostic_unknown_pin: "ピンが見つかりません: %{target}"
|
|
35
|
+
diagnostic_unknown_option: "部品オプションが見つかりません: %{option}"
|
|
36
|
+
diagnostic_unplaced_pin: "部品ピンが穴に配置されていません: %{target}"
|
|
37
|
+
diagnostic_duplicate_ref: "識別子が重複しています: %{target}"
|
|
38
|
+
diagnostic_invalid_placement: "部品の配置が無効です: %{target}"
|
|
39
|
+
diagnostic_hole_conflict: "同じ穴に複数の端子があります: %{target}"
|
|
40
|
+
diagnostic_no_free_hole: "空き穴がありません: %{target}"
|
|
41
|
+
diagnostic_split_net_label: "同じラベルが切断されたネットにあります: %{target}"
|
|
42
|
+
diagnostic_unknown_net: "ネットが見つかりません: %{target}"
|
|
43
|
+
rule_error: "%{rule} の検査中にエラーが発生しました: %{error}"
|
|
44
|
+
same_strip: "%{ref} のピン %{left} と %{right} は同じストリップ %{strip} にあります"
|
|
45
|
+
short_circuit: "%{first}(%{first_voltage} V)と %{second}(%{second_voltage} V)の電位がネット %{net} で矛盾します(経路: %{path})"
|
|
46
|
+
shorted_component: "%{ref} の両端が同じネットに接続されています"
|
|
47
|
+
unplaced_pin: "%{pin} がボードの穴に配置されていません"
|
|
48
|
+
floating_pin: "%{pin} が外部に接続されていません"
|
|
49
|
+
dangling_wire: "%{wire} の端が接続されていません"
|
|
50
|
+
split_rail: "%{rail} の使用中の区間に電源がありません"
|
|
51
|
+
missing_series_resistor: "%{ref} に直列の電流制限抵抗がありません"
|
|
52
|
+
reverse_polarity: "%{ref} の正極の電位が負極より低くなっています"
|
|
53
|
+
power_pin: "%{pin} が有効な電源に接続されていません"
|
|
54
|
+
supply_range: "%{ref} の %{power}/%{ground} 間は %{voltage} V です(定格 %{minimum}〜%{maximum} V)"
|
|
55
|
+
common_ground: "複数の電源で GND が共通化されていません"
|
|
56
|
+
wire_color: "%{wire} の色 %{color} は想定色 %{expected} と異なります"
|
|
57
|
+
label_conflict: "同じネットに異なるラベルがあります: %{labels}"
|
|
58
|
+
unknown_expectation: "接続宣言に不明な参照があります: %{refs}"
|
|
59
|
+
expected_connected: "%{refs} は接続されている必要があります"
|
|
60
|
+
expected_isolated: "%{refs} は分離されている必要があります"
|
|
61
|
+
undeclared_pins: "宣言したネットに未宣言のピンがあります: %{pins}"
|
|
62
|
+
expected_net_name: "ネット名は %{expected} のはずですが %{actual} です"
|
|
63
|
+
expected_one_net: "%{refs} は同じネットにある必要があります"
|
|
64
|
+
unknown_disable: "lint_disable に不明なルールがあります: %{rule}"
|
|
65
|
+
disable_reason: "%{rule} の lint_disable には理由が必要です"
|