Skip to content

Conversation

@ericapisani
Copy link
Contributor

@ericapisani ericapisani commented Dec 19, 2022

🎉 Thanks for submitting a pull request! 🎉

Summary

Fixes https://github.com/netlify/pod-ecosystem-frameworks/issues/330

Related issue: https://github.com/netlify/pillar-workflow/issues/1011

We want to eventually merge the functionality within framework-info into build-info since there's a great deal of overlap and having these 2 distinct projects is leading to a high maintenance burden.

This is the first step in this process, which will lead to https://github.com/netlify/framework-info/ being archived.


For us to review and ship your PR efficiently, please perform the following steps:

  • Open a bug/issue before writing your code 🧑‍💻. This ensures
    we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or
    something that`s on fire 🔥 (e.g. incident related), you can skip this step.
  • Read the contribution guidelines 📖. This ensures your code follows our style guide and
    passes our tests.
  • Update or add tests (if any source code was changed or added) 🧪
  • Update or add documentation (if features were changed or added) 📝
  • Make sure the status checks below are successful ✅

A picture of a cute animal (not mandatory, but encouraged)

@github-actions
Copy link
Contributor

This pull request adds or modifies JavaScript (.js, .cjs, .mjs) files.
Consider converting them to TypeScript.

Copy link
Contributor

@lukasholzer lukasholzer left a comment

Choose a reason for hiding this comment

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

Can you add the same typescript config as for the other libraries that allows js files as well and adapt the files to the dist folders?

Comment on lines 1 to 4
[![npm version](https://img.shields.io/npm/v/@netlify/framework-info.svg)](https://npmjs.org/package/@netlify/framework-info)
[![Coverage Status](https://codecov.io/gh/netlify/framework-info/branch/main/graph/badge.svg)](https://codecov.io/gh/netlify/framework-info)
[![Build](https://github.com/netlify/framework-info/workflows/Build/badge.svg)](https://github.com/netlify/framework-info/actions)
[![Downloads](https://img.shields.io/npm/dm/@netlify/framework-info.svg)](https://www.npmjs.com/package/@netlify/framework-info)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think they need to be updated

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Would you be open to having these just removed outright? Personally I'm not sure how useful they are as statuses here

Copy link
Contributor

Choose a reason for hiding this comment

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

let's remove them :)

needed to add 'root' key in order to support invoking the build command from the repository root
@ericapisani
Copy link
Contributor Author

ericapisani commented Dec 20, 2022

@lukasholzer

Can you add the same typescript config as for the other libraries that allows js files as well and adapt the files to the dist folders?

At the moment we can't as there are no Typescript files in the package, and if we attempt to add the configuration files now we'll get an error about there being no input files 😞

I'd suggest doing this as a follow up pull request where we convert 1 file to Typescript (even if it's not fully typed) and add the configuration in as part of that

(( edit: Ignore the above, it turned out that if I added .js files as part of the include property it removes the error ))

@ericapisani ericapisani marked this pull request as ready for review December 21, 2022 18:01
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"noEmit": true /* Specify an output folder for all emitted files. */
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Vite handles transpilation of TS files by default so this is left to allow for type checking prior to building with vite

jobala
jobala previously approved these changes Jan 4, 2023
@ericapisani ericapisani dismissed lukasholzer’s stale review January 4, 2023 13:10

Addressed comments and got another code review confirming the changes are good

danez
danez previously requested changes Jan 4, 2023
Copy link
Contributor

@danez danez left a comment

Choose a reason for hiding this comment

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

@danez
Copy link
Contributor

danez commented Jan 5, 2023

I think refactor: will not trigger a release-please release, so it should be feat: or fix: when merging, if you want a release

@ericapisani ericapisani changed the title refactor: move framework-info into build packages feat: move framework-info into build packages Jan 5, 2023
@ericapisani
Copy link
Contributor Author

@danez Good point, I always forget about that

@ericapisani ericapisani requested a review from danez January 6, 2023 16:34
Copy link
Contributor

@lukasholzer lukasholzer left a comment

Choose a reason for hiding this comment

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

small comments

ericapisani added a commit to netlify/framework-info that referenced this pull request Jan 9, 2023
kodiakhq bot pushed a commit to netlify/framework-info that referenced this pull request Jan 10, 2023
* docs: add deprecation notice

depends on netlify/build#4783

* style: lint
@ericapisani ericapisani merged commit d37cbc4 into main Jan 10, 2023
@ericapisani ericapisani deleted the ep/add-framework-info branch January 10, 2023 15:40
jobala pushed a commit that referenced this pull request Jan 11, 2023
Co-authored-by: Lukas Holzer <lukas.holzer@netlify.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants