16 | Gatsby supports TypeScript by default!
18 | This means that you can create and write .ts/.tsx files for your pages, components etc. Please note that the gatsby-*.js files (like gatsby-node.js) currently don't support TypeScript yet.
19 | For type checking you'll want to install typescript via npm and run tsc --init to create a .tsconfig file.
20 | You're currently on the page "{path}" which was built on {data.site.buildTime}.
21 | To learn more, head over to our documentation about TypeScript .
22 |
24 | )
25 |
26 | export default UsingTypescript
27 |
28 | export const query = graphql`
29 | {
30 | site {
31 | buildTime(formatString: "YYYY-MM-DD hh:mm a z")
32 | }
33 | }
34 | `
35 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # gatsby-config
2 | This plugin adds intellisense and autocompletion to `gatsby-config.js` for plugins in the plugins array! It makes Gatsby plugin API's discoverable :)
3 |
4 | Watch this video for a demo https://youtu.be/sGLlEcleumg
5 |
6 | 
7 |
8 | 
9 |
10 | ## Setting it up
11 |
12 | In `gatsby-config.js` add the following:
13 |
14 | ```js
15 | const gatsbyConfig = require(`gatsby-config`)
16 |
17 | module.exports = gatsbyConfig({
18 | plugins: [
19 | `gatsby-config`,
20 | // add any other plugins here
21 | ]
22 | })
23 | ```
24 |
25 | Now when you run `gatsby develop`, typescript types will be generated for any Gatsby plugins you have installed that implement the `pluginOptionsSchema` Node API (see https://www.gatsbyjs.com/docs/node-apis/#pluginOptionsSchema for more info). Those types will be added to the `gatsbyConfig` helper seen in the example above and that will enable intellisense and autocompletion for those plugins.
26 |
27 | If you're using an IDE which automatically uses TypeScript types for intellisense (like VSCode), you'll be able to use autocompletion and the intellisense dropdown to discover plugin options and read their descriptions and the expected types of values.
28 |
29 |
--------------------------------------------------------------------------------
/example-site/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "gatsby-starter-default",
3 | "private": true,
4 | "description": "A simple starter to get up and developing quickly with Gatsby",
5 | "version": "0.1.0",
6 | "author": "Kyle Mathews 
5 |
6 |