refactor: use eslint-config-standard-with-typescript

Also removes lint definitions that are exactly as the config.

Author: EdJoPaTo

.eslintrc.cjs

@@ -11,16 +11,18 @@ module.exports = {
   plugins: [
     '@typescript-eslint',
   ],
+  parserOptions: {
+    project: './tsconfig.json'
+  },
   extends: [
     // See https://github.com/standard/eslint-config-standard/blob/master/eslintrc.json
-    'standard',
+    'standard-with-typescript',
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
   ],
   rules: {
     'array-bracket-spacing': [ 'error', 'always' ],
     'arrow-parens': [ 'error', 'as-needed' ],
-    'comma-dangle': 'off',
     '@typescript-eslint/comma-dangle': [ 'error', 'always-multiline' ],
     eqeqeq: [ 'error', 'smart' ],
     'implicit-arrow-linebreak': [ 'error', 'beside' ],
@@ -36,28 +38,26 @@ module.exports = {
         alphabetize: { order: 'asc' },
       },
     ],
-    'indent': 'off',
     '@typescript-eslint/indent': [ 'error', 2, { MemberExpression: 'off' } ],
     'no-var': [ 'error' ],
-    // Primarily to avoid false positive with interfaces declarations
-    // See https://github.com/typescript-eslint/typescript-eslint/issues/1262
-    'no-use-before-define': 'off',
-    '@typescript-eslint/no-use-before-define': 'off',
     'nonblock-statement-body-position': [ 'error', 'beside' ],
-    'object-curly-spacing': 'off',
-    '@typescript-eslint/object-curly-spacing': [ 'error', 'always' ],
     'object-shorthand': [ 'error', 'properties' ],
     'prefer-arrow-callback': [ 'error' ],
-    'prefer-const': [ 'error' ],
     'prefer-rest-params': 'off',
+
+    // TODO remove (= enable these lints and fix the issues)
     '@typescript-eslint/ban-ts-comment': [ 'error', {
       'ts-expect-error': false, // TODO: "allow-with-description",
       'ts-nocheck': false,
     } ],
-    '@typescript-eslint/consistent-type-imports': [ 'error', { prefer: 'type-imports' } ],
+    '@typescript-eslint/explicit-function-return-type': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
-    semi: 'off',
-    '@typescript-eslint/semi': [ 'error', 'never' ],
+    '@typescript-eslint/restrict-plus-operands': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+
+    // Enable when strict or strictNullChecks is enabled in tsconfig
+    '@typescript-eslint/prefer-nullish-coalescing': 'off',
+    '@typescript-eslint/strict-boolean-expressions': 'off',
   },
   globals: {
     // Mocha globals

package-lock.json

@@ -65,7 +65,7 @@
     "@typescript-eslint/parser": "^5.49.0",
     "@vercel/git-hooks": "^1.0.0",
     "eslint": "^8.32.0",
-    "eslint-config-standard": "^17.0.0",
+    "eslint-config-standard-with-typescript": "^34.0.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-promise": "^6.1.1",

package.json

@@ -1,6 +1,6 @@
 import type { SimplifiedSparqlResultMinified, SimplifiedSparqlResultRecord, SimplifiedSparqlResults, SparqlResults, SparqlValueObj, SparqlValueRaw, SparqlValueType } from '../types/sparql.js'
 
-export type SimplifySparqlResultsOptions = {
+export interface SimplifySparqlResultsOptions {
   readonly minimize?: boolean
 }
 

src/helpers/simplify_sparql_results.ts

@@ -2,7 +2,7 @@ import { typedEntries } from '../utils/utils.js'
 import type { WmLanguageCode } from '../types/options.js'
 import type { Aliases, Descriptions, Glosses, Labels, Lemmas, Representations, SimplifiedAliases, SimplifiedDescriptions, SimplifiedGlosses, SimplifiedLabels, SimplifiedLemmas, SimplifiedRepresentations } from '../types/terms.js'
 
-type InValue<T> = { readonly value: T }
+interface InValue<T> { readonly value: T }
 
 function singleValue<V> (data: Partial<Readonly<Record<WmLanguageCode, InValue<V>>>>) {
   const simplified: Partial<Record<WmLanguageCode, V>> = {}

src/helpers/simplify_text_attributes.ts

@@ -3,7 +3,7 @@ import { isEntityId, isEntityPageTitle, isPropertyId, isRevisionId } from './hel
 /** Ensure both via TypeScript and at runtime that the input value is of the expected type. Throws error when it is not */
 function validate<T extends string> (name: string, testFn: (value: string) => value is T) {
   return function (value: T): void {
-    if (!testFn(value)) throw new Error(`invalid ${name}: ${value}`)
+    if (!testFn(value)) throw new Error(`invalid ${name}: ${String(value)}`)
   }
 }
 

src/helpers/validate.ts

@@ -64,20 +64,20 @@ export function cirrusSearchPagesFactory (buildUrl: BuildUrlFunction) {
     }
 
     if (profile != null && typeof profile !== 'string') {
-      throw new Error(`invalid profile: ${profile} (${typeof profile}, expected string)`)
+      throw new Error(`invalid profile: ${String(profile)} (${typeof profile}, expected string)`)
     }
 
     if (sort != null && typeof sort !== 'string') {
-      throw new Error(`invalid sort: ${sort} (${typeof sort}, expected string)`)
+      throw new Error(`invalid sort: ${String(sort)} (${typeof sort}, expected string)`)
     }
 
-    let srprop
+    let srprop: string
     if (prop != null) {
       if (prop instanceof Array) prop = prop.join('|')
       if (typeof prop !== 'string') {
-        throw new Error(`invalid prop: ${prop} (${typeof prop}, expected string)`)
+        throw new Error(`invalid prop: ${String(prop)} (${typeof prop}, expected string)`)
       }
-      srprop = prop.toString()
+      srprop = prop
     }
 
     return buildUrl({

src/queries/cirrus_search.ts

@@ -29,7 +29,7 @@ export function getEntitiesFactory (buildUrl: BuildUrlFunction) {
     // Allow to pass ids as a single string
     ids = forceArray(ids)
 
-    ids.forEach(o => validate.entityId(o))
+    ids.forEach(o => { validate.entityId(o) })
 
     if (ids.length > 50) {
       console.warn(`getEntities accepts 50 ids max to match Wikidata API limitations:
@@ -48,6 +48,8 @@ export function getEntitiesFactory (buildUrl: BuildUrlFunction) {
       format,
     }
 
+    // Only specify 'no' when explictly false. Eslint ignores the fact that redirects could be undefined too.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-boolean-literal-compare
     if (redirects === false) query.redirects = 'no'
 
     if (languages) {

src/queries/get_entities.ts

@@ -58,6 +58,8 @@ export function getEntitiesFromSitelinksFactory (buildUrl: BuildUrlFunction) {
       query.props = props.join('|')
     }
 
+    // Only specify 'no' when explictly false. Eslint ignores the fact that redirects could be undefined too.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-boolean-literal-compare
     if (redirects === false) query.redirects = 'no'
 
     return buildUrl(query)

src/queries/get_entities_from_sitelinks.ts

@@ -31,7 +31,7 @@ export const getReverseClaimsFactory = (sparqlEndpoint: Url) => {
 
     // Allow to request values for several properties at once
     properties = forceArray(properties)
-    properties.forEach(o => validate.propertyId(o))
+    properties.forEach(o => { validate.propertyId(o) })
 
     const valueBlock = getValueBlock(values, valueFn, properties, filter)
     let sparql = `SELECT DISTINCT ?subject WHERE { ${valueBlock} }`