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

feat: update to current best practices #394

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

wolfy1339
Copy link
Member

  • Update esbuild to output ESM
  • Remove jest in favour of vitest
  • Don't add @types/node in the devDependencies to avoid having it leak into the outputted types

Resolves #ISSUE_NUMBER


Before the change?

After the change?

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

- Update esbuild to output ESM
- Remove jest in favour of vitest
- Don't add `@types/node` in the devDependencies to avoid having it leak into the outputted types
@wolfy1339 wolfy1339 added the Type: Feature New feature or request label Dec 28, 2024
Copy link

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

lib/create-package-json.js Show resolved Hide resolved
lib/create-vitest-config.js Show resolved Hide resolved
test: {
coverage: {
include: ["src/**/*.ts"],
exclude: ["src/methods/get-oauth-client-code.ts"], // Exclude this file from coverage as it isn't exported
Copy link
Member

Choose a reason for hiding this comment

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

Do we need this?

Copy link
Member Author

Choose a reason for hiding this comment

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

Nope

lib/create-esbuild-script.js Show resolved Hide resolved
lib/create-esbuild-script.js Show resolved Hide resolved
lib/create-esbuild-script.js Show resolved Hide resolved
lib/create-esbuild-script.js Show resolved Hide resolved
@@ -3,14 +3,14 @@ export { createEsbuildScript };
import { writePrettyFile } from "./write-pretty-file.js";

async function createEsbuildScript(answers) {
const nodeBuildOptions = ` // Build a CJS Node.js bundle
const nodeBuildOptions = ` // Build an ESM Node.js bundle
Copy link
Member

Choose a reason for hiding this comment

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

I feel we are at a point where we should test the output of running this script is the expected one. Do you think it's worth investing in this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature New feature or request
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

2 participants