Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
fastify-tsconfig
Advanced tools
Shared TypeScript configuration for fastify projects
$ npm install --save-dev fastify-tsconfig
Create your own tsconfig.json
in the projects' root folder and extend it from fastify-tsconfig
, overriding or adding the desired settings. By default, no outDir
is set (because of this issue), so be sure to add one.
This configuration sets "module"
and "moduleResolution"
to NodeNext
. This means that TypeScript will read the nearest package.json
file in the scope and search for the "type"
field or the absence of it.
If type
is not set or is "type": "commonjs"
the emitted code will be CommonJS, with .js
extension. Moreover, tsc
will complain if ESM-only properties/features are used in source files. If you want to emit .mjs
files, use the .mts
extension.
On the other hand, if "type": "module"
is set, the sources will be compiled to the ESM with the .js
extension. In this case, if you want to emit .cjs
files, use the .cts
extension for the source file.
The "following the Node.js rules" goes also for the package.json
exports
field. If type
is set, regardless of the value, TypeScript will check the exports
field to know where the compiled code and the types are located. If the type
field is not set, it will check for the main
and types
fields.
package.json
{
"name": "my-package",
"type": "commonjs",
"main": "dist/index.js", // this is for older Node.js versions
"types": "dist/index.d.ts", // this is optional and can be omitted
"exports": {
"import": "./dist/index.js",
"require": "./dist/index.js",
"types": "./dist/index.d.ts" // this is optional and can be omitted
}
}
tsconfig.json
{
"extends": "fastify-tsconfig",
"compilerOptions": {
"outDir": "dist",
"sourceMap": true
},
"include": [
"src/**/*.ts"
]
}
package.json
{
"name": "my-package",
"type": "module",
"main": "dist/index.js", // this is for older Node.js versions
"types": "dist/index.d.ts", // this is optional and can be omitted
"exports": {
"import": "./dist/index.js",
"require": "./dist/index.js",
"types": "./dist/index.d.ts" // this is optional and can be omitted
}
}
tsconfig.json
{
"extends": "fastify-tsconfig",
"compilerOptions": {
"outDir": "dist",
"sourceMap": true
},
"include": [
"src/**/*.ts"
]
}
Depending on the type of the project, you should add the following settings.
tsconfig.json
{
"extends": "fastify-tsconfig",
"compilerOptions": {
"outDir": "dist",
"sourceMap": true
},
"include": [
"src/**/*.ts"
]
}
tsconfig.json
{
"extends": "fastify-tsconfig",
"compilerOptions": {
"outDir": "dist",
"declaration": true
},
"include": [
"src/**/*.ts"
]
}
tsconfig.json
{
"extends": "fastify-tsconfig",
"compilerOptions": {
"outDir": "dist",
"declarationMap": true,
"composite": true
},
"include": [
"src/**/*.ts"
]
}
Check the other settings here
The configuration targets ES2022, which is supported in Node.js 16 and later. Only one feature still needs to be implemented: RegExp Match Indices shows up in flags. However, using ES2022 as a target makes widely used features not being compiled. To target an older version, override the target
property.
Licensed under MIT.
Inspired by: sindresorhus/tsconfig
FAQs
Shared TypeScript configuration
The npm package fastify-tsconfig receives a total of 18,456 weekly downloads. As such, fastify-tsconfig popularity was classified as popular.
We found that fastify-tsconfig demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.