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: oclif #962

Draft
wants to merge 112 commits into
base: next
Choose a base branch
from
Draft

feat: oclif #962

wants to merge 112 commits into from

Conversation

kanadgupta
Copy link
Member

@kanadgupta kanadgupta commented Jan 11, 2024

🧰 Changes

Outstanding tasks:

  • Test coverage around hooks (namely the prerun hook and the --key flag handling)
  • Issues mocking certain functions
  • Getting a build working for GitHub Actions runners

Non-blocking outstanding tasks:

  • Consolidate styling on outputs
    • Debug outputs
    • Error outputs
    • Warning outputs
    • Info outputs
    • General log outputs
  • Eliminate JSON import assertions
  • Use this.userAgent in readmeAPIFetch calls
  • Use oclif readme to autogenerate arg docs
  • Do a pass at summary/description fields for all args

🧬 QA & Testing

npm ci && npm run build
bin/run.js

i think this is causing clashes with oclif — plus we may not need it anymore?
- recreate base command auth + flags in oclif
this is probably where should do some error handling too but not sure how yet
this was causing errors in tests, will have to tackle this a different way
this is weird (and maybe it's a vitest 1.0 thing?) but basically faketimers were causing the GHA onboarding e2e tests to fail. when reading the docs, we probably didn't need it anyways since the `vi.useFakeTimers()` call isn't required for the `vi.setSystemTime` calls to work
i think this is now taken care of with rootDir, and also it was maybe making it slightly more annoying to set import paths in vscode? plus the docs say we shouldn't use it outside of AMD module loaders

https://www.typescriptlang.org/tsconfig#baseUrl
@kanadgupta kanadgupta added the enhancement New feature or request label Jan 11, 2024
@readmeio readmeio deleted a comment from notion-workspace bot Feb 27, 2024
@kanadgupta kanadgupta mentioned this pull request May 7, 2024
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

Successfully merging this pull request may close these issues.

None yet

1 participant