This PR fixes linting where npm run lint runs without erroring out. New linting rules were added in .eslintrc.json:
variables are expected to be camelCase or UPPER_CASE
functions are expected to be camelCase
Interfaces are expected to be PascalCase and prefixed with I
This PR also updates the CI to use npm install --force instead of npm install. This is because there are peer dependency issues between typedoc-plugin-nojekyll and typedoc-plugin-external-module-map, where both have typedoc listed as a peer dependency, but with conflicting versions. typedoc-plugin-nojekyll looks for v0.11.1 of typedoc and typedoc-plugin-external-module-map looks for typedoc with versioning >=0.14 <1.0. Unfortunately upgrading these dependency versions does not resolve this issue as typedoc-plugin-nojekyll is no longer being actively maintained, the last release/commit being 5 years ago.
This PR fixes linting where
npm run lint
runs without erroring out. New linting rules were added in.eslintrc.json
:camelCase
orUPPER_CASE
camelCase
PascalCase
and prefixed withI
This PR also updates the CI to use
npm install --force
instead ofnpm install
. This is because there are peer dependency issues betweentypedoc-plugin-nojekyll
andtypedoc-plugin-external-module-map
, where both havetypedoc
listed as a peer dependency, but with conflicting versions.typedoc-plugin-nojekyll
looks forv0.11.1
oftypedoc
andtypedoc-plugin-external-module-map
looks fortypedoc
with versioning>=0.14 <1.0
. Unfortunately upgrading these dependency versions does not resolve this issue astypedoc-plugin-nojekyll
is no longer being actively maintained, the last release/commit being 5 years ago.