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.

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

use Typescript instead of JS to improve dev productivity #2

Merged
merged 18 commits into from
May 14, 2024

Conversation

ben-zhang-at-salesforce
Copy link
Collaborator

  • bring in typescript setup for code and jest test.
  • convert the dummy first rule and test to typescript

package.json Outdated Show resolved Hide resolved
.eslintrc Outdated Show resolved Hide resolved
@khawkins
Copy link
Collaborator

khawkins commented May 8, 2024

I'm going to suggest a package structure change too: move all of the source files under src/, and reserve lib/ for the built package JS artifacts. This is a more standard layout for TypeScript projects.

@khawkins
Copy link
Collaborator

khawkins commented May 8, 2024

I'm going to suggest a package structure change too: move all of the source files under src/, and reserve lib/ for the built package JS artifacts. This is a more standard layout for TypeScript projects.

I see that we specify dist/ as the output dir in tsconfig.json, which is fine too. But I think our TS source files should go under src/.

package.json Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
Copy link
Collaborator

@khawkins khawkins left a comment

Choose a reason for hiding this comment

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

I think that's all I had!

@ben-zhang-at-salesforce
Copy link
Collaborator Author

I think that's all I had!

thanks for review it, learned a lot :)

@khawkins
Copy link
Collaborator

I think it doesn't matter in this moment because this repo will get flattened before we flip it to public, but: you need to have your GitHub commit signing configuration applied to this repo, so that your commits are signed. https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits

.gitignore Outdated Show resolved Hide resolved
@ben-zhang-at-salesforce
Copy link
Collaborator Author

I think it doesn't matter in this moment because this repo will get flattened before we flip it to public, but: you need to have your GitHub commit signing configuration applied to this repo, so that your commits are signed. https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits

sure, I will put it on my plate once we has 1 or two mature apex and graphql rule coded.

@khawkins
Copy link
Collaborator

Sorry, my point with tsconfig.tsbuildinfo was to put it in .gitignore. It's just a build artifact that can be ignored. It should not be committed to the project.

Copy link
Collaborator

@khawkins khawkins left a comment

Choose a reason for hiding this comment

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

I think this looks good as our first pass. We'll probably encounter configuration tweaks as we go, but this looks good to me.

@ben-zhang-at-salesforce ben-zhang-at-salesforce merged commit 7cb2113 into main May 14, 2024
17 checks passed
@ben-zhang-at-salesforce ben-zhang-at-salesforce deleted the toTypescript branch May 14, 2024 19:49
@salesforce salesforce deleted a comment from github-actions bot Jun 10, 2024
@salesforce salesforce deleted a comment from github-actions bot Jun 10, 2024
@salesforce salesforce deleted a comment from github-actions bot Jun 10, 2024
@salesforce salesforce deleted a comment from github-actions bot Jun 10, 2024
@salesforce salesforce deleted a comment from github-actions bot Jun 10, 2024
@salesforce salesforce deleted a comment from github-actions bot Jun 18, 2024
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.

None yet

2 participants