eruptionjs / core Goto Github PK

from release v1.7: apply optimizations for assets compression (brotli, gzip)

case: https://github.com/trivago/prettier-plugin-sort-imports

we're already using this at our work, but is something that can add really, really great at eruptionjs

to further ref of my personal annotations atm:

~ upgrade npm packages

npm outdated ❌
npm update ❌

npm install -g npm-check-updates ✅
ncu --upgrade ❌

npm install -g npm-check-updates
ncu ❌
ncu --upgrade ❌
ncu --interactive --format group ✅

from release v1.7: implement strict typescript lint and check with tsc itself

The goal with the docs is to show with great detail, how the boilerplate works. Experienced users generally does not need, but less experienced devs might get confused, specially the way to commit, test and build with.

In a production point of view, I think that we can improve DX providing default pipelines for the boilerplate, my initial idea is providing github actions workflows that test and build the app, and in near future with the project's CLI done, maybe we can add base pipelines for another products like GitlabCI, Jenkins and etc....

If this issue fits the project purpose and roadmap, I'm open to discuss more about the feature and help to implement it.

from release v1.7: implement qr-code to open application on mobile and facilitate dev testing for responsives

from release v1.7: check msw workflow with vitest/testing-lib

context: when we first implemented msw, we saw an opportunity to make back/front contract model and test scenarios better with msw, but we didn't quite had a hand to implement on real life environment at work (it happens, unfortunatelly). So now, we need to revisit it and see if it still makes sense of it. They've release a v2 of msw, and we didn't even had a chance to see those changes and see how our worflow would benefit from that.

so that's the room to improve.

from release v1.7: apply optimizations for other assets like images and fonts (specially fonts injected by third parties)

Since my next project is going on with Astro, I want to create a standard approach to work with Astro, but in a way that is oppionionated with React and MDX, while also bringing the core Eruption features to it.

Hi, actually disable-react-devtools is a dev dependency and is not being used

on scripts at package.lock, change: lint-css to stylelint and add stylelint:fix

Hi. Need to make optional the folder .vscode for not vscode projects

Add the eslint plugin eslint-plugin-jsx-a11y to the core project boilerplate, with the desired configuration. The objective is to adopt a11y as a standard with the help of this plugin.

Set the config on .vscode settings folder

"typescript.updateImportsOnFileMove.enabled": "always",
"typescript.preferences.importModuleSpecifier": "no

Ref:

n-relative",

Eruption is great as it is, but isn't in the best shape as it should from a point of view of a powerful boilerplate: one that gives the developer the power of choice, to select what tools it will have in it.

At this moment, we "throw" some best practices like husky, eslint, prettier, stylelint and, maybe, they want to opt out some of them. Or maybe they want to opt in storybook with material, or an opinionated state solution, like redux or recoil.

Would be great if Eruption was able to provide that DX, but we're far from that. So any help that could point us on that direction, is welcome.

At this moment, the only solution is to create other versions of it, with more opinionated configs, but this isn't still the best DX that we can achieve, but we will get there.

Self explanatory. As I discussed with @raisiqueira, Eruption will adopt a domain that will link to the official docs of the project (docs that will be done later on).

We discussed the possibility of using the .dev, .com and .org as the top level domain (TLD), but no commits were made on the matter.

Donations are welcome to help buy the domain.

from v1.7 release: improve eslint rules by visiting each rule and each plugin and enforce them in a friendly way

context: stylelint-config-prettier is deprecated since the version 15 of stylelint.

Currently, the MSW is only listed as a dev dependency of the project.

Suggestion: Implement the basic MSW setup in a ViteJS project.

for ref: see eslint-plugin-import for TS only.

from release v1.7: check if css modules will work in chunks/modules as desired

context: since we're cooking a heavily opinionated version of eruption to be served with the cli at install, we need to make sure that our bundling model of the lib version, would "simply work as desired" on the core "using the lib".

it's more specific and maybe makes sense when you look to something like new mantine v7, but it's the way we want to address it, so it need to be checked.

create a new typescriptreact code snippet to facilitate the write of a functional component, something like

export const Component: FC = () => {
//
}

export default Component

also, update all the current snippets to be accessed with abbreviations like

abbreviation: uef
meaning: use effect function (in order to remember)
the output: const [foo, setFoo] = useState();