Fixing remark-lint issues. Adding remark-linter check. (cvat-ai#321)

* Fix remark-lint issues. * Align continuation lines with the first line. Apply comments * Added remark check
TOsmanov · Jul 1, 2021 · 121670c · 121670c
1 parent e8371e9
commit 121670c
Show file tree

Hide file tree

Showing 19 changed files with 2,939 additions and 223 deletions.
diff --git a/.github/workflows/remark.yml b/.github/workflows/remark.yml
@@ -0,0 +1,16 @@
+name: Linter
+on: pull_request
+jobs:
+  Remark:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+            node-version: 12
+
+      - name: Run checks
+        run: |
+          npm ci
+          echo "Remark version: "`npx remark --version`
+          npx remark --frail .
diff --git a/.remarkrc.js b/.remarkrc.js
@@ -0,0 +1,18 @@
+exports.settings = { bullet: '*', paddedTable: false };
+
+exports.plugins = [
+    'remark-frontmatter',
+    'remark-gfm',
+    'remark-preset-lint-recommended',
+    'remark-preset-lint-consistent',
+    ['remark-lint-list-item-indent', 'space'],
+    ['remark-lint-no-dead-urls', false], // Does not work because of github protection system
+    ['remark-lint-maximum-line-length', 80],
+    ['remark-lint-maximum-heading-length', 120],
+    ['remark-lint-strong-marker', '*'],
+    ['remark-lint-emphasis-marker', '_'],
+    ['remark-lint-unordered-list-marker-style', '-'],
+    ['remark-lint-ordered-list-marker-style', '.'],
+    ['remark-lint-no-file-name-irregular-characters', false],
+    ['remark-lint-list-item-spacing', false],
+];
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
-## [Unreleased]
+## \[Unreleased]
 ### Added
 - Support for import/export zip archives with images (<https://github.com/openvinotoolkit/datumaro/pull/273>)
 - Subformat importers for VOC and COCO (<https://github.com/openvinotoolkit/datumaro/pull/281>)
@@ -25,10 +25,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Several dependencies now have lower bounds (<https://github.com/openvinotoolkit/datumaro/pull/308>)
 
 ### Deprecated
--
+- TBD
 
 ### Removed
--
+- TBD
 
 ### Fixed
 - Incorrect image layout on saving and a problem with ecoding on loading (<https://github.com/openvinotoolkit/datumaro/pull/284>)
@@ -37,7 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Improved CLI startup time in several cases (<https://github.com/openvinotoolkit/datumaro/pull/306>)
 
 ### Security
--
+- TBD
 
 ## 03/06/2021 - Release v0.1.9
 ### Added
@@ -53,51 +53,57 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for Validator configurable threshold (<https://github.com/openvinotoolkit/datumaro/pull/250>)
 
 ### Changed
-- LabelMe format saves dataset items with their relative paths by subsets without changing names (<https://github.com/openvinotoolkit/datumaro/pull/200>)
-- Allowed arbitrary subset count and names in classification and detection splitters (<https://github.com/openvinotoolkit/datumaro/pull/207>)
+- LabelMe format saves dataset items with their relative paths by subsets
+  without changing names (<https://github.com/openvinotoolkit/datumaro/pull/200>)
+- Allowed arbitrary subset count and names in classification and detection
+  splitters (<https://github.com/openvinotoolkit/datumaro/pull/207>)
 - Annotation-less dataset elements are now participate in subset splitting (<https://github.com/openvinotoolkit/datumaro/pull/211>)
 - Classification task in LFW dataset format (<https://github.com/openvinotoolkit/datumaro/pull/222>)
 - Testing is now performed with pytest instead of unittest (<https://github.com/openvinotoolkit/datumaro/pull/248>)
 
 ### Deprecated
--
+- TBD
 
 ### Removed
--
+- TBD
 
 ### Fixed
-- Added support for auto-merging (joining) of datasets with no labels and having labels (<https://github.com/openvinotoolkit/datumaro/pull/200>)
+- Added support for auto-merging (joining) of datasets with no labels and
+  having labels (<https://github.com/openvinotoolkit/datumaro/pull/200>)
 - Allowed explicit label removal in `remap_labels` transform (<https://github.com/openvinotoolkit/datumaro/pull/203>)
 - Image extension in CVAT format export (<https://github.com/openvinotoolkit/datumaro/pull/214>)
 - Added a label "face" for bounding boxes in Wider Face (<https://github.com/openvinotoolkit/datumaro/pull/215>)
-- Allowed adding "difficult", "truncated", "occluded" attributes when converting to Pascal VOC if these attributes are not present (<https://github.com/openvinotoolkit/datumaro/pull/216>)
+- Allowed adding "difficult", "truncated", "occluded" attributes when
+  converting to Pascal VOC if these attributes are not present (<https://github.com/openvinotoolkit/datumaro/pull/216>)
 - Empty lines in YOLO annotations are ignored (<https://github.com/openvinotoolkit/datumaro/pull/221>)
 - Export in VOC format when no image info is available (<https://github.com/openvinotoolkit/datumaro/pull/239>)
 - Fixed saving attribute in WiderFace extractor (<https://github.com/openvinotoolkit/datumaro/pull/251>)
 
 ### Security
--
+- TBD
 
 ## 31/03/2021 - Release v0.1.8
 ### Added
--
+- TBD
 
 ### Changed
-- Added an option to allow undeclared annotation attributes in CVAT format export (<https://github.com/openvinotoolkit/datumaro/pull/192>)
-- COCO exports images in separate dirs by subsets. Added an option to control this (<https://github.com/openvinotoolkit/datumaro/pull/195>)
+- Added an option to allow undeclared annotation attributes in CVAT format
+  export (<https://github.com/openvinotoolkit/datumaro/pull/192>)
+- COCO exports images in separate dirs by subsets. Added an option to control
+  this (<https://github.com/openvinotoolkit/datumaro/pull/195>)
 
 ### Deprecated
--
+- TBD
 
 ### Removed
--
+- TBD
 
 ### Fixed
 - Instance masks of `background` class no more introduce an instance (<https://github.com/openvinotoolkit/datumaro/pull/188>)
 - Added support for label attributes in Datumaro format (<https://github.com/openvinotoolkit/datumaro/pull/192>)
 
 ### Security
--
+- TBD
 
 ## 24/03/2021 - Release v0.1.7
 ### Added
@@ -111,10 +117,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Common ICDAR format is split into 3 sub-formats (<https://github.com/openvinotoolkit/datumaro/pull/174>)
 
 ### Deprecated
--
+- TBD
 
 ### Removed
--
+- TBD
 
 ### Fixed
 - The ability to work with file names containing Cyrillic and spaces (<https://github.com/openvinotoolkit/datumaro/pull/148>)
@@ -124,54 +130,57 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Saving of masks in VOC when masks are not requested (<https://github.com/openvinotoolkit/datumaro/pull/184>)
 
 ### Security
--
+- TBD
 
 ## 03/02/2021 - Release v0.1.6.1 (hotfix)
 ### Added
--
+- TBD
 
 ### Changed
--
+- TBD
 
 ### Deprecated
--
+- TBD
 
 ### Removed
--
+- TBD
 
 ### Fixed
 - Images with no annotations are exported again in VOC formats (<https://github.com/openvinotoolkit/datumaro/pull/123>)
 - Inference result for only one output layer in OpenVINO launcher (<https://github.com/openvinotoolkit/datumaro/pull/125>)
 
 ### Security
--
+- TBD
 
 ## 02/26/2021 - Release v0.1.6
 ### Added
 - `Icdar13/15` dataset format (<https://github.com/openvinotoolkit/datumaro/pull/96>)
 - Laziness, source caching, tracking of changes and partial updating for `Dataset` (<https://github.com/openvinotoolkit/datumaro/pull/102>)
 - `Market-1501` dataset format (<https://github.com/openvinotoolkit/datumaro/pull/108>)
 - `LFW` dataset format (<https://github.com/openvinotoolkit/datumaro/pull/110>)
-- Support of polygons' and masks' confusion matrices and mismathing classes in `diff` command (<https://github.com/openvinotoolkit/datumaro/pull/117>)
+- Support of polygons' and masks' confusion matrices and mismathing classes in
+  `diff` command (<https://github.com/openvinotoolkit/datumaro/pull/117>)
 - Add near duplicate image removal plugin (<https://github.com/openvinotoolkit/datumaro/pull/113>)
-- Sampler Plugin that analyzes inference result from the given dataset and selects samples for annotation(<https://github.com/openvinotoolkit/datumaro/pull/115>)
+- Sampler Plugin that analyzes inference result from the given dataset and
+  selects samples for annotation(<https://github.com/openvinotoolkit/datumaro/pull/115>)
 
 ### Changed
 - OpenVINO model launcher is updated for OpenVINO r2021.1 (<https://github.com/openvinotoolkit/datumaro/pull/100>)
 
 ### Deprecated
--
+- TBD
 
 ### Removed
--
+- TBD
 
 ### Fixed
 - High memory consumption and low performance of mask import/export, #53 (<https://github.com/openvinotoolkit/datumaro/pull/101>)
-- Masks, covered by class 0 (background), should be exported with holes inside (<https://github.com/openvinotoolkit/datumaro/pull/104>)
+- Masks, covered by class 0 (background), should be exported with holes inside
+(<https://github.com/openvinotoolkit/datumaro/pull/104>)
 - `diff` command invocation problem with missing class methods (<https://github.com/openvinotoolkit/datumaro/pull/117>)
 
 ### Security
--
+- TBD
 
 ## 01/23/2021 - Release v0.1.5
 ### Added
@@ -184,7 +193,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - `Dataset` class extended with new operations: `save`, `load`, `export`, `import_from`, `detect`, `run_model` (<https://github.com/openvinotoolkit/datumaro/pull/71>)
-- Allowed importing `Extractor`-only defined formats (in `Project.import_from`, `dataset.import_from` and CLI/`project import`) (<https://github.com/openvinotoolkit/datumaro/pull/71>)
+- Allowed importing `Extractor`-only defined formats
+  (in `Project.import_from`, `dataset.import_from` and CLI/`project import`) (<https://github.com/openvinotoolkit/datumaro/pull/71>)
 - `datum project ...` commands replaced with `datum ...` commands (<https://github.com/openvinotoolkit/datumaro/pull/84>)
 - Supported more image formats in `ImageNet` extractors (<https://github.com/openvinotoolkit/datumaro/pull/85>)
 - Allowed adding `Importer`-defined formats as project sources (`source add`) (<https://github.com/openvinotoolkit/datumaro/pull/86>)
@@ -194,18 +204,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `datum project ...` CLI context (<https://github.com/openvinotoolkit/datumaro/pull/84>)
 
 ### Removed
--
+- TBD
 
 ### Fixed
-- Allow plugins inherited from `Extractor` (instead of only `SourceExtractor`) (<https://github.com/openvinotoolkit/datumaro/pull/70>)
+- Allow plugins inherited from `Extractor` (instead of only `SourceExtractor`)
+  (<https://github.com/openvinotoolkit/datumaro/pull/70>)
 - Windows installation with `pip` for `pycocotools` (<https://github.com/openvinotoolkit/datumaro/pull/73>)
 - `YOLO` extractor path matching on Windows (<https://github.com/openvinotoolkit/datumaro/pull/73>)
 - Fixed inplace file copying when saving images (<https://github.com/openvinotoolkit/datumaro/pull/76>)
 - Fixed `labelmap` parameter type checking in `VOC` converter (<https://github.com/openvinotoolkit/datumaro/pull/76>)
 - Fixed model copying on addition in CLI (<https://github.com/openvinotoolkit/datumaro/pull/94>)
 
 ### Security
--
+- TBD
 
 ## 12/10/2020 - Release v0.1.4
 ### Added
@@ -218,29 +229,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Allow Pascal VOC to search in subdirectories (<https://github.com/openvinotoolkit/datumaro/pull/50>)
 
 ### Deprecated
--
+- TBD
 
 ### Removed
--
+- TBD
 
 ### Fixed
--
+- TBD
 
 ### Security
--
+- TBD
 
 ## 10/28/2020 - Release v0.1.3
 ### Added
 - `ImageNet` and `ImageNetTxt` dataset formats (<https://github.com/openvinotoolkit/datumaro/pull/41>)
 
 ### Changed
--
+- TBD
 
 ### Deprecated
--
+- TBD
 
 ### Removed
--
+- TBD
 
 ### Fixed
 - Default `label-map` parameter value for VOC converter (<https://github.com/openvinotoolkit/datumaro/pull/34>)
@@ -250,20 +261,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Supported empty attribute values in CVAT extractor (<https://github.com/openvinotoolkit/datumaro/pull/45>)
 
 ### Security
--
+- TBD
 
 
 ## 10/05/2020 - Release v0.1.2
 ### Added
-- `ByteImage` class to represent encoded images in memory and avoid recoding on save (<https://github.com/openvinotoolkit/datumaro/pull/27>)
+- `ByteImage` class to represent encoded images in memory and avoid recoding
+  on save (<https://github.com/openvinotoolkit/datumaro/pull/27>)
 
 ### Changed
 - Implementation of format plugins simplified (<https://github.com/openvinotoolkit/datumaro/pull/22>)
-- `default` is now a default subset name, instead of `None`. The values are interchangeable. (<https://github.com/openvinotoolkit/datumaro/pull/22>)
+- `default` is now a default subset name, instead of `None`. The values are
+  interchangeable. (<https://github.com/openvinotoolkit/datumaro/pull/22>)
 - Improved performance of transforms (<https://github.com/openvinotoolkit/datumaro/pull/22>)
 
 ### Deprecated
--
+- TBD
 
 ### Removed
 - `image/depth` value from VOC export (<https://github.com/openvinotoolkit/datumaro/pull/27>)
@@ -272,7 +285,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Zero division errors in dataset statistics (<https://github.com/openvinotoolkit/datumaro/pull/31>)
 
 ### Security
--
+- TBD
 
 
 ## 09/24/2020 - Release v0.1.1
@@ -282,19 +295,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - MOTS png mask format support (<https://github.com/openvinotoolkit/datumaro/21>)
 
 ### Changed
--
+- TBD
 
 ### Deprecated
--
+- TBD
 
 ### Removed
--
+- TBD
 
 ### Fixed
--
+- TBD
 
 ### Security
--
+- TBD
 
 
 ## 09/10/2020 - Release v0.1.0

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -259,4 +259,4 @@ def test_can_convert_polygons_to_mask(self):
       from polygon to mask.
     4. Verify that resulting segmentation mask is equal to the expected mask.
     """
-```
+```