This repository has been archived by the owner on Feb 18, 2024. It is now read-only.
feat: add typings for neutrino config and api #1468
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to: #1129 (comment)
Motivation: It's hard to work with Neutrino if there is no code editor intellisense or/and auto-completion. Even though,
.neutrinorc.js
is a JS file, we could use JSDocs to specify the type of the configuration object and get intellisense:PR:
– It adds typings for Neutrino api (class) and configuration
– It adds typings tests for TS
– It adds typings tests for JS (when using JSDocs)
Notes:
tsconfig.json
file hascheckJs
andallowJs
options set totrue
, so it works checking the types of JSDocs. Tests for JS typings are not extensive, just as good as they can be.This PR doesn't introduce any breaking changes.