Skip to content
This repository has been archived by the owner on Jan 19, 2023. It is now read-only.

Remove globby #165

Merged
merged 8 commits into from Aug 13, 2021
Merged

Remove globby #165

merged 8 commits into from Aug 13, 2021

Conversation

katjuell
Copy link
Contributor

@katjuell katjuell commented Aug 13, 2021

What should this PR do?

Part of the work on DEVED-93, this ticket (DEVED-111) removes the globby dependency in favor of using fs.

As of Next.js (9.4+), we get fs out of the box.

This PR also removes our empty guides directory, and the guides/[slug].tsx template. See the discussion below for more context on this decision.

Why are we making this change?

  • We are working on updating dependencies, and removing anything we don't need will lead to fewer dependencies and breakages on upgrade in the future.

What are the acceptance criteria?

  • App should work as expected, all files should load as expected.

How should this PR be tested?

  • Check out the branch, remove node_modules, and install dependencies with npm ci.
  • Check that files load properly and things work as expected.

Pull request process

Reviewers:

  1. Test functionality using the criteria above.
  2. Offer tips for efficiency, feedback on best practices, and possible alternative approaches and things that may not have been considered.
  3. For shorter, "quick" PRs, use your best judgement on #​2.
  4. Use a collaborative approach and provide resources and/or context where appropriate.
  5. Provide screenshots/grabs where appropriate to show findings during review.

Reviewees:

  1. Prefer incremental and appropriately-scoped changes.
  2. Leave a comment on things you want explicit feedback on.
  3. Respond clearly to comments and questions.

@netlify
Copy link

netlify bot commented Aug 13, 2021

✔️ Deploy Preview for sourcegraph-learn ready!

🔨 Explore the source changes: cd7bfe7

🔍 Inspect the deploy log: https://app.netlify.com/sites/sourcegraph-learn/deploys/6116d34645889d0008893957

😎 Browse the preview: https://deploy-preview-165--sourcegraph-learn.netlify.app

@katjuell
Copy link
Contributor Author

katjuell commented Aug 13, 2021

@ltagliaferri let me know what you think about removing guides (if we say yes, I will update the PR overview above).

My thinking here is:

  • We could add better workarounds for empty directories, but ... we probably don't want to have empty directories hanging out anyway. Like, I was on the fence about adding more logic to deal with a situation that seems aberrant.
  • It definitely seems worth it to move off of this package, since it does something that we could do with fs just as easily.
  • The important thing about adding guides was actually refactoring the methods that parse/sort/handle records, since it enables us to add those things more easily when we eventually have them. Thinking about it more, it makes less sense to me to have a guides template etc when we do not have any guides ... since we still have the refactored logic.

Let me know if that seems off base though.

@katjuell
Copy link
Contributor Author

Also, strangely, my local build was working on these commits, so three cheers for that 🤷‍♀️

@ltagliaferri
Copy link
Contributor

@ltagliaferri let me know what you think about removing guides (if we say yes, I will update the PR overview above).

My thinking here is:

* We _could_ add better workarounds for empty directories, but ... we probably don't want to have empty directories hanging out anyway. Like, I was on the fence about adding more logic to deal with a situation that seems aberrant.

* It definitely seems worth it to move off of this package, since it does something that we could do with `fs` just as easily.

* The important thing about adding guides was actually refactoring the methods that parse/sort/handle records, since it enables us to add those things more easily when we eventually have them. On thinking more about it, it makes less sense to me to have a guides template etc when we do not have any guides ... since we still have the refactored logic.

Let me know if that seems off base though.

Yes, +1 to removing guides. There is nothing there now, we don't know when / if there will be something there, everything you raise makes sense.

@katjuell
Copy link
Contributor Author

Awesome, thank you!

Copy link
Contributor

@ltagliaferri ltagliaferri left a comment

Choose a reason for hiding this comment

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

Looks good, thank you

@ltagliaferri ltagliaferri merged commit c1ad496 into main Aug 13, 2021
@ltagliaferri ltagliaferri deleted the kjuell/DEVED-93/remove-globby branch August 13, 2021 20:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants