hassio-addons / addon-node-red

Node-RED - Home Assistant Community Add-ons
https://addons.community
MIT License
513 stars 117 forks source link

⬆️ Update node-red-contrib-modbus to v5.40.0 #1901

Closed renovate[bot] closed 5 days ago

renovate[bot] commented 5 days ago

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
node-red-contrib-modbus (source) 5.31.0 -> 5.40.0 age adoption passing confidence

Release Notes

biancoroyal/node-red-contrib-modbus (node-red-contrib-modbus) ### [`v5.40.0`](https://togithub.com/biancoroyal/node-red-contrib-modbus/blob/HEAD/CHANGELOG.md#5400-2024-06-23) [Compare Source](https://togithub.com/biancoroyal/node-red-contrib-modbus/compare/54acffdad1461486b3cb11f577655850ffe76b78...v5.40.0) ##### Bug Fixes - **buffer:** nodejs Buffer alloc update ([9a6350c](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/9a6350cd67361f10310629a145f8a595e9f3d85c)) - **codeql:** version codeql ([163101f](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/163101f91c784a5202acd86b0a10302a22414495)) - **config:** [#​442](https://togithub.com/biancoroyal/node-red-contrib-modbus/issues/442) fixing optional to save correct ([de88e25](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/de88e25b10e7e92ea8836d22ee91cb25796f3909)) - **modbus-client-core:** fixed test cases ([0697df3](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/0697df3f4fdf71434e3757f9ae68c6e6db22a948)) - **modbus-client-flow:** fixed modbus client flow example ([8613c89](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/8613c892c54d7c73ca818a5fb34729232fb8acef)) - **modbus-fc-flex:** fixed test case for modbus flex fc file ([93b22f8](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/93b22f8cafe5dc269811cfef78fba1c05dc57c69)) - **modbus-flex-getter:** fixed port server and tcp port ([b48d92f](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/b48d92f28c108a1c6e7b6ad03db7089cfe5b13af)) - **modbus-flex-write:** fixed flow for modbus flex write ([a31b4c4](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/a31b4c40259d4ebc8033fbcd006758186efb347e)) - **modbus-getter:** fixed test cases of modbus getter file ([693087b](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/693087bf3c3a92fa52d82a802c7f561e5b980e65)) - **modbus-io-core:** fixed error RangeError \[ERR_OUT_OF_RANGE]: ([ab932f3](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/ab932f3de4a3c362f73ba701da9fd1b0964fb21e)) - **modbus-read:** fixed test cases of modbus read file ([5c5879e](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/5c5879ecb30ca05e61a66fbc8c1a20ee07bf8b8d)) - **modbus-write:** fix example flow for modbus write node ([04fd17c](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/04fd17c9890ce760e36b2ec9402814accfdc2459)) - **modbus:** added a new example flow and fixed test cases ([8181fd4](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/8181fd4f05abff6f57a7b4de636689e890cf0ea9)) - **modbus:** commented the test cases that are failed ([5998a5d](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/5998a5d2fceaaf1b8ba972ddba771b70e2a4c2a2)) - **test_cases:** fixed test flow of modbus queue info ([732fa9c](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/732fa9c57e6b0c536bc50378f8e39081d12e11bc)) - **test_cases:** improved test cases ([bdafa18](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/bdafa18508069876ca522ace6e4a73be4c272c49)) - **test_flows:** fixed old test flows of read node, queue info node ([37b73ee](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/37b73ee0c845bb63b9b00d768b52bf8f76898290)) - **testcase:** fixed test case assertion ([803e7e0](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/803e7e08a53052f02ef6d0f4fa517353c228a88b)) - **test:** fixed test case for modbus read node ([8fb71e9](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/8fb71e9914ceb43249d16498054c5ed2a14cbd5a)) - **test:** fixed port issue ([28115fe](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/28115fe2e5e27a5cb66a403a3d68ee65c96a241b)) - **test:** fixed test case ([c16da3c](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/c16da3c4c23b06856e15de9138ae9943d5a7a0dc)) - **tests:** some test fixes ([45c3c86](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/45c3c86d137a7f2dc929d0e3b189efa026df88b5)) ##### Features - **flex-fc:** add load button ([04fb46e](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/04fb46ed4d2764276b7bcfae1800f9ac342da85a)) - **flex-fc:** add load button for an improved ui experience ([895f446](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/895f446bd99c8ea65bb5f96f7e4d0d79dec3da8e)) - **flex-fc:** map file needs to be json ([28f6010](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/28f60102e07b54d4bd5b86660b4d382341dd54b3)) - **modbus-client-core:** Improve code in modbus-client-core.js file ([f0691e2](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/f0691e2cdf8e0986912d60d31432a592de264769)) - **modbus:** new option for the flex-fc to get input msg ([5ff8167](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/5ff81672ac9c575a71bb241fc5861f25357012c8)) #### [5.27.2](https://togithub.com/biancoroyal/node-red-contrib-modbus/compare/v5.26.0...v5.27.2) (2023-08-29) ##### Bug Fixes - added missing verbose warn ([4082952](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/4082952624d6336d9463d8793415d786d45a2d9f)) - adjusted failing tests to tcp ports ([5db0e99](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/5db0e996c2b95b27cb245ee335cc53d82bdecb65)) - **deps:** can now successfully install deps ([f8e0a64](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/f8e0a6491d4eeed9b295d327f065540e1b2027bd)) - **deps:** updated scope names for requires ([9c643f6](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/9c643f6c5608a164d549fffbc9206341d4b6c75e)) - fixed failing tests using same ports ([06080d4](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/06080d452b0efd71d5f516d14137c24161e984c7)) - **flex-getter:** corrected isReadyForInput ([806ee4c](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/806ee4cb33659744708e80fad7d51e9f7b7c9edc)) - **flex-getter:** fixed failing tests ([1ab96b3](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/1ab96b30ec198aafffc288f1b81d626929c262a1)) - **flex-getter:** revise DelayOnStart ([c9d246a](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/c9d246a1627dbadb7a0bbd3e3b39c9429a10f859)) - **flex-server:** changed var to const ([d638d53](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/d638d5368b3e13700a0fd3aaaa434aae6be8d522)) - **flex-write:** deleted unused flow ([2f0baee](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/2f0baee699a25d0c21eaf95773ab67f4dccd47f6)) - **flexFC:** fixed routes for codes map ([e2e2cc5](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/e2e2cc525f3297d5bb113a68f4292dc444f43e36)) - **flexGetter-verboseWarn:** node.serverInfo is left from client - removed ([94c58db](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/94c58db6b17d58097a5db413301b0e8b2bd43751)) - **isReadyForInput:** now checks ONLY for readyforinput. Rest in onInput ([99f60a8](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/99f60a821d1a8192a9074016f668c7c04b0c740c)) - Node-RED PLUS changed to PLUS for Node-RED ([f726949](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/f72694954b2d3d07e65766c00dcb9274ffb1fd66)) - **not-ready-for-input-warning:** removed unnecessary variable/option ([d435b9b](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/d435b9b5964c11644af9d951879e61ff84009b40)) - **npmrc:** added npmrc file to packed files ([40ebf4d](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/40ebf4d48a9b74af961d6bd4ede9c69cdcfc9e10)) - **require:** now requires correct fork of lib ([2f936f8](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/2f936f8ca7093288456582399b8ddb7f5fab415f)) - **server:** [#​333](https://togithub.com/biancoroyal/node-red-contrib-modbus/issues/333) Cannot read property 'disableMsgOutput' of undefined ([5c28e02](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/5c28e02a1d870635161881152dff7590bd0bfabb)) - **server:** [#​333](https://togithub.com/biancoroyal/node-red-contrib-modbus/issues/333) new check of msg object ([4631795](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/463179555df7e91165dc200bde457e17f441272d)) - **test:** same port on test ([b6f531f](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/b6f531fafbe7b22b4d3812dd20fa68e2f7a9e97f)) - **verboseWarn:** verboseWarn accidentally used func left from client ([c0d88cd](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/c0d88cd424eee6287fec3fa71c295d30fe4cad7c)) - **web:** get routes for FlowForge ([21102c6](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/21102c6fa09811eed3cdca8c83249d2b80f33c25)) ##### Features - add custom function code client functionality ([505329f](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/505329fbfef527935f11d4f1f089d67311903aab)) - add flex-fc node ([2766989](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/27669895fd847b18fcc0849b447abb91d193b4a7)) - add modbus-flex-fc to package.json ([2bbea1e](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/2bbea1e24c47438bd1f89acc7e58bc7a7a63a82a)) - add path for customModbusMessage event ([8a56fed](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/8a56fedd6fa8ca1c424e8650a7d4715fbed0a153)) - add reset template button for request map ([859c563](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/859c563cb61b2faa3279146e6cd06929a01eed51)) - add tests ([94a3870](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/94a387085400c4cba93fce4ab4276dfe7b4d3a2f)) - added "inactive"-test ([03c744a](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/03c744ae8c3bfbae0d3e9df58ab08b8e6d2f7529)) - added isActive function ([6005960](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/6005960dc15ad21f8c3511ddc8e101494e25f955)) - added isInactive check on input ([92f49da](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/92f49da992f7ebf0bec2d7b81bcf63046c1576c2)) - added more point to Todo ([84f39ad](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/84f39ad70b60ba98b0d000f333b2784043add9a6)) - added more Todo notes ([30c5e80](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/30c5e808750e4c6ae9505ce045f4a1eff152e7aa)) - added planned updates for release ([765a549](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/765a5494f2db059d16ad25d4983219fdbabf9e9e)) - added test coverage to Todo ([6148dd5](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/6148dd5dca533b2e5a628dc1a40cece7c77c4be6)) - added test-helper-extension ([c4b493d](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/c4b493d9fad7a3d1ff17b71fda117ca7a35b5216)) - added tests for Client check ([55c235e](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/55c235e347885c06e7f37e03e096384fca0fc7de)) - added Todo content ([94d46e8](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/94d46e8c4b14e8ba695e4c5edcdf6849e2f8e4c0)) - added Todo content, excecuted clean.sh ([8f1977c](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/8f1977c01bde6a53cafae6224a7156f8ea827ec2)) - adjusted TODO and package.json ([c481b6f](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/c481b6f7885fad2349e98bf1e46d61ab7318a61f)) - **clex-connector-test:** organized code ([92c9e37](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/92c9e37d6f1e94975b86fe4b16e96601e1ef477e)) - **client-flows:** extracted and updated flows ([7c40530](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/7c405300e8fea8ceeabd8e0e4e15145fcd67a2cd)) - **client-test:** added "ready to send"-tests ([368e6cd](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/368e6cdea7201914137a5a207ce619530c917bfd)) - **client-tests:** organized code ([830b0ce](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/830b0cee067ad9e5ef35478eb06e589ea3affcbc)) - **client:** more options and tabs for the client node ([1048021](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/10480216ca52cf743a27dac2a7d494c9f4d64033)) - **delay-flex-getter:** added delay after start ([f68d666](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/f68d66632461d2642f531d84eaa884777b640132)) - flex fc debug test ([2785c7e](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/2785c7e67994b7d6f8f1a42bfb605f71a965dee9)) - **flex-connector-flows:** extracted and updated flows ([6f4330c](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/6f4330c9a57bce71c696a9ed499759f1d227e3a1)) - **flex-connector:** added "ready to send" tests ([11d5b1e](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/11d5b1e3526b658b9f385aad66874b0673395801)) - **flex-getter-flows:** extracted and updated flows ([db2471b](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/db2471bff6e0009b7fa45644a53267e45ad163a4)) - **flex-getter-test:** organized code ([981a15e](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/981a15e302f05c8ea6f1c1d742d9876a5ad37d61)) - **flex-getter:** added html information for node ([c74dc2d](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/c74dc2dba7820707cbe7aebe29b0a3b5d7b95e91)) - **flex-getter:** finished implementing delay + ([9656e8f](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/9656e8f6886d2cb941eb1d54f2e7a71c9bebebf8)) - **flex-getter:** finished implementing delay + warnings ([9782a0d](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/9782a0daf180fcaebae0aaf39a4da254cdcd4b8f)) - **flex-getter:** further implementing "delayOnStart" ([7666d95](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/7666d957ebaf89593d1d004dd8cdae437134e2e1)) - **flex-getter:** implemented readyForInput ([70bff72](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/70bff720af0175eee6a4662bb7415d5ce79aac96)) - **flex-getter:** started implementing "showWarnings" + "DelayOnStart" ([d9db52a](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/d9db52a5fa4851c71dbc8ea41ff020056bc6ab69)) - **flex-getter:** startted implementing showReadyForInput ([55b107c](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/55b107c0a281a57fa80de921dd35bd5df759c6bd)) - **flex-sequencer-test:** changed var to const ([ffbf9ff](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/ffbf9ffae7c10f66ab8bc8224784ffb10249ed02)) - **flex-sequencer:** added "Ready-To-Read" tests ([43e34d6](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/43e34d61e4d3e2fe7b3bd1b60407627955ba6346)) - **flex-sequencer:** extracted and updated flows ([b8c12b9](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/b8c12b94e8f3e485348b462d1a0f0cd031a19723)) - **flex-sequencer:** input delay on start ([758a3a5](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/758a3a595b4ff9bb2980f3f0bd91aa1d911f8177)) - **flex-server:** extracted and updated flows ([64d69ea](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/64d69ea0a83d20a5d3951e540c0fbba261aaf22c)) - **flex-write:** added "ready to send"-tests ([9d35d13](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/9d35d131358ba8ac2dc44c1cff2b5c1460f117e7)) - **flex-write:** delay on input and check client is active ([e1bce6c](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/e1bce6c3001e0beb2feba9e2e54663947fa8c09c)) - **flex-write:** extracted and updated flows ([38e4b18](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/38e4b18e6e1b56630cd37c5a8aa70e5f87b45a05)) - **getter-flows:** updated flows to be organized ([5c6239a](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/5c6239a5e5220b96d2585ff16da32df64be19402)) - **getter:** input delay on start ([b7acd97](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/b7acd97ab8f940decb0889f9bf8125fa278f1f57)) - **getter:** organized Code ([19da2dc](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/19da2dc4cd02ea9cc1e7c29a8d0c6ec6e5af8dbf)) - **io-config:** extracted and updated flows ([e037a59](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/e037a59d726b1ad3fddadac3948befcc367f18ae)) - optimized and extracted server flows ([7456528](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/745652821bc7a341f966f4762711c43df900ed1c)) - option show warning and tabs for optionals ([12fa45e](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/12fa45e58a5fb83a1e9c06dc01cbadb7ca1fcaba)) - **queue-info:** extracted and updated flows ([1b668fa](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/1b668fa2679e0d121a27093671eae1464d76aa7c)) - ran clean script, updated Todo ([f6f142f](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/f6f142f4ceab790395d159e8ccf43ce613a66436)) - **read-flows:** updated flows to be organized ([ccfece8](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/ccfece87345f28d3bbf8bff658710e34ee47fc59)) - **ReadyToSend:** added test to test-classes ([ee1f924](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/ee1f924f6007b6a3d0be358919497ef475041f48)) - **response-filter:** added Client check test ([9db71b6](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/9db71b6b762df1956ef209f0600ede4a4dee439c)) - **response-filter:** extracted and updated flows ([93e10f8](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/93e10f8df273efbe417b4cc1db984bb039d15054)) - **response-filter:** prepared flow-extraction ([39092de](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/39092de5f800c2301cb11b1d58485351ba3ca26f)) - **response:** extracted and updated flows ([6930e37](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/6930e37c94aa5b2e7c0899c2c78fdec074e49d50)) - simplified code with new function ([15c06e2](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/15c06e28e748fd87ace7b70e5b09f656fe32f276)) - ui issues fixed and rudimentary working ([5fb77f8](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/5fb77f821621f108ebe9242635fc9790a40bf348)) - working flex fc node ([b75f826](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/b75f8260aa3e3e2f8fa0102439858d250aa135e6)) - **write-flows:** updated flows to be organized ([b32cd54](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/b32cd5457d4aa16c5c1b7abac04fb415e20264ee)) - **write:** input delay on start ([7d3567e](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/7d3567ed28807d5bb030cf002b7168c0b9eb926d)) - wrote test for messageAllowedStates ([e2c92ec](https://togithub.com/biancoroyal/node-red-contrib-modbus/commit/e2c92ec24561eea85c5d90f60d30b1c46501808c))

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.



This PR has been generated by Mend Renovate. View repository job log here.

coderabbitai[bot] commented 5 days ago

[!IMPORTANT]

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.