Gathering detailed insights and metrics for gatsby-plugin-ts-config
Gathering detailed insights and metrics for gatsby-plugin-ts-config
Configure Gatsby to use typescript configuration files
Installations
npm install gatsby-plugin-ts-configDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
12.21.0
NPM Version
6.14.11
Releases
15
Languages
2
TypeScript
JavaScript
TypeScript (99.38%)
JavaScript (0.62%)
Developer
Js-Brecht
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
59 Stars
318 Commits
5 Forks
2 Watchers
8 Branches
2 Contributors
Updated on Jun 06, 2025
Maintainers
1
Package Meta Information
Latest Version
2.1.3
Package Id
gatsby-plugin-ts-config@2.1.3
Size
34.89 kB
NPM Version
6.14.11
Node Version
12.21.0
Published on
Oct 04, 2021
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
22
@babel/core@babel/plugin-proposal-nullish-coalescing-operator@babel/plugin-proposal-optional-chaining@babel/plugin-syntax-dynamic-import@babel/plugin-transform-runtime@babel/plugin-transform-typescript@babel/preset-env@babel/preset-flow@babel/preset-react@babel/preset-typescript@babel/register@babel/runtimebabel-plugin-dynamic-import-nodecallsitesenhanced-resolvefind-upfs-extralodashserialize-errorts-nodetslogtype-fest
Peer Dependencies
2
Configure Gatsby to use Typescript for configuration files
This plugin will allow you to write your
gatsby-*configuration files in Typescript.
For v1 documentation, see the old docs
Installation
-
Install using your package manager
1npm install -D gatsby-plugin-ts-config
Usage
The cleanest way to use this plugin is to use gatsby-config.js and gatsby-node.js
as pointers to your .ts files that you keep in another directory. This isn't required,
though. All you need initially is gatsby-config.js
To point gatsby-config.js and/or gatsby-node.js to .ts files:
1// gatsby-config.js 2const { useGatsbyConfig } = require("gatsby-plugin-ts-config"); 3 4// For static analysis purposes, you can use a callback with a require() statement 5module.exports = useGatsbyConfig(() => require("./config/gatsby-config"), opts); 6 7// A simpler method is to just use the filename 8module.exports = useGatsbyConfig("./config/gatsby-config", opts); 9 10// Or you can just return the `gatsby-config` object from the callback 11module.exports = useGatsbyConfig( 12 () => ({ 13 siteMetadata: { 14 ... 15 }, 16 plugins: [ 17 { 18 resolve: ..., 19 options: ..., 20 } 21 ] 22 }), 23 opts 24)
Once useGatsbyConfig is called from gatsby-config, gatsby-node.ts can exist in your site's
root directory. However, if you do not wish to have your gatsby-config in Typescript, useGatsbyConfig is
not required. You can use this plugin directly from gatsby-node if you wish.
1// gatsby-node.js 2const { useGatsbyNode } = require("gatsby-plugin-ts-config"); 3 4// All of the same usage patterns for `useGatsbyConfig` are valid for `useGatsbyNode` 5// as well 6module.exports = useGatsbyNode(() => require("./config/gatsby-node"), opts);
Options
-
props:ObjectThis "property bag" is an object that can take any shape you wish. When a
gatsby-*module is defined with a function for a default export, thesepropswill be passed in the second parameter.The property bag is mutable, so any changes you make to it will be passed to the next module
- Each project gets its own property bag. They do not mix, which means
propsdefined by your default site will not be passed down to plugins.- One difference when using local plugins: The property bag will be copied and then passed to the local plugin.
- If
propsis defined in bothuseGatsbyConfiganduseGatsbyNode, the values inuseGatsbyNodewill be merged into the property bag before being passed on to default export of the module.
- Each project gets its own property bag. They do not mix, which means
-
type:"babel" | "ts-node"Determines which transpiler to use.
-
transpilerOptions:ObjectAny additional options you'd like to provide to the transpiler
- When
type === "babel": See the babel options documentation - When
type === "ts-node": See the ts-node options documentation
- When
-
hooks:ObjectAllows you to hook into certain processes.
-
ignore:Array<IgnoreHookFn>IgnoreHookFn = (filename: string, origIgnore: boolean) => booleanOverride the rule set used to tell the transpiler to ignore files.
-
Receives two parameters:
- The file name to check (fully qualified)
- The original ignore value
-
Return a falsy or truthy value. It will be converted to boolean.
-
To use the value that would have been chosen by the internal process, return the second parameter.
-
The first
trueor truthy value to be returned from your rule set will be used. The rest of the rule set will be ignored
-
-
Default exports
The default export is supported for your gatsby-*.ts files. This is important to note, because Typescript
prefers that you use either the default export, or named exports.
While named exports are absolutely supported as well, some people may prefer to build their module object and then export it all at once. In that case, you may use the default export.
In other cases, you may want to perform some more advanced actions during the module processing. For this,
you may export a function as the default export. They will be called in order
(gatsby-config -> gatsby-node), and used to set the module's exports so that Gatsby can read them.
Default export function
gatsby-config.ts or gatsby-node.ts may export a function as the default export. This will be called with
some details regarding the transpiling process, as well as some helpful information about the current project.
These modules may export this function as the default export whether or not they are in the root of your
site, as is the Gatsby standard. However, since this plugin needs to get kicked off by one of the
useGatsby* plugins, gatsby-config may not be accessible from the root.
These functions should return the object that Gatsby generally expects. For gatsby-config, it would be
the same object you would define in gatsby-config.js. For gatsby-node, it would be the gatsby-node
APIs.
Function parameters
The default export function will receive two parameters:
-
The transpiler & project information
projectRoot: The absolute path to the current project.imports: All of the imports used by yourgatsby-*modules.- This is structured by API Type, and then by plugin + API Type
config:string[]node:string[]plugins:Object[pluginName: string]:Objectconfig:string[]node:string[]
- This is structured by API Type, and then by plugin + API Type
-
The property bag defined in the bootstrap (
useGatsby*) functions.
Contributing / Issues
If you feel a feature is missing, or you find a bug, please feel free to file an issue at https://github.com/Js-Brecht/gatsby-plugin-ts-config/issues.
I would also welcome any additions anybody would like to make.
Donations
If you enjoyed using this plugin, and you'd like to help support its development, you're welcome to donate!
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/12 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 22 are checked with a SAST tool
Reason
121 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-c2jc-4fpr-4vhg
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
- Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
- Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-7gc6-qh9x-w6h8
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-fp36-299x-pwmw
- Warn: Project is vulnerable to: GHSA-wm7h-9275-46v2
- Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
- Warn: Project is vulnerable to: GHSA-273r-mgr4-v34f
- Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-mhxj-85r3-2x55
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-c6f8-8r25-c4gc
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-33f9-j839-rf8h
- Warn: Project is vulnerable to: GHSA-c36v-fmgq-m8hx
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
- Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
- Warn: Project is vulnerable to: GHSA-44fp-w29j-9vj5
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
- Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
- Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
- Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
- Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
- Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
- Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-cwx2-736x-mf6w
- Warn: Project is vulnerable to: GHSA-v39p-96qg-c8rf
- Warn: Project is vulnerable to: GHSA-8v63-cqqc-6r2c
- Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
- Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
- Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
- Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
- Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
- Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
- Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
- Warn: Project is vulnerable to: GHSA-6fx8-h7jm-663j
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
- Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
- Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
- Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
- Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
- Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
- Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
- Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
- Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
- Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
- Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
- Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Score
1.7
/10
Last Scanned on 2025-07-14
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More