Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature(gatsby): Support TypeScript by default by compiling TS files #23547

Merged
merged 15 commits into from
May 5, 2020
Merged

feature(gatsby): Support TypeScript by default by compiling TS files #23547

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
183c3fd
feature(gatsby): Support TypeScript by default by compiling TS files
blainekasten Apr 28, 2020
d548ed0
add a test to ensure we arent adding an extra gatsby-plugin-typescript
blainekasten Apr 28, 2020
d706214
Make a TypeScript file in gatsby-starter
blainekasten Apr 30, 2020
762e585
Add TypeScript example to blog starter
blainekasten Apr 30, 2020
41b1354
Update Using Typescript example
blainekasten Apr 30, 2020
d3561ab
update gatsby-plugin-typescript README.md
blainekasten Apr 30, 2020
d804992
Add Basic TypeScript example
blainekasten Apr 30, 2020
9e760f8
Update packages/gatsby-plugin-typescript/README.md
blainekasten May 1, 2020
f7d5704
Update packages/gatsby-plugin-typescript/README.md
blainekasten May 1, 2020
f50c61a
Add more to the TS docs
blainekasten May 1, 2020
5d293d1
Merge branch 'typescript-by-default/compile-ts' of https://github.com…
blainekasten May 1, 2020
2d79b05
Add docs to sidebar
blainekasten May 1, 2020
4e89725
Use you as the pronoun
May 1, 2020
2e74c8e
merge master
blainekasten May 5, 2020
3a5795f
Fix e2e test
blainekasten May 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 ...velopment-runtime/src/components/title.js → ...elopment-runtime/src/components/title.tsx
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions packages/gatsby/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
"gatsby-core-utils": "^1.2.0",
"gatsby-graphiql-explorer": "^0.4.0",
"gatsby-link": "^2.4.0",
"gatsby-plugin-typescript": "^2.4.0",
"gatsby-plugin-page-creator": "^2.3.0",
"gatsby-react-router-scroll": "^2.3.0",
"gatsby-telemetry": "^1.3.0",
Expand Down
48 changes: 48 additions & 0 deletions packages/gatsby/src/bootstrap/load-plugins/__tests__/__snapshots__/load-plugins.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,22 @@ Array [
"ssrAPIs": Array [],
"version": "1.0.0",
},
Object {
"browserAPIs": Array [],
"id": "",
"name": "gatsby-plugin-typescript",
"nodeAPIs": Array [
"resolvableExtensions",
"onCreateBabelConfig",
"onCreateWebpackConfig",
],
"pluginOptions": Object {
"plugins": Array [],
},
"resolve": "",
"ssrAPIs": Array [],
"version": "1.0.0",
},
Object {
"browserAPIs": Array [],
"id": "",
Expand Down Expand Up @@ -381,6 +397,22 @@ Array [
"ssrAPIs": Array [],
"version": "1.0.0",
},
Object {
"browserAPIs": Array [],
"id": "",
"name": "gatsby-plugin-typescript",
"nodeAPIs": Array [
"resolvableExtensions",
"onCreateBabelConfig",
"onCreateWebpackConfig",
],
"pluginOptions": Object {
"plugins": Array [],
},
"resolve": "",
"ssrAPIs": Array [],
"version": "1.0.0",
},
Object {
"browserAPIs": Array [],
"id": "",
Expand Down Expand Up @@ -601,6 +633,22 @@ Array [
"ssrAPIs": Array [],
"version": "1.0.0",
},
Object {
"browserAPIs": Array [],
"id": "",
"name": "gatsby-plugin-typescript",
"nodeAPIs": Array [
"resolvableExtensions",
"onCreateBabelConfig",
"onCreateWebpackConfig",
],
"pluginOptions": Object {
"plugins": Array [],
},
"resolve": "",
"ssrAPIs": Array [],
"version": "1.0.0",
},
Object {
"browserAPIs": Array [],
"id": "",
Expand Down
72 changes: 72 additions & 0 deletions packages/gatsby/src/bootstrap/load-plugins/__tests__/load-plugins.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,76 @@ describe(`Load plugins`, () => {

expect(plugins).toMatchSnapshot()
})

describe(`TypeScript support`, () => {
it(`loads gatsby-plugin-typescript if not provided`, async () => {
const config = {
plugins: [],
}

let plugins = await loadPlugins(config)

plugins = replaceFieldsThatCanVary(plugins)
Copy link
Contributor

@wardpeet wardpeet Apr 28, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to create a different helper function here? The one that exists now also check paths property and might cause weird test failures when we might move more plugins as a default.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. Do you have any suggestions? It seems to work right now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the same setup we have for gatsby-source-page-creators

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe replaceFieldsThatCanVary should also just do more checks before trying to do pluginOptions.path sanitization (apply it only for gatsby-plugin-page-creator)?

But this doesn't seem to be concern of this pull request?


expect(plugins).toEqual(
expect.arrayContaining([
expect.objectContaining({
browserAPIs: [],
id: ``,
name: `gatsby-plugin-typescript`,
nodeAPIs: [
`resolvableExtensions`,
`onCreateBabelConfig`,
`onCreateWebpackConfig`,
],
pluginOptions: {
plugins: [],
},
resolve: ``,
ssrAPIs: [],
version: `1.0.0`,
}),
])
)
})

it(`uses the user provided plugin-typescript if provided`, async () => {
const config = {
plugins: [
{
resolve: `gatsby-plugin-typescript`,
options: {
jsxPragma: `h`,
},
},
],
}

let plugins = await loadPlugins(config)

plugins = replaceFieldsThatCanVary(plugins)

expect(plugins).toEqual(
expect.arrayContaining([
expect.objectContaining({
browserAPIs: [],
id: ``,
name: `gatsby-plugin-typescript`,
nodeAPIs: [
`resolvableExtensions`,
`onCreateBabelConfig`,
`onCreateWebpackConfig`,
],
pluginOptions: {
plugins: [],
jsxPragma: `h`,
},
resolve: ``,
ssrAPIs: [],
version: `1.0.0`,
}),
])
)
blainekasten marked this conversation as resolved.
Show resolved Hide resolved
})
})
})
9 changes: 9 additions & 0 deletions packages/gatsby/src/bootstrap/load-plugins/load.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,15 @@ const loadPlugins = (config = {}, rootDir = null) => {
}
}

// TypeScript support by default! use the user-provided one if it exists
const typescriptPlugin = (config?.plugins || []).find(
plugin => plugin.resolve === `gatsby-plugin-typescript`
) || {
resolve: require.resolve(`gatsby-plugin-typescript`),
}

plugins.push(processPlugin(typescriptPlugin))
blainekasten marked this conversation as resolved.
Show resolved Hide resolved

plugins.push(
processPlugin({
resolve: require.resolve(`gatsby-plugin-page-creator`),
Expand Down