Added new TypeScript rules #2106

Alex-NRCan · 2024-05-08T19:13:52Z

Description

This PR adds new TypeScript rules to facilitate development and implement best practices.

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

Hosting May 9th 8h50: https://alex-nrcan.github.io/geoview/

Checklist:

I have build (rush build) and deploy (rush host) my PR
I have connected the issues(s) to this PR
My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
My changes generate no new warnings
I have created new issue(s) related to the outcome of this PR is needed
~~I have made corresponding changes to the documentation~~
~~I have added tests that prove my fix is effective or that my feature works~~
~~New and existing unit tests pass locally with my changes~~

This change is

jolevesq

Reviewed 82 of 86 files at r1, 4 of 5 files at r2, 1 of 2 files at r3, 1 of 1 files at r4, 13 of 13 files at r5, 1 of 1 files at r6, all commit messages.
Reviewable status: all files reviewed, 9 unresolved discussions (waiting on @Alex-NRCan and @ychoquet)

packages/geoview-core/src/api/config/uuid-config-reader.ts line 117 at r3 (raw file):

  }

  // TODO: Check - Commented out as not called anymore by method `getGVConfigFromUUIDs`, but maybe it should still?

Like we discuss it should be called, we will update in a next PR

packages/geoview-core/src/api/config/types/classes/sub-layer-config/config-base-class.ts line 23 at r3 (raw file):

  /** Used internally to distinguish layer groups derived from the metadata. */
  // #isMetadataLayerGroup?: false;

Can we put a TODO so we do not loose dead code

packages/geoview-core/src/core/components/common/layer-title.tsx line 35 at r5 (raw file):

}

// TODO: Refactor - Remove defaltProps as it's no longer a good practice

typo defaultProps

packages/geoview-core/src/core/components/common/layout.tsx line 79 at r5 (raw file):

}

// TODO: Refactor - Remove defaltProps as it's no longer a good practice

typo defaultProps

packages/geoview-core/src/core/components/common/responsive-grid.tsx line 138 at r5 (raw file):

};

// TODO: Refactor - Remove defaltProps as it's no longer a good practice

typo defaultProps

packages/geoview-core/src/core/components/common/responsive-grid-layout.tsx line 326 at r5 (raw file):

ResponsiveGridLayout.displayName = 'ResponsiveGridLayout';

// TODO: Refactor - Remove defaltProps as it's no longer a good practice

replace all...

packages/geoview-core/src/core/components/footer-bar/footer-bar.tsx line 6 at r3 (raw file):

import { Box, IconButton, Tabs, TypeTabs, MoveDownRoundedIcon, MoveUpRoundedIcon } from '@/ui';
import { api } from '@/app';

Another remove of api... yeah!

packages/geoview-core/src/geo/layer/geoview-layers/raster/esri-dynamic.ts line 437 at r3 (raw file):

   * the feature.
   */
  private static countFieldOfTheSameValue(styleSettings: TypeUniqueValueStyleConfig): TypeFieldOfTheSameValue[][] {

Should we put private #?

packages/geoview-core/src/geo/layer/geoview-layers/vector/ogc-feature.ts line 95 at r3 (raw file):

export class OgcFeature extends AbstractGeoViewVector {
  // private variable holding wfs version
  // private version = '2.0.0';

If not use, should we remove or put a TODO?

Alex-NRCan

Reviewed 85 of 86 files at r1, 5 of 5 files at r2, 1 of 2 files at r3, 1 of 1 files at r4, 13 of 13 files at r5, 1 of 1 files at r6, 16 of 16 files at r7.
Reviewable status: all files reviewed (commit messages unreviewed), 6 unresolved discussions (waiting on @jolevesq and @ychoquet)

packages/geoview-core/src/api/config/uuid-config-reader.ts line 117 at r3 (raw file):