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

Infrastructure(tooling): Improve project structure #6888

Open
evenstensberg opened this issue Aug 4, 2023 · 14 comments
Open

Infrastructure(tooling): Improve project structure #6888

evenstensberg opened this issue Aug 4, 2023 · 14 comments
Labels
help_wanted Help the Open MCT project! source:community Community contribution or request type:enhancement

Comments

@evenstensberg
Copy link
Contributor

Is your feature request related to a problem? Please describe.
N/A

Describe the solution you'd like

It would be nice to improve the tooling in this project. For instance, implementing grammar, better linting and such like.

Describe alternatives you've considered
N/A

Additional context
N/A

@unlikelyzero unlikelyzero changed the title Infrastrucutre(tooling): Improve project structure Infrastructure(tooling): Improve project structure Aug 4, 2023
@unlikelyzero unlikelyzero added help_wanted Help the Open MCT project! source:community Community contribution or request labels Aug 4, 2023
@unlikelyzero
Copy link
Collaborator

@evenstensberg Can you write a small list of testing instructions so that we can test that this works on Master?

@evenstensberg
Copy link
Contributor Author

For cspell? If so:

  1. Remove one of the word strings in .cspell.json
  2. Run ´npm run lint:spelling` (Should output errors where given word is used
  3. Repeat for wrong words

You can customize which files you want spell to audit, its a simple glob and declared in the script in package.json.

If you want to tweak the cspell config -> https://github.com/streetsidesoftware/cspell/blob/main/examples/cspell.json

Eventually I'd abstract the dict of words into its own package -> http://cspell.org/docs/dictionaries/

@unlikelyzero
Copy link
Collaborator

@evenstensberg this is great! Do you have an example of another repo that is using this at a similar scale of users so we can check their set up?

@evenstensberg
Copy link
Contributor Author

Not at the moment, but we’re using it at webpack

@evenstensberg
Copy link
Contributor Author

@unlikelyzero @ozyx I've sent a couple of PRs. Let me know they need any revision. Also, I saw @ozyx submitting a PR on Vue3 migration (eslint). I have a repo that uses Vue 3 with a custom webpack build, if you are interested in seeing how that will look.

@ozyx
Copy link
Member

ozyx commented Aug 15, 2023

@unlikelyzero @ozyx I've sent a couple of PRs. Let me know they need any revision. Also, I saw @ozyx submitting a PR on Vue3 migration (eslint). I have a repo that uses Vue 3 with a custom webpack build, if you are interested in seeing how that will look.

Hi @evenstensberg!

Awesome, we will definitely take a look at your Vue 3 repo (could you provide the link?). We have recently completed the upgrade to the Vue 3 migration build and are planning to take the full step to Vue 3 proper soon.

BTW, could you please create separate issues for these features and update the PRs? Reason being that we need time to review the requests and see if they're something we are interested in, or even permitted to, implement into the Open MCT project. Please include details and specifics as to what would be implemented, its stated goal, any caveats, etc. We want to make sure that your valuable time is spent in the most effective way possible, and not on something that potentially cannot be merged due to various reasons.

That being said, we really appreciate all of your hard work towards improving Open MCT! Please be patient with us as it will take some time for us to review, in addition to our ongoing development work. Please let us know if you have any questions.

Cheers!

@evenstensberg
Copy link
Contributor Author

Awesome, we will definitely take a look at your Vue 3 repo (could you provide the link?). We have recently completed the upgrade to the Vue 3 migration build and are planning to take the full step to Vue 3 proper soon.

Here's the link to the repo

BTW, could you please create separate issues for these features and update the PRs? Reason being that we need time to review the requests and see if they're something we are interested in, or even permitted to, implement into the Open MCT project. Please include details and specifics as to what would be implemented, its stated goal, any caveats, etc. We want to make sure that your valuable time is spent in the most effective way possible, and not on something that potentially cannot be merged due to various reasons.

I'll create issues for the PR's when I'm available, with explanation of why they're needed and how to utilize given functionality. Maybe this will make it easier for you to get approval to use the code.

We want to make sure that your valuable time is spent in the most effective way possible, and not on something that potentially cannot be merged due to various reasons.

That being said, we really appreciate all of your hard work towards improving Open MCT! Please be patient with us as it will take some time for us to review, in addition to our ongoing development work. Please let us know if you have any questions.

Good thing! If it's not much of a hazzle, I'd appreciate some nasa stickers for my mac 😆

@unlikelyzero
Copy link
Collaborator

unlikelyzero commented Aug 16, 2023

@evenstensberg at the same, we could use some help getting some of our companion repos into shape. If you have some cycles, could you make some webpack improvements to this repo?

unlikelyzero/openmct-as-a-dependency#1

@evenstensberg
Copy link
Contributor Author

evenstensberg commented Aug 16, 2023

@unlikelyzero Sure, I'll have a look. I guess also openmct-yams could have some further refurbishment. Here's my priorities:

  1. Split PR's referenced in openmct into new issues referencing the PR's
  2. Openmct as a dependency
  3. Openmct-yamcs
  4. A proper production build for openmct

Sounds good?

@evenstensberg
Copy link
Contributor Author

@unlikelyzero what node version are you using locally? I'll base my PR's on that version

@unlikelyzero
Copy link
Collaborator

@evenstensberg most of our projects use 18LTS right now

@evenstensberg
Copy link
Contributor Author

@unlikelyzero do you use Slack/Discord where we can talk more concurrently, or is the only alternative GitHub?

In slack you can invite external people without letting them into the org itself

@unlikelyzero
Copy link
Collaborator

@evenstensberg unfortunately, we're forced to communicate asynchronously through GitHub

@evenstensberg
Copy link
Contributor Author

@unlikelyzero no problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help_wanted Help the Open MCT project! source:community Community contribution or request type:enhancement
Projects
None yet
Development

No branches or pull requests

3 participants