diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index fecaaba0..00000000 --- a/.editorconfig +++ /dev/null @@ -1,13 +0,0 @@ -root = true - -[*] -indent_size = 2 -indent_style = space -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -[*.md] -trim_trailing_whitespace = false -indent_size = 4 diff --git a/.eslintignore b/.eslintignore deleted file mode 100644 index de4d1f00..00000000 --- a/.eslintignore +++ /dev/null @@ -1,2 +0,0 @@ -dist -node_modules diff --git a/.eslintrc b/.eslintrc deleted file mode 100644 index 4eb22f8a..00000000 --- a/.eslintrc +++ /dev/null @@ -1,25 +0,0 @@ -{ - "extends": [ - "@nuxtjs/eslint-config-typescript" - ], - "overrides": [ - { - "files": [ - "./**/*" - ], - "rules": { - "no-console": [ - "error", - { - "allow": [ - "info", - "warn", - "trace", - "error" - ] - } - ] - } - } - ] -} diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index da284b83..a5452899 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -41,10 +41,10 @@ Before posting an enchantment, please consider the following questions: - Would it require a major, minor, or patch release? - Which providers would be impacted by this change? -> [!IMPORTANT] +> [!IMPORTANT] > The more impact your Enchantment has on the package, the longer it may take to push, as we need to integrate it into our release cycle. -> [!IMPORTANT] +> [!IMPORTANT] > While we appreciate every request, we cannot accept them all. Please be understanding if we do not accept your request. ## Pull requests @@ -94,10 +94,10 @@ To start developing on this package, please follow the quick start guide below. ``` 8. [Open a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests), and fill out the provided fields. -> [!TIP] +> [!TIP] > Read more about how to use the included playground [here](../README.md#development). -> [!IMPORTANT] +> [!IMPORTANT] > By submitting a Pull request, you agree to license your work under the MIT license used by the project. ### Reviews @@ -106,7 +106,7 @@ After you submit your Pull request, a member of our core team will review it. Pl After receiving a review, please address any comments left by the reviewer or debate them if you disagree. This process will repeat until the pull request is approved and merged! -> [!NOTE] +> [!NOTE] > Besides a manual review of your pull request, we will run an automated CI pipeline on your code. ## Release cycles @@ -119,7 +119,7 @@ This package follows [Semantic Versioning 2.0.0](https://semver.org/). If we release a pre-version of a new release, we will tag it with `next` in the npmjs release and add one of the following additions to the versions: -- **ALPHA**: Early development build of a new release +- **ALPHA**: Early development build of a new release - Not properly tested yet - **RC**: Potential release candidate of a new release - Internally tested on a series of demo apps diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ef48f7e7..0fe7df89 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,7 +19,6 @@ ### 📚 Description - ### 📝 Checklist - [ ] I have linked an issue or discussion. diff --git a/.github/reproduire/needs-reproduction.md b/.github/reproduire/needs-reproduction.md index 1b794148..ad62e6b2 100644 --- a/.github/reproduire/needs-reproduction.md +++ b/.github/reproduire/needs-reproduction.md @@ -1,11 +1,11 @@ Hello 👋 -Please provide a [reproduction](https://nuxt.com/docs/community/reporting-bugs/#create-a-minimal-reproduction) for this issue 🙏 +Please provide a [reproduction](https://nuxt.com/docs/community/reporting-bugs/#create-a-minimal-reproduction) for this issue 🙏
How can I create a reproduction? -Please use one of the following links to reproduce your issue. +Please use one of the following links to reproduce your issue. - https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz - https://codesandbox.io/s/github/nuxt/starter/v3-codesandbox diff --git a/.gitignore b/.gitignore index 8f2c2e60..5c7da7fc 100644 --- a/.gitignore +++ b/.gitignore @@ -33,9 +33,6 @@ coverage *.lcov .nyc_output -# VSCode -.vscode - # Intellij idea *.iml .idea diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000..3ebdb7f7 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,7 @@ +{ + "recommendations": [ + "editorconfig.editorconfig", + "dbaeumer.vscode-eslint", + "vue.volar" + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..16b9f08f --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,73 @@ +{ + // Disable the default formatter, use eslint instead + "prettier.enable": false, + "editor.formatOnSave": false, + + // Auto fix + "editor.codeActionsOnSave": { + "source.fixAll.eslint": "explicit", + "source.organizeImports": "never" + }, + + // Silent the stylistic rules in you IDE, but still auto fix them + "eslint.rules.customizations": [ + { + "rule": "style/*", + "severity": "off" + }, + { + "rule": "format/*", + "severity": "off" + }, + { + "rule": "*-indent", + "severity": "off" + }, + { + "rule": "*-spacing", + "severity": "off" + }, + { + "rule": "*-spaces", + "severity": "off" + }, + { + "rule": "*-order", + "severity": "off" + }, + { + "rule": "*-dangle", + "severity": "off" + }, + { + "rule": "*-newline", + "severity": "off" + }, + { + "rule": "*quotes", + "severity": "off" + }, + { + "rule": "*semi", + "severity": "off" + } + ], + + // Enable eslint for all supported languages + "eslint.validate": [ + "javascript", + "javascriptreact", + "typescript", + "typescriptreact", + "vue", + "html", + "markdown", + "json", + "jsonc", + "yaml", + "toml", + "gql", + "graphql" + ], + "typescript.tsdk": "node_modules/typescript/lib" +} diff --git a/README.md b/README.md index 3355e9ef..76ca6b74 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ npx nuxi@latest module add sidebase-auth
Or install manually - + #### 1. Install the package as a dev dependency ```sh @@ -53,7 +53,7 @@ npx nuxi@latest module add sidebase-auth ```ts export default defineNuxtConfig({ - modules: ['@sidebase/nuxt-auth'] + modules: ['@sidebase/nuxt-auth'] }) ```
@@ -80,7 +80,7 @@ You can find a full list of our features, as well as which provider supports eac - Methods to `getSession`, `getCsrfToken`, `getProviders`, `signIn` and `signOut` - Full TypeScript support for all methods and properties -### Application protection +### Application protection - Application-side middleware protection for the [full application](https://auth.sidebase.io/guide/application-side/protecting-pages#global-middleware) or [specific pages](https://auth.sidebase.io/guide/application-side/protecting-pages#local-middleware) - Server-side [middleware](https://auth.sidebase.io/guide/authjs/server-side/session-access#server-middleware) and [endpoint protection](https://auth.sidebase.io/guide/authjs/server-side/session-access#endpoint-protection) @@ -162,10 +162,10 @@ To test static Nuxt 3 apps we want to run a static frontend and a separate backe pnpm dev - # A second Nuxt app should now be running on http://localhost:3001. + # A second Nuxt app should now be running on http://localhost:3001. # We use this purely for authentication ``` -4. Visit [http://localhost:3000](http://localhost:3000) -> this should open the static application. Performing any auth-related actions, the app should send requests to the backend running on port `3001` +4. Visit [http://localhost:3000](http://localhost:3000) -> this should open the static application. Performing any auth-related actions, the app should send requests to the backend running on port `3001` ## Contributing diff --git a/docs/.vitepress/theme/components/Banner.vue b/docs/.vitepress/theme/components/Banner.vue index f05e310a..f710d151 100644 --- a/docs/.vitepress/theme/components/Banner.vue +++ b/docs/.vitepress/theme/components/Banner.vue @@ -1,10 +1,10 @@