avajs/ava

Provide type definitions for the JS configuration files.

Open

#3.042 geöffnet am 2. Juni 2022

Auf GitHub ansehen
 (3 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)JavaScript (20.600 Stars) (1.408 Forks)batch import
enhancementhelp wantedscope:typescript

Beschreibung

Continuing https://github.com/avajs/typescript/issues/15#issuecomment-1140477835 cc @novemberborn

Summary

When a user configures AVA with JavaScript, it would be useful to have type definition. Users might consume these through JSDoc comments, or through a typed wrapper function.

Details

A wrapper function would be defined like this:

/**
 *
 * Configure AVA, with intellisense
 *
 * @param {Config} config - A configuration object
 * @returns {Config}
 */
export const defineConfig = (config) => config;

The function would be used like this:

import { defineConfig } from 'ava/config';

export default defineConfig({
  // ...
})

Contributor Guide

Tech Stack
javascripttypescript
Domain
developer experiencetooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
TypeScriptAVA configuration
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75
Research-Richtung
Examine the existing type definitions in the avajs/typescript repository for guidance. Look at the AVA configuration schema (likely in readme or source). Implement type definitions for the config object, either via JSDoc in the JS config files or by creating a wrapper function exported from ava/config. Ensure compatibility with TypeScript strict mode. Test the definitions with a sample config file.