Skip to content

Conversation

laurensgroeneveld
Copy link

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Provide a description in this PR that addresses what the PR is solving. If this PR is going to solve an existing issue, please reference the issue (e.g. close #123).

What is the purpose of this pull request?

  • Bug fix
  • New feature
  • Documentation update
  • Other

Description

Tiny fix: All files on this documentation page are Typescript files, but the example client config for the child theme is client.js instead of client.ts, even though the example client config above it is also a TS file.

@meteorlxy
Copy link
Member

Hi, thanks for your contribution.

For this part, it was intentionally written as .js extension. As a theme author, you are likely to publish your theme to npm. Before publishing, you'd better transpile the ts source code into js code, then the filename should be .js.

Maybe we should add some description here.

@laurensgroeneveld
Copy link
Author

Ah, that makes sense 👍 I was working on child theme for the default theme so had already copied the client.ts example. A comment explaining why it is .js here would be helpful!

@meteorlxy meteorlxy closed this in bd2657e Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants