https://github.com/effect-ts/dtslint
Effect's custom fork of dtslint used to lint TypeScript declaration (.d.ts) files
https://github.com/effect-ts/dtslint
Last synced: 11 months ago
JSON representation
Effect's custom fork of dtslint used to lint TypeScript declaration (.d.ts) files
- Host: GitHub
- URL: https://github.com/effect-ts/dtslint
- Owner: Effect-TS
- Archived: true
- Created: 2023-05-25T11:36:31.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-23T16:09:09.000Z (over 1 year ago)
- Last Synced: 2025-07-29T10:23:17.732Z (11 months ago)
- Language: TypeScript
- Homepage:
- Size: 85 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Disclaimer
> [!WARNING]
> This tool is not intended for public consumption, so we may break the API whenever convenient for us.
# Setting up the Environment
To get started with `dtslint`, follow these steps to set up your development environment:
## 1. Create a `dtslint` Folder
Begin by creating a folder named `dtslint`. This folder will be the home for your TypeScript declaration files (`.d.ts`) and configuration.
## 2. Configure TypeScript
Inside the `dtslint` folder, create a `tsconfig.json` file. Here's an example of what it should contain:
```json
{
"compilerOptions": {
"skipLibCheck": true,
"noEmit": true,
"strict": true
}
}
```
This configuration file is essential for TypeScript to understand how to handle your declaration files during linting.
## 3. Add Test Files
Place your TypeScript declaration files that you want to lint inside the `dtslint` folder. These files will be checked for correct TypeScript typings.
## 4. Update `package.json`
Finally, update your project's `package.json` file with the following scripts:
```json
{
"scripts": {
"dtslint": "dtslint",
"dtslint-clean": "dtslint --clean"
}
}
```
These scripts allow you to run `dtslint` and perform necessary linting checks on your TypeScript declaration files.
Flags:
- `--clean`: Clears all installations, ensuring a clean slate for subsequent operations.