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

chore: Use Nuxt3 offical starter instead of sidebase/merino #36

Merged
merged 45 commits into from
Apr 18, 2024

Conversation

zoey-kaiser
Copy link
Member

@zoey-kaiser zoey-kaiser commented Mar 29, 2024

This PR:

  • Removes the dependency on https://github.com/sidebase/merino to bootstrap the project template
  • Switches over to getting the official https://github.com/nuxt/starter to create the base project
    • This will keep create-sidebase up to date on Nuxt versions
    • Issue: Nuxt may update this template and break some of the packages we use. We may have to lock which version is pulled to ensure we can test the updates before it gets released!
      • We may switch back to using https://sidebase/merino, but without making any changes to it. Then we can always merge into our branch to keep it up to date with the official starter!
  • Added antfu ESLint config and oxlint as the provided default linters
  • Reorganized steps to create template
    • Makes adding files and packages more generic and less bound to the modules
  • Make this project itself use antfu eslint and swich from npm to pnpm

Checklist:

  • issue number linked above after pound (#)
    • replace "Closes " with "Contributes to" or other if this PR does not close the issue
  • manually checked my feature / checking not applicable
  • wrote tests / testing not applicable
  • attached screenshots / screenshot not applicable

@zoey-kaiser zoey-kaiser marked this pull request as ready for review March 30, 2024 18:52
@@ -10,36 +10,73 @@ jobs:
testCodebase:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
Copy link
Collaborator

Choose a reason for hiding this comment

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

I recommend you to add CI environment variable. It's an unspoken convention which some libraries use to optimize their build process for CI runs

Copy link
Member Author

Choose a reason for hiding this comment

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

Let's tackle this in another PR sometime later 😊

},

// Silent the stylistic rules in you IDE, but still auto fix them
"eslint.rules.customizations": [
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a reason for that?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes there is! This is because our eslint config handles stylistics adjustments (such as indents). Changing this setting in the vscode settings, ensures that the style preferences set by eslint are used and not those that the editor has defined through extensions such as prettier.

This settings and the extention files are the default provided bu antfu when he explains how to setup his linter.

src/configs/prisma.ts Show resolved Hide resolved
command: 'nuxt typecheck'
}, {
name: 'start',
command: 'NODE_ENV=production node .output/server/index.mjs'
Copy link
Collaborator

Choose a reason for hiding this comment

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

why is this command in the typescript config?

Copy link
Member Author

@zoey-kaiser zoey-kaiser Apr 18, 2024

Choose a reason for hiding this comment

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

Generally speaking it does not 100% relate to this, however as the project uses typescript by default, I added this here, to avoid having to create another config, just for this command.

src/generators/generateIndexVue.ts Outdated Show resolved Hide resolved
src/index.ts Show resolved Hide resolved
@zoey-kaiser zoey-kaiser merged commit a438c1a into main Apr 18, 2024
2 checks passed
@zoey-kaiser zoey-kaiser deleted the build-from-nuxt-starter branch April 18, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants