From 52cc76e2092207225c3461c47d36d9d5b9e0e244 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Grzegorz=20=C5=9Aliwi=C5=84ski?= Date: Fri, 28 Jul 2023 16:56:48 +0200 Subject: [PATCH] Lint rstfiles with rstcheck --- .github/workflows/linters.yml | 1 + .rstcheck.cfg | 2 + CONTRIBUTING.rst | 2 +- Pipfile | 1 + Pipfile.lock | 115 +++++++++++++++++++++++++++++++++- newsfragments/505.misc.rst | 1 + 6 files changed, 120 insertions(+), 2 deletions(-) create mode 100644 .rstcheck.cfg create mode 100644 newsfragments/505.misc.rst diff --git a/.github/workflows/linters.yml b/.github/workflows/linters.yml index 366cb72f..e3100882 100644 --- a/.github/workflows/linters.yml +++ b/.github/workflows/linters.yml @@ -14,3 +14,4 @@ jobs: ruff: true black: true mypy: true + rstcheck: true diff --git a/.rstcheck.cfg b/.rstcheck.cfg new file mode 100644 index 00000000..dcf79dfa --- /dev/null +++ b/.rstcheck.cfg @@ -0,0 +1,2 @@ +[rstcheck] +report_level = warning diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 87df5acf..56cb1ca7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,5 +1,5 @@ Contribute to pytest-elasticsearch -============== +================================== Thank you for taking time to contribute to pytest-elasticsearch! diff --git a/Pipfile b/Pipfile index 26866f3a..c2c855b2 100644 --- a/Pipfile +++ b/Pipfile @@ -20,3 +20,4 @@ types-setuptools = "==68.0.0.3" mypy = "==1.4.1" types-mock = "==5.1.0.1" tbump = "==6.10.0" +rstcheck = "==6.1.2" diff --git a/Pipfile.lock b/Pipfile.lock index b4bcd26d..ff03e1d4 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "2a2992da6857bb8fc3b80c2e3e62452044b30614220d549898f0270f9b318422" + "sha256": "dcd4288719efed89395f98fce006616072fe6ff0f74b63e4c5ce0b6141ee5961" }, "pipfile-spec": 6, "requires": {}, @@ -177,6 +177,13 @@ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6'", "version": "==0.4.6" }, + "commonmark": { + "hashes": [ + "sha256:452f9dc859be7f06631ddcb328b6919c67984aca654e5fefb3914d54691aed60", + "sha256:da2f38c92590f83de410ba1a3cbceafbc74fee9def35f9251ba9a971d6d66fd9" + ], + "version": "==0.9.1" + }, "contextlib2": { "hashes": [ "sha256:3fbdb64466afd23abaf6c977627b75b6139a5a3e8ce38405c5b413aed7a0471f", @@ -260,6 +267,14 @@ ], "version": "==0.6.2" }, + "docutils": { + "hashes": [ + "sha256:33995a6753c30b7f577febfc2c50411fec6aac7f7ffeb7c4cfe5991072dcf9e6", + "sha256:5e1de4d849fee02c63b040a4a3fd567f4ab104defd8a5511fbbc24a8a017efbc" + ], + "markers": "python_version >= '3.7'", + "version": "==0.19" + }, "execnet": { "hashes": [ "sha256:88256416ae766bc9e8895c76a87928c0012183da3cc4fc18016e6f050e025f41", @@ -427,6 +442,56 @@ "markers": "python_version >= '3.7'", "version": "==1.2.0" }, + "pydantic": { + "hashes": [ + "sha256:0fe8a415cea8f340e7a9af9c54fc71a649b43e8ca3cc732986116b3cb135d303", + "sha256:1289c180abd4bd4555bb927c42ee42abc3aee02b0fb2d1223fb7c6e5bef87dbe", + "sha256:1eb2085c13bce1612da8537b2d90f549c8cbb05c67e8f22854e201bde5d98a47", + "sha256:2031de0967c279df0d8a1c72b4ffc411ecd06bac607a212892757db7462fc494", + "sha256:2a7bac939fa326db1ab741c9d7f44c565a1d1e80908b3797f7f81a4f86bc8d33", + "sha256:2d5a58feb9a39f481eda4d5ca220aa8b9d4f21a41274760b9bc66bfd72595b86", + "sha256:2f9a6fab5f82ada41d56b0602606a5506aab165ca54e52bc4545028382ef1c5d", + "sha256:2fcfb5296d7877af406ba1547dfde9943b1256d8928732267e2653c26938cd9c", + "sha256:549a8e3d81df0a85226963611950b12d2d334f214436a19537b2efed61b7639a", + "sha256:598da88dfa127b666852bef6d0d796573a8cf5009ffd62104094a4fe39599565", + "sha256:5d1197e462e0364906cbc19681605cb7c036f2475c899b6f296104ad42b9f5fb", + "sha256:69328e15cfda2c392da4e713443c7dbffa1505bc9d566e71e55abe14c97ddc62", + "sha256:6a9dfa722316f4acf4460afdf5d41d5246a80e249c7ff475c43a3a1e9d75cf62", + "sha256:6b30bcb8cbfccfcf02acb8f1a261143fab622831d9c0989707e0e659f77a18e0", + "sha256:6c076be61cd0177a8433c0adcb03475baf4ee91edf5a4e550161ad57fc90f523", + "sha256:771735dc43cf8383959dc9b90aa281f0b6092321ca98677c5fb6125a6f56d58d", + "sha256:795e34e6cc065f8f498c89b894a3c6da294a936ee71e644e4bd44de048af1405", + "sha256:87afda5539d5140cb8ba9e8b8c8865cb5b1463924d38490d73d3ccfd80896b3f", + "sha256:8fb2aa3ab3728d950bcc885a2e9eff6c8fc40bc0b7bb434e555c215491bcf48b", + "sha256:a1fcb59f2f355ec350073af41d927bf83a63b50e640f4dbaa01053a28b7a7718", + "sha256:a5e7add47a5b5a40c49b3036d464e3c7802f8ae0d1e66035ea16aa5b7a3923ed", + "sha256:a73f489aebd0c2121ed974054cb2759af8a9f747de120acd2c3394cf84176ccb", + "sha256:ab26038b8375581dc832a63c948f261ae0aa21f1d34c1293469f135fa92972a5", + "sha256:b0d191db0f92dfcb1dec210ca244fdae5cbe918c6050b342d619c09d31eea0cc", + "sha256:b749a43aa51e32839c9d71dc67eb1e4221bb04af1033a32e3923d46f9effa942", + "sha256:b7ccf02d7eb340b216ec33e53a3a629856afe1c6e0ef91d84a4e6f2fb2ca70fe", + "sha256:ba5b2e6fe6ca2b7e013398bc7d7b170e21cce322d266ffcd57cca313e54fb246", + "sha256:ba5c4a8552bff16c61882db58544116d021d0b31ee7c66958d14cf386a5b5350", + "sha256:c79e6a11a07da7374f46970410b41d5e266f7f38f6a17a9c4823db80dadf4303", + "sha256:ca48477862372ac3770969b9d75f1bf66131d386dba79506c46d75e6b48c1e09", + "sha256:dea7adcc33d5d105896401a1f37d56b47d443a2b2605ff8a969a0ed5543f7e33", + "sha256:e0a16d274b588767602b7646fa05af2782576a6cf1022f4ba74cbb4db66f6ca8", + "sha256:e4129b528c6baa99a429f97ce733fff478ec955513630e61b49804b6cf9b224a", + "sha256:e5f805d2d5d0a41633651a73fa4ecdd0b3d7a49de4ec3fadf062fe16501ddbf1", + "sha256:ef6c96b2baa2100ec91a4b428f80d8f28a3c9e53568219b6c298c1125572ebc6", + "sha256:fdbdd1d630195689f325c9ef1a12900524dceb503b00a987663ff4f58669b93d" + ], + "markers": "python_version >= '3.7'", + "version": "==1.10.12" + }, + "pygments": { + "hashes": [ + "sha256:8ace4d3c1dd481894b2005f560ead0f9f19ee64fe983366be1a21e171d12775c", + "sha256:db2db3deb4b4179f399a09054b023b6a586b76499d36965813c71aa8ed7b5fd1" + ], + "markers": "python_version >= '3.7'", + "version": "==2.15.1" + }, "pytest": { "hashes": [ "sha256:78bf16451a2eb8c7a2ea98e32dc119fd2aa758f1d5d66dbf0a59d69a3969df32", @@ -451,6 +516,29 @@ "index": "pypi", "version": "==3.3.1" }, + "rich": { + "hashes": [ + "sha256:a4eb26484f2c82589bd9a17c73d32a010b1e29d89f1604cd9bf3a2097b81bb5e", + "sha256:ba3a3775974105c221d31141f2c116f4fd65c5ceb0698657a11e9f295ec93fd0" + ], + "version": "==12.6.0" + }, + "rstcheck": { + "hashes": [ + "sha256:4aaa46e0debc179f849807c453fa384fd2b75167faf5b1274115730805fab529", + "sha256:f9cb07a72ef9a81d1e32187eae29b00a89421ccba1bde0b1652a08ed0923f61b" + ], + "index": "pypi", + "version": "==6.1.2" + }, + "rstcheck-core": { + "hashes": [ + "sha256:add19c9a1b97d9087f4b463b49c12cd8a9c03689a255e99089c70a2692f16369", + "sha256:d75d7df8f15b58e8aafe322d6fb6ef1ac8d12bb563089b0696948a00ee7f601a" + ], + "markers": "python_version >= '3.7' and python_version < '4.0'", + "version": "==1.0.3" + }, "ruff": { "hashes": [ "sha256:06b8ee4eb8711ab119db51028dd9f5384b44728c23586424fd6e241a5b9c4a3b", @@ -481,6 +569,13 @@ ], "version": "==0.7.5" }, + "shellingham": { + "hashes": [ + "sha256:368bf8c00754fd4f55afb7bbb86e272df77e4dc76ac29dbcbb81a59e9fc15744", + "sha256:823bc5fb5c34d60f285b624e7264f4dda254bc803a3774a147bf99c0e3004a28" + ], + "version": "==1.5.0.post1" + }, "tabulate": { "hashes": [ "sha256:0ba055423dbaa164b9e456abe7920c5e8ed33fcc16f6d1b2f2d152c8e1e8b4fc", @@ -514,6 +609,24 @@ "index": "pypi", "version": "==23.6.0" }, + "typer": { + "extras": [ + "all" + ], + "hashes": [ + "sha256:b5e704f4e48ec263de1c0b3a2387cd405a13767d2f907f44c1a08cbad96f606d", + "sha256:ff797846578a9f2a201b53442aedeb543319466870fbe1c701eab66dd7681165" + ], + "markers": "python_version >= '3.6'", + "version": "==0.7.0" + }, + "types-docutils": { + "hashes": [ + "sha256:1d029567e67c52992fd42aa968778bc10a5e445c8450fc751d672d6f50330a4a", + "sha256:556fb7ee19248aa482caa142a830c940b776b0f8c7577a98abe0977574546a1d" + ], + "version": "==0.19.1.9" + }, "types-mock": { "hashes": [ "sha256:ce0945bfab57f7e983968602eff44879e2b1ac97e4d26087107011fa527440c9", diff --git a/newsfragments/505.misc.rst b/newsfragments/505.misc.rst new file mode 100644 index 00000000..0020859a --- /dev/null +++ b/newsfragments/505.misc.rst @@ -0,0 +1 @@ +Lint rst files with rstcheck \ No newline at end of file